mContextTitle is the page that forms submit to, links point to,
* redirects go to, etc. $this->mTitle (as well as $mArticle) is the
* page in the database that is actually being edited. These are
* usually the same, but they are now allowed to be different.
*
* Surgeon General's Warning: prolonged exposure to this class is known to cause
* headaches, which may be fatal.
*
* @newable
* @note marked as newable in 1.35 for lack of a better alternative,
* but should be split up into service objects and command objects
* in the future (T157658).
*/
class EditPage implements IEditObject {
use DeprecationHelper;
use ProtectedHookAccessorTrait;
/**
* Used for Unicode support checks
*/
public const UNICODE_CHECK = 'ℳ𝒲♥𝓊𝓃𝒾𝒸ℴ𝒹ℯ';
/**
* HTML id and name for the beginning of the edit form.
*/
public const EDITFORM_ID = 'editform';
/**
* Prefix of key for cookie used to pass post-edit state.
* The revision id edited is added after this
*/
public const POST_EDIT_COOKIE_KEY_PREFIX = 'PostEditRevision';
/**
* Duration of PostEdit cookie, in seconds.
* The cookie will be removed instantly if the JavaScript runs.
*
* Otherwise, though, we don't want the cookies to accumulate.
* RFC 2109 ( https://www.ietf.org/rfc/rfc2109.txt ) specifies a possible
* limit of only 20 cookies per domain. This still applies at least to some
* versions of IE without full updates:
* https://blogs.msdn.com/b/ieinternals/archive/2009/08/20/wininet-ie-cookie-internals-faq.aspx
*
* A value of 20 minutes should be enough to take into account slow loads and minor
* clock skew while still avoiding cookie accumulation when JavaScript is turned off.
*/
public const POST_EDIT_COOKIE_DURATION = 1200;
/**
* @deprecated for public usage since 1.30 use EditPage::getArticle()
* @var Article
*/
public $mArticle;
/** @var WikiPage */
private $page;
/**
* @deprecated for public usage since 1.30 use EditPage::getTitle()
* @var Title
*/
public $mTitle;
/** @var null|Title */
private $mContextTitle = null;
/** @var string */
public $action = 'submit';
/** @var bool Whether an edit conflict needs to be resolved. Detected based on whether
* $editRevId is different than the latest revision. When a conflict has successfully
* been resolved by a 3-way-merge, this field is set to false.
*/
public $isConflict = false;
/** @var bool New page or new section */
public $isNew = false;
/**
* @var bool
* @internal
*/
public $deletedSinceEdit;
/** @var string */
public $formtype;
/** @var bool
* True the first time the edit form is rendered, false after re-rendering
* with diff, save prompts, etc.
*/
public $firsttime;
/**
* @var bool|stdClass
* @internal
*/
public $lastDelete;
/**
* @var bool
* @internal
*/
public $mTokenOk = false;
/**
* @var bool
* @internal
*/
public $mTokenOkExceptSuffix = false;
/**
* @var bool
* @internal
*/
public $mTriedSave = false;
/**
* @var bool
* @internal
*/
public $incompleteForm = false;
/**
* @var bool
* @internal
*/
public $tooBig = false;
/**
* @var bool
* @internal
*/
public $missingComment = false;
/**
* @var bool
* @internal
*/
public $missingSummary = false;
/**
* @var bool
* @internal
*/
public $allowBlankSummary = false;
/** @var bool */
protected $blankArticle = false;
/** @var bool */
protected $allowBlankArticle = false;
/** @var bool */
protected $selfRedirect = false;
/** @var bool */
protected $allowSelfRedirect = false;
/**
* @var string
* @internal
*/
public $autoSumm = '';
/** @var string */
private $hookError = '';
/**
* @var ParserOutput
* @internal
*/
public $mParserOutput;
/**
* @var bool Has a summary been preset using GET parameter &summary= ?
* @internal
*/
public $hasPresetSummary = false;
/**
* @var Revision|bool|null
*
* A revision object corresponding to $this->editRevId.
* Formerly public as part of using Revision objects
*
* @deprecated since 1.35
*/
protected $mBaseRevision = false;
/**
* @var RevisionRecord|bool|null
*
* A RevisionRecord corresponding to $this->editRevId or $this->edittime
* Replaced $mBaseRevision
*/
private $mExpectedParentRevision = false;
/** @var bool */
public $mShowSummaryField = true;
# Form values
/** @var bool */
public $save = false;
/** @var bool */
public $preview = false;
/** @var bool */
public $diff = false;
/**
* @var bool
* @internal
*/
public $minoredit = false;
/**
* @var bool
* @internal
*/
public $watchthis = false;
/** @var bool Corresponds to $wgWatchlistExpiry */
private $watchlistExpiryEnabled = false;
/** @var WatchedItemStoreInterface */
private $watchedItemStore;
/** @var string|null The expiry time of the watch item, or null if it is not watched temporarily. */
private $watchlistExpiry;
/**
* @var bool
* @internal
*/
public $recreate = false;
/** @var string
* Page content input field.
*/
public $textbox1 = '';
/** @var string */
public $textbox2 = '';
/** @var string */
public $summary = '';
/**
* @var bool
* @internal
* If true, hide the summary field.
*/
public $nosummary = false;
/** @var string
* Timestamp of the latest revision of the page when editing was initiated
* on the client.
*/
public $edittime = '';
/** @var int Revision ID of the latest revision of the page when editing
* was initiated on the client. This is used to detect and resolve edit
* conflicts.
*
* @note 0 if the page did not exist at that time.
* @note When starting an edit from an old revision, this still records the current
* revision at the time, not the one the edit is based on.
*
* @see $oldid
* @see getExpectedParentRevision()
*/
private $editRevId = null;
/** @var string */
public $section = '';
/** @var string */
public $sectiontitle = '';
/** @var string
* Timestamp from the first time the edit form was rendered.
*/
public $starttime = '';
/** @var int Revision ID the edit is based on, or 0 if it's the current revision.
* FIXME: This isn't used in conflict resolution--provide a better
* justification or merge with parentRevId.
* @see $editRevId
*/
public $oldid = 0;
/**
* @var int Revision ID the edit is based on, adjusted when an edit conflict is resolved.
* @internal
* @see $editRevId
* @see $oldid
* @see getparentRevId()
*/
public $parentRevId = 0;
/**
* @var string
* @internal
*/
public $editintro = '';
/**
* @var int|null
* @internal
*/
public $scrolltop = null;
/**
* @var bool
* @internal
*/
public $markAsBot = true;
/** @var string */
public $contentModel;
/** @var null|string */
public $contentFormat = null;
/** @var null|array */
private $changeTags = null;
# Placeholders for text injection by hooks (must be HTML)
# extensions should take care to _append_ to the present value
/** @var string Before even the preview */
public $editFormPageTop = '';
public $editFormTextTop = '';
public $editFormTextBeforeContent = '';
public $editFormTextAfterWarn = '';
public $editFormTextAfterTools = '';
public $editFormTextBottom = '';
public $editFormTextAfterContent = '';
public $previewTextAfterContent = '';
public $mPreloadContent = null;
/* $didSave should be set to true whenever an article was successfully altered. */
public $didSave = false;
public $undidRev = 0;
public $undoAfter = 0;
public $suppressIntro = false;
/** @var bool */
protected $edit;
/** @var bool|int */
protected $contentLength = false;
/**
* @var bool Set in ApiEditPage, based on ContentHandler::allowsDirectApiEditing
*/
private $enableApiEditOverride = false;
/**
* @var IContextSource
*/
protected $context;
/**
* @var bool Whether an old revision is edited
*/
private $isOldRev = false;
/**
* @var string|null What the user submitted in the 'wpUnicodeCheck' field
*/
private $unicodeCheck;
/**
* Factory function to create an edit conflict helper
*
* @var callable
*/
private $editConflictHelperFactory;
/**
* @var TextConflictHelper|null
*/
private $editConflictHelper;
/**
* @var IContentHandlerFactory
*/
private $contentHandlerFactory;
/**
* @var PermissionManager
*/
private $permManager;
/**
* @var RevisionStore
*/
private $revisionStore;
/**
* @stable to call
* @param Article $article
*/
public function __construct( Article $article ) {
$this->mArticle = $article;
$this->page = $article->getPage(); // model object
$this->mTitle = $article->getTitle();
// Make sure the local context is in sync with other member variables.
// Particularly make sure everything is using the same WikiPage instance.
// This should probably be the case in Article as well, but it's
// particularly important for EditPage, to make use of the in-place caching
// facility in WikiPage::prepareContentForEdit.
$this->context = new DerivativeContext( $article->getContext() );
$this->context->setWikiPage( $this->page );
$this->context->setTitle( $this->mTitle );
$this->contentModel = $this->mTitle->getContentModel();
$services = MediaWikiServices::getInstance();
$this->contentHandlerFactory = $services->getContentHandlerFactory();
$this->contentFormat = $this->contentHandlerFactory
->getContentHandler( $this->contentModel )
->getDefaultFormat();
$this->editConflictHelperFactory = [ $this, 'newTextConflictHelper' ];
$this->permManager = $services->getPermissionManager();
$this->revisionStore = $services->getRevisionStore();
$this->watchlistExpiryEnabled = $this->getContext()->getConfig() instanceof Config
&& $this->getContext()->getConfig()->get( 'WatchlistExpiry' );
$this->watchedItemStore = $services->getWatchedItemStore();
$this->deprecatePublicProperty( 'mBaseRevision', '1.35', __CLASS__ );
}
/**
* @return Article
*/
public function getArticle() {
return $this->mArticle;
}
/**
* @since 1.28
* @return IContextSource
*/
public function getContext() {
return $this->context;
}
/**
* @since 1.19
* @return Title
*/
public function getTitle() {
return $this->mTitle;
}
/**
* Set the context Title object
*
* @param Title|null $title Title object or null
*/
public function setContextTitle( $title ) {
$this->mContextTitle = $title;
}
/**
* Get the context title object.
*
* If not set, $wgTitle will be returned, but this is deprecated. This will
* throw an exception.
*
* @return Title
*/
public function getContextTitle() {
if ( $this->mContextTitle === null ) {
wfDeprecated( get_class( $this ) . '::getContextTitle called with no title set', '1.32' );
global $wgTitle;
return $wgTitle;
} else {
return $this->mContextTitle;
}
}
/**
* Returns if the given content model is editable.
*
* @param string $modelId The ID of the content model to test. Use CONTENT_MODEL_XXX constants.
* @return bool
* @throws MWException If $modelId has no known handler
*/
public function isSupportedContentModel( $modelId ) {
return $this->enableApiEditOverride === true ||
$this->contentHandlerFactory->getContentHandler( $modelId )->supportsDirectEditing();
}
/**
* Allow editing of content that supports API direct editing, but not general
* direct editing. Set to false by default.
*
* @param bool $enableOverride
*/
public function setApiEditOverride( $enableOverride ) {
$this->enableApiEditOverride = $enableOverride;
}
/**
* This is the function that gets called for "action=edit". It
* sets up various member variables, then passes execution to
* another function, usually showEditForm()
*
* The edit form is self-submitting, so that when things like
* preview and edit conflicts occur, we get the same form back
* with the extra stuff added. Only when the final submission
* is made and all is well do we actually save and redirect to
* the newly-edited page.
*/
public function edit() {
// Allow extensions to modify/prevent this form or submission
if ( !$this->getHookRunner()->onAlternateEdit( $this ) ) {
return;
}
wfDebug( __METHOD__ . ": enter" );
$request = $this->context->getRequest();
// If they used redlink=1 and the page exists, redirect to the main article
if ( $request->getBool( 'redlink' ) && $this->mTitle->exists() ) {
$this->context->getOutput()->redirect( $this->mTitle->getFullURL() );
return;
}
$this->importFormData( $request );
$this->firsttime = false;
if ( wfReadOnly() && $this->save ) {
// Force preview
$this->save = false;
$this->preview = true;
}
if ( $this->save ) {
$this->formtype = 'save';
} elseif ( $this->preview ) {
$this->formtype = 'preview';
} elseif ( $this->diff ) {
$this->formtype = 'diff';
} else { # First time through
$this->firsttime = true;
if ( $this->previewOnOpen() ) {
$this->formtype = 'preview';
} else {
$this->formtype = 'initial';
}
}
$permErrors = $this->getEditPermissionErrors(
$this->save ? PermissionManager::RIGOR_SECURE : PermissionManager::RIGOR_FULL
);
if ( $permErrors ) {
wfDebug( __METHOD__ . ": User can't edit" );
if ( $this->context->getUser()->getBlock() ) {
// Auto-block user's IP if the account was "hard" blocked
if ( !wfReadOnly() ) {
DeferredUpdates::addCallableUpdate( function () {
$this->context->getUser()->spreadAnyEditBlock();
} );
}
}
$this->displayPermissionsError( $permErrors );
return;
}
$revRecord = $this->mArticle->fetchRevisionRecord();
// Disallow editing revisions with content models different from the current one
// Undo edits being an exception in order to allow reverting content model changes.
$revContentModel = $revRecord ?
$revRecord->getSlot( SlotRecord::MAIN, RevisionRecord::RAW )->getModel() :
false;
if ( $revContentModel && $revContentModel !== $this->contentModel ) {
$prevRev = null;
if ( $this->undidRev ) {
$undidRevRecord = $this->revisionStore
->getRevisionById( $this->undidRev );
$prevRevRecord = $undidRevRecord ?
$this->revisionStore->getPreviousRevision( $undidRevRecord ) :
null;
$prevContentModel = $prevRevRecord ?
$prevRevRecord
->getSlot( SlotRecord::MAIN, RevisionRecord::RAW )
->getModel() :
'';
}
if ( !$this->undidRev
|| !$prevRevRecord
|| $prevContentModel !== $this->contentModel
) {
$this->displayViewSourcePage(
$this->getContentObject(),
$this->context->msg(
'contentmodelediterror',
$revContentModel,
$this->contentModel
)->plain()
);
return;
}
}
$this->isConflict = false;
# Show applicable editing introductions
if ( $this->formtype == 'initial' || $this->firsttime ) {
$this->showIntro();
}
# Attempt submission here. This will check for edit conflicts,
# and redundantly check for locked database, blocked IPs, etc.
# that edit() already checked just in case someone tries to sneak
# in the back door with a hand-edited submission URL.
if ( $this->formtype == 'save' ) {
$resultDetails = null;
$status = $this->attemptSave( $resultDetails );
if ( !$this->handleStatus( $status, $resultDetails ) ) {
return;
}
}
# First time through: get contents, set time for conflict
# checking, etc.
if ( $this->formtype == 'initial' || $this->firsttime ) {
if ( $this->initialiseForm() === false ) {
return;
}
if ( !$this->mTitle->getArticleID() ) {
$this->getHookRunner()->onEditFormPreloadText( $this->textbox1, $this->mTitle );
} else {
$this->getHookRunner()->onEditFormInitialText( $this );
}
}
$this->showEditForm();
}
/**
* @param string $rigor PermissionManager::RIGOR_ constant
* @return array
*/
protected function getEditPermissionErrors( $rigor = PermissionManager::RIGOR_SECURE ) {
$user = $this->context->getUser();
$permErrors = $this->permManager->getPermissionErrors(
'edit',
$user,
$this->mTitle,
$rigor
);
# Can this title be created?
if ( !$this->mTitle->exists() ) {
$permErrors = array_merge(
$permErrors,
wfArrayDiff2(
$this->permManager->getPermissionErrors(
'create',
$user,
$this->mTitle,
$rigor
),
$permErrors
)
);
}
# Ignore some permissions errors when a user is just previewing/viewing diffs
$remove = [];
foreach ( $permErrors as $error ) {
if ( ( $this->preview || $this->diff )
&& (
$error[0] == 'blockedtext' ||
$error[0] == 'autoblockedtext' ||
$error[0] == 'systemblockedtext'
)
) {
$remove[] = $error;
}
}
$permErrors = wfArrayDiff2( $permErrors, $remove );
return $permErrors;
}
/**
* Display a permissions error page, like OutputPage::showPermissionsErrorPage(),
* but with the following differences:
* - If redlink=1, the user will be redirected to the page
* - If there is content to display or the error occurs while either saving,
* previewing or showing the difference, it will be a
* "View source for ..." page displaying the source code after the error message.
*
* @since 1.19
* @param array $permErrors Array of permissions errors
* @throws PermissionsError
*/
protected function displayPermissionsError( array $permErrors ) {
$out = $this->context->getOutput();
if ( $this->context->getRequest()->getBool( 'redlink' ) ) {
// The edit page was reached via a red link.
// Redirect to the article page and let them click the edit tab if
// they really want a permission error.
$out->redirect( $this->mTitle->getFullURL() );
return;
}
$content = $this->getContentObject();
# Use the normal message if there's nothing to display
if ( $this->firsttime && ( !$content || $content->isEmpty() ) ) {
$action = $this->mTitle->exists() ? 'edit' :
( $this->mTitle->isTalkPage() ? 'createtalk' : 'createpage' );
throw new PermissionsError( $action, $permErrors );
}
$this->displayViewSourcePage(
$content,
$out->formatPermissionsErrorMessage( $permErrors, 'edit' )
);
}
/**
* Display a read-only View Source page
* @param Content $content
* @param string $errorMessage additional wikitext error message to display
*/
protected function displayViewSourcePage( Content $content, $errorMessage = '' ) {
$out = $this->context->getOutput();
$this->getHookRunner()->onEditPage__showReadOnlyForm_initial( $this, $out );
$out->setRobotPolicy( 'noindex,nofollow' );
$out->setPageTitle( $this->context->msg(
'viewsource-title',
$this->getContextTitle()->getPrefixedText()
) );
$out->addBacklinkSubtitle( $this->getContextTitle() );
$out->addHTML( $this->editFormPageTop );
$out->addHTML( $this->editFormTextTop );
if ( $errorMessage !== '' ) {
$out->addWikiTextAsInterface( $errorMessage );
$out->addHTML( "\n" );
}
# If the user made changes, preserve them when showing the markup
# (This happens when a user is blocked during edit, for instance)
if ( !$this->firsttime ) {
$text = $this->textbox1;
$out->addWikiMsg( 'viewyourtext' );
} else {
try {
$text = $this->toEditText( $content );
} catch ( MWException $e ) {
# Serialize using the default format if the content model is not supported
# (e.g. for an old revision with a different model)
$text = $content->serialize();
}
$out->addWikiMsg( 'viewsourcetext' );
}
$out->addHTML( $this->editFormTextBeforeContent );
$this->showTextbox( $text, 'wpTextbox1', [ 'readonly' ] );
$out->addHTML( $this->editFormTextAfterContent );
$out->addHTML( $this->makeTemplatesOnThisPageList( $this->getTemplates() ) );
$out->addModules( 'mediawiki.action.edit.collapsibleFooter' );
$out->addHTML( $this->editFormTextBottom );
if ( $this->mTitle->exists() ) {
$out->returnToMain( null, $this->mTitle );
}
}
/**
* Should we show a preview when the edit form is first shown?
*
* @return bool
*/
protected function previewOnOpen() {
$config = $this->context->getConfig();
$previewOnOpenNamespaces = $config->get( 'PreviewOnOpenNamespaces' );
$request = $this->context->getRequest();
if ( $config->get( 'RawHtml' ) ) {
// If raw HTML is enabled, disable preview on open
// since it has to be posted with a token for
// security reasons
return false;
}
if ( $request->getVal( 'preview' ) == 'yes' ) {
// Explicit override from request
return true;
} elseif ( $request->getVal( 'preview' ) == 'no' ) {
// Explicit override from request
return false;
} elseif ( $this->section == 'new' ) {
// Nothing *to* preview for new sections
return false;
} elseif ( ( $request->getCheck( 'preload' ) || $this->mTitle->exists() )
&& $this->context->getUser()->getOption( 'previewonfirst' )
) {
// Standard preference behavior
return true;
} elseif ( !$this->mTitle->exists()
&& isset( $previewOnOpenNamespaces[$this->mTitle->getNamespace()] )
&& $previewOnOpenNamespaces[$this->mTitle->getNamespace()]
) {
// Categories are special
return true;
} else {
return false;
}
}
/**
* Checks whether the user entered a skin name in uppercase,
* e.g. "User:Example/Monobook.css" instead of "monobook.css"
*
* @return bool
*/
protected function isWrongCaseUserConfigPage() {
if ( $this->mTitle->isUserConfigPage() ) {
$name = $this->mTitle->getSkinFromConfigSubpage();
$skins = array_merge(
array_keys( Skin::getSkinNames() ),
[ 'common' ]
);
return !in_array( $name, $skins )
&& in_array( strtolower( $name ), $skins );
} else {
return false;
}
}
/**
* Returns whether section editing is supported for the current page.
* Subclasses may override this to replace the default behavior, which is
* to check ContentHandler::supportsSections.
*
* @return bool True if this edit page supports sections, false otherwise.
*/
protected function isSectionEditSupported() {
return $this->contentHandlerFactory
->getContentHandler( $this->mTitle->getContentModel() )
->supportsSections();
}
/**
* This function collects the form data and uses it to populate various member variables.
* @param WebRequest &$request
* @throws ErrorPageError
*/
public function importFormData( &$request ) {
# Section edit can come from either the form or a link
$this->section = $request->getVal( 'wpSection', $request->getVal( 'section' ) );
if ( $this->section !== null && $this->section !== '' && !$this->isSectionEditSupported() ) {
throw new ErrorPageError( 'sectioneditnotsupported-title', 'sectioneditnotsupported-text' );
}
$this->isNew = !$this->mTitle->exists() || $this->section == 'new';
if ( $request->wasPosted() ) {
# These fields need to be checked for encoding.
# Also remove trailing whitespace, but don't remove _initial_
# whitespace from the text boxes. This may be significant formatting.
$this->textbox1 = rtrim( $request->getText( 'wpTextbox1' ) );
if ( !$request->getCheck( 'wpTextbox2' ) ) {
// Skip this if wpTextbox2 has input, it indicates that we came
// from a conflict page with raw page text, not a custom form
// modified by subclasses
$textbox1 = $this->importContentFormData( $request );
if ( $textbox1 !== null ) {
$this->textbox1 = $textbox1;
}
}
$this->unicodeCheck = $request->getText( 'wpUnicodeCheck' );
$this->summary = $request->getText( 'wpSummary' );
# If the summary consists of a heading, e.g. '==Foobar==', extract the title from the
# header syntax, e.g. 'Foobar'. This is mainly an issue when we are using wpSummary for
# section titles.
$this->summary = preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->summary );
# Treat sectiontitle the same way as summary.
# Note that wpSectionTitle is not yet a part of the actual edit form, as wpSummary is
# currently doing double duty as both edit summary and section title. Right now this
# is just to allow API edits to work around this limitation, but this should be
# incorporated into the actual edit form when EditPage is rewritten (T20654, T28312).
$this->sectiontitle = $request->getText( 'wpSectionTitle' );
$this->sectiontitle = preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->sectiontitle );
$this->edittime = $request->getVal( 'wpEdittime' );
$this->editRevId = $request->getIntOrNull( 'editRevId' );
$this->starttime = $request->getVal( 'wpStarttime' );
$undidRev = $request->getInt( 'wpUndidRevision' );
if ( $undidRev ) {
$this->undidRev = $undidRev;
}
$undoAfter = $request->getInt( 'wpUndoAfter' );
if ( $undoAfter ) {
$this->undoAfter = $undoAfter;
}
$this->scrolltop = $request->getIntOrNull( 'wpScrolltop' );
if ( $this->textbox1 === '' && !$request->getCheck( 'wpTextbox1' ) ) {
// wpTextbox1 field is missing, possibly due to being "too big"
// according to some filter rules such as Suhosin's setting for
// suhosin.request.max_value_length (d'oh)
$this->incompleteForm = true;
} else {
// If we receive the last parameter of the request, we can fairly
// claim the POST request has not been truncated.
$this->incompleteForm = !$request->getVal( 'wpUltimateParam' );
}
if ( $this->incompleteForm ) {
# If the form is incomplete, force to preview.
wfDebug( __METHOD__ . ": Form data appears to be incomplete" );
wfDebug( "POST DATA: " . var_export( $request->getPostValues(), true ) );
$this->preview = true;
} else {
$this->preview = $request->getCheck( 'wpPreview' );
$this->diff = $request->getCheck( 'wpDiff' );
// Remember whether a save was requested, so we can indicate
// if we forced preview due to session failure.
$this->mTriedSave = !$this->preview;
if ( $this->tokenOk( $request ) ) {
# Some browsers will not report any submit button
# if the user hits enter in the comment box.
# The unmarked state will be assumed to be a save,
# if the form seems otherwise complete.
wfDebug( __METHOD__ . ": Passed token check." );
} elseif ( $this->diff ) {
# Failed token check, but only requested "Show Changes".
wfDebug( __METHOD__ . ": Failed token check; Show Changes requested." );
} else {
# Page might be a hack attempt posted from
# an external site. Preview instead of saving.
wfDebug( __METHOD__ . ": Failed token check; forcing preview" );
$this->preview = true;
}
}
$this->save = !$this->preview && !$this->diff;
if ( !preg_match( '/^\d{14}$/', $this->edittime ) ) {
$this->edittime = null;
}
if ( !preg_match( '/^\d{14}$/', $this->starttime ) ) {
$this->starttime = null;
}
$this->recreate = $request->getCheck( 'wpRecreate' );
$user = $this->getContext()->getUser();
$this->minoredit = $request->getCheck( 'wpMinoredit' );
$this->watchthis = $request->getCheck( 'wpWatchthis' );
if ( $this->watchlistExpiryEnabled ) {
// This parsing of the user-posted expiry is done for both preview and saving. This
// is necessary because ApiEditPage uses preview when it saves (yuck!). Note that it
// only works because the unnormalized value is retrieved again below in
// getCheckboxesDefinitionForWatchlist().
$expiry = ExpiryDef::normalizeExpiry( $request->getText( 'wpWatchlistExpiry' ) );
if ( $expiry !== false ) {
$this->watchlistExpiry = $expiry;
}
}
# Don't force edit summaries when a user is editing their own user or talk page
if ( ( $this->mTitle->mNamespace == NS_USER || $this->mTitle->mNamespace == NS_USER_TALK )
&& $this->mTitle->getText() == $user->getName()
) {
$this->allowBlankSummary = true;
} else {
$this->allowBlankSummary = $request->getBool( 'wpIgnoreBlankSummary' )
|| !$user->getOption( 'forceeditsummary' );
}
$this->autoSumm = $request->getText( 'wpAutoSummary' );
$this->allowBlankArticle = $request->getBool( 'wpIgnoreBlankArticle' );
$this->allowSelfRedirect = $request->getBool( 'wpIgnoreSelfRedirect' );
$changeTags = $request->getVal( 'wpChangeTags' );
if ( $changeTags === null || $changeTags === '' ) {
$this->changeTags = [];
} else {
$this->changeTags = array_filter( array_map( 'trim', explode( ',',
$changeTags ) ) );
}
} else {
# Not a posted form? Start with nothing.
wfDebug( __METHOD__ . ": Not a posted form." );
$this->textbox1 = '';
$this->summary = '';
$this->sectiontitle = '';
$this->edittime = '';
$this->editRevId = null;
$this->starttime = wfTimestampNow();
$this->edit = false;
$this->preview = false;
$this->save = false;
$this->diff = false;
$this->minoredit = false;
// Watch may be overridden by request parameters
$this->watchthis = $request->getBool( 'watchthis', false );
if ( $this->watchlistExpiryEnabled ) {
$this->watchlistExpiry = null;
}
$this->recreate = false;
// When creating a new section, we can preload a section title by passing it as the
// preloadtitle parameter in the URL (T15100)
if ( $this->section == 'new' && $request->getVal( 'preloadtitle' ) ) {
$this->sectiontitle = $request->getVal( 'preloadtitle' );
// Once wpSummary isn't being use for setting section titles, we should delete this.
$this->summary = $request->getVal( 'preloadtitle' );
} elseif ( $this->section != 'new' && $request->getVal( 'summary' ) !== '' ) {
$this->summary = $request->getText( 'summary' );
if ( $this->summary !== '' ) {
$this->hasPresetSummary = true;
}
}
if ( $request->getVal( 'minor' ) ) {
$this->minoredit = true;
}
}
$this->oldid = $request->getInt( 'oldid' );
$this->parentRevId = $request->getInt( 'parentRevId' );
$this->markAsBot = $request->getBool( 'bot', true );
$this->nosummary = $request->getBool( 'nosummary' );
// May be overridden by revision.
$this->contentModel = $request->getText( 'model', $this->contentModel );
// May be overridden by revision.
$this->contentFormat = $request->getText( 'format', $this->contentFormat );
try {
$handler = $this->contentHandlerFactory->getContentHandler( $this->contentModel );
} catch ( MWUnknownContentModelException $e ) {
throw new ErrorPageError(
'editpage-invalidcontentmodel-title',
'editpage-invalidcontentmodel-text',
[ wfEscapeWikiText( $this->contentModel ) ]
);
}
if ( !$handler->isSupportedFormat( $this->contentFormat ) ) {
throw new ErrorPageError(
'editpage-notsupportedcontentformat-title',
'editpage-notsupportedcontentformat-text',
[
wfEscapeWikiText( $this->contentFormat ),
wfEscapeWikiText( ContentHandler::getLocalizedName( $this->contentModel ) )
]
);
}
/**
* @todo Check if the desired model is allowed in this namespace, and if
* a transition from the page's current model to the new model is
* allowed.
*/
$this->editintro = $request->getText( 'editintro',
// Custom edit intro for new sections
$this->section === 'new' ? 'MediaWiki:addsection-editintro' : '' );
// Allow extensions to modify form data
$this->getHookRunner()->onEditPage__importFormData( $this, $request );
}
/**
* Subpage overridable method for extracting the page content data from the
* posted form to be placed in $this->textbox1, if using customized input
* this method should be overridden and return the page text that will be used
* for saving, preview parsing and so on...
*
* @param WebRequest &$request
* @return string|null
*/
protected function importContentFormData( &$request ) {
return null; // Don't do anything, EditPage already extracted wpTextbox1
}
/**
* Initialise form fields in the object
* Called on the first invocation, e.g. when a user clicks an edit link
* @return bool If the requested section is valid
*/
public function initialiseForm() {
$this->edittime = $this->page->getTimestamp();
$this->editRevId = $this->page->getLatest();
$dummy = $this->contentHandlerFactory
->getContentHandler( $this->contentModel )
->makeEmptyContent();
$content = $this->getContentObject( $dummy ); # TODO: track content object?!
if ( $content === $dummy ) { // Invalid section
$this->noSuchSectionPage();
return false;
}
if ( !$content ) {
$out = $this->context->getOutput();
$this->editFormPageTop .= Html::rawElement(
'div', [ 'class' => 'errorbox' ],
$out->parseAsInterface( $this->context->msg( 'missing-revision-content',
$this->oldid,
Message::plaintextParam( $this->mTitle->getPrefixedText() )
) )
);
} elseif ( !$this->isSupportedContentModel( $content->getModel() ) ) {
$modelMsg = $this->getContext()->msg( 'content-model-' . $content->getModel() );
$modelName = $modelMsg->exists() ? $modelMsg->text() : $content->getModel();
$out = $this->context->getOutput();
$out->showErrorPage(
'modeleditnotsupported-title',
'modeleditnotsupported-text',
[ $modelName ]
);
return false;
}
$this->textbox1 = $this->toEditText( $content );
$user = $this->context->getUser();
// activate checkboxes if user wants them to be always active
# Sort out the "watch" checkbox
if ( $user->getOption( 'watchdefault' ) ) {
# Watch all edits
$this->watchthis = true;
} elseif ( $user->getOption( 'watchcreations' ) && !$this->mTitle->exists() ) {
# Watch creations
$this->watchthis = true;
} elseif ( $user->isWatched( $this->mTitle ) ) {
# Already watched
$this->watchthis = true;
}
if ( $this->watchthis && $this->watchlistExpiryEnabled ) {
$watchedItem = $this->watchedItemStore->getWatchedItem( $user, $this->getTitle() );
$this->watchlistExpiry = $watchedItem ? $watchedItem->getExpiry() : null;
}
if ( $user->getOption( 'minordefault' ) && !$this->isNew ) {
$this->minoredit = true;
}
if ( $this->textbox1 === false ) {
return false;
}
return true;
}
/**
* @param Content|null $def_content The default value to return
*
* @return Content|false|null Content on success, $def_content for invalid sections
*
* @since 1.21
*/
protected function getContentObject( $def_content = null ) {
global $wgDisableAnonTalk;
$content = false;
$user = $this->context->getUser();
$request = $this->context->getRequest();
// For message page not locally set, use the i18n message.
// For other non-existent articles, use preload text if any.
if ( !$this->mTitle->exists() || $this->section == 'new' ) {
if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI && $this->section != 'new' ) {
# If this is a system message, get the default text.
$msg = $this->mTitle->getDefaultMessageText();
$content = $this->toEditContent( $msg );
}
if ( $content === false ) {
# If requested, preload some text.
$preload = $request->getVal( 'preload',
// Custom preload text for new sections
$this->section === 'new' ? 'MediaWiki:addsection-preload' : '' );
$params = $request->getArray( 'preloadparams', [] );
$content = $this->getPreloadedContent( $preload, $params );
}
// For existing pages, get text based on "undo" or section parameters.
} elseif ( $this->section != '' ) {
// Get section edit text (returns $def_text for invalid sections)
$orig = $this->getOriginalContent( $user );
$content = $orig ? $orig->getSection( $this->section ) : null;
if ( !$content ) {
$content = $def_content;
}
} else {
$undoafter = $request->getInt( 'undoafter' );
$undo = $request->getInt( 'undo' );
if ( $undo > 0 && $undoafter > 0 ) {
$undorev = $this->revisionStore->getRevisionById( $undo );
$oldrev = $this->revisionStore->getRevisionById( $undoafter );
$undoMsg = null;
# Sanity check, make sure it's the right page,
# the revisions exist and they were not deleted.
# Otherwise, $content will be left as-is.
if ( $undorev !== null && $oldrev !== null &&
!$undorev->isDeleted( RevisionRecord::DELETED_TEXT ) &&
!$oldrev->isDeleted( RevisionRecord::DELETED_TEXT )
) {
if ( WikiPage::hasDifferencesOutsideMainSlot( $undorev, $oldrev )
|| !$this->isSupportedContentModel(
$oldrev->getSlot( SlotRecord::MAIN, RevisionRecord::RAW )->getModel()
)
) {
// Hack for undo while EditPage can't handle multi-slot editing
$this->context->getOutput()->redirect( $this->mTitle->getFullURL( [
'action' => 'mcrundo',
'undo' => $undo,
'undoafter' => $undoafter,
] ) );
return false;
} else {
$handler = $this->contentHandlerFactory
->getContentHandler( $undorev->getSlot(
SlotRecord::MAIN,
RevisionRecord::RAW
)->getModel() );
$currentContent = $this->page->getRevisionRecord()
->getContent( SlotRecord::MAIN );
$undoContent = $undorev->getContent( SlotRecord::MAIN );
$undoAfterContent = $oldrev->getContent( SlotRecord::MAIN );
$undoIsLatest = $this->page->getRevisionRecord()->getId() === $undorev->getId();
$content = $handler->getUndoContent(
$currentContent,
$undoContent,
$undoAfterContent,
$undoIsLatest
);
if ( $content === false ) {
# Warn the user that something went wrong
$undoMsg = 'failure';
}
}
if ( $undoMsg === null ) {
$oldContent = $this->page->getContent( RevisionRecord::RAW );
$popts = ParserOptions::newFromUserAndLang(
$user, MediaWikiServices::getInstance()->getContentLanguage() );
$newContent = $content->preSaveTransform( $this->mTitle, $user, $popts );
if ( $newContent->getModel() !== $oldContent->getModel() ) {
// The undo may change content
// model if its reverting the top
// edit. This can result in
// mismatched content model/format.
$this->contentModel = $newContent->getModel();
$oldMainSlot = $oldrev->getSlot(
SlotRecord::MAIN,
RevisionRecord::RAW
);
$this->contentFormat = $oldMainSlot->getFormat();
if ( $this->contentFormat === null ) {
$this->contentFormat = $this->contentHandlerFactory
->getContentHandler( $oldMainSlot->getModel() )
->getDefaultFormat();
}
}
if ( $newContent->equals( $oldContent ) ) {
# Tell the user that the undo results in no change,
# i.e. the revisions were already undone.
$undoMsg = 'nochange';
$content = false;
} else {
# Inform the user of our success and set an automatic edit summary
$undoMsg = 'success';
# If we just undid one rev, use an autosummary
$firstrev = $this->revisionStore->getNextRevision( $oldrev );
if ( $firstrev && $firstrev->getId() == $undo ) {
$userText = $undorev->getUser() ?
$undorev->getUser()->getName() :
'';
if ( $userText === '' ) {
$undoSummary = $this->context->msg(
'undo-summary-username-hidden',
$undo
)->inContentLanguage()->text();
// Handle external users (imported revisions)
} elseif ( ExternalUserNames::isExternal( $userText ) ) {
$userLinkTitle = ExternalUserNames::getUserLinkTitle( $userText );
if ( $userLinkTitle ) {
$userLink = $userLinkTitle->getPrefixedText();
$undoSummary = $this->context->msg(
'undo-summary-import',
$undo,
$userLink,
$userText
)->inContentLanguage()->text();
} else {
$undoSummary = $this->context->msg(
'undo-summary-import2',
$undo,
$userText
)->inContentLanguage()->text();
}
} else {
$undoIsAnon = $undorev->getUser() ?
!$undorev->getUser()->isRegistered() :
true;
$undoMessage = ( $undoIsAnon && $wgDisableAnonTalk ) ?
'undo-summary-anon' :
'undo-summary';
$undoSummary = $this->context->msg(
$undoMessage,
$undo,
$userText
)->inContentLanguage()->text();
}
if ( $this->summary === '' ) {
$this->summary = $undoSummary;
} else {
$this->summary = $undoSummary . $this->context->msg( 'colon-separator' )
->inContentLanguage()->text() . $this->summary;
}
}
$this->undidRev = $undo;
$this->undoAfter = $undoafter;
$this->formtype = 'diff';
}
}
} else {
// Failed basic sanity checks.
// Older revisions may have been removed since the link
// was created, or we may simply have got bogus input.
$undoMsg = 'norev';
}
$out = $this->context->getOutput();
// Messages: undo-success, undo-failure, undo-main-slot-only, undo-norev,
// undo-nochange.
$class = ( $undoMsg == 'success' ? '' : 'error ' ) . "mw-undo-{$undoMsg}";
$this->editFormPageTop .= Html::rawElement(
'div', [ 'class' => $class ],
$out->parseAsInterface(
$this->context->msg( 'undo-' . $undoMsg )->plain()
)
);
}
if ( $content === false ) {
// Hack for restoring old revisions while EditPage
// can't handle multi-slot editing.
$curRevisionRecord = $this->page->getRevisionRecord();
$oldRevisionRecord = $this->mArticle->fetchRevisionRecord();
if ( $curRevisionRecord
&& $oldRevisionRecord
&& $curRevisionRecord->getId() !== $oldRevisionRecord->getId()
&& ( WikiPage::hasDifferencesOutsideMainSlot(
$oldRevisionRecord,
$curRevisionRecord
) || !$this->isSupportedContentModel(
$oldRevisionRecord->getSlot(
SlotRecord::MAIN,
RevisionRecord::RAW
)->getModel()
) )
) {
$this->context->getOutput()->redirect(
$this->mTitle->getFullURL(
[
'action' => 'mcrrestore',
'restore' => $oldRevisionRecord->getId(),
]
)
);
return false;
}
}
if ( $content === false ) {
$content = $this->getOriginalContent( $user );
}
}
return $content;
}
/**
* Get the content of the wanted revision, without section extraction.
*
* The result of this function can be used to compare user's input with
* section replaced in its context (using WikiPage::replaceSectionAtRev())
* to the original text of the edit.
*
* This differs from Article::getContent() that when a missing revision is
* encountered the result will be null and not the
* 'missing-revision' message.
*
* @since 1.19
* @param User $user The user to get the revision for
* @return Content|null
*/
private function getOriginalContent( User $user ) {
if ( $this->section == 'new' ) {
return $this->getCurrentContent();
}
$revRecord = $this->mArticle->fetchRevisionRecord();
if ( $revRecord === null ) {
return $this->contentHandlerFactory
->getContentHandler( $this->contentModel )
->makeEmptyContent();
}
return $revRecord->getContent( SlotRecord::MAIN, RevisionRecord::FOR_THIS_USER, $user );
}
/**
* Get the edit's parent revision ID
*
* The "parent" revision is the ancestor that should be recorded in this
* page's revision history. It is either the revision ID of the in-memory
* article content, or in the case of a 3-way merge in order to rebase
* across a recoverable edit conflict, the ID of the newer revision to
* which we have rebased this page.
*
* @since 1.27
* @return int Revision ID
*/
public function getParentRevId() {
if ( $this->parentRevId ) {
return $this->parentRevId;
} else {
return $this->mArticle->getRevIdFetched();
}
}
/**
* Get the current content of the page. This is basically similar to
* WikiPage::getContent( RevisionRecord::RAW ) except that when the page doesn't
* exist an empty content object is returned instead of null.
*
* @since 1.21
* @return Content
*/
protected function getCurrentContent() {
$revRecord = $this->page->getRevisionRecord();
$content = $revRecord ? $revRecord->getContent(
SlotRecord::MAIN,
RevisionRecord::RAW
) : null;
if ( $content === false || $content === null ) {
return $this->contentHandlerFactory
->getContentHandler( $this->contentModel )
->makeEmptyContent();
} elseif ( !$this->undidRev ) {
$mainSlot = $revRecord->getSlot( SlotRecord::MAIN, RevisionRecord::RAW );
// Content models should always be the same since we error
// out if they are different before this point (in ->edit()).
// The exception being, during an undo, the current revision might
// differ from the prior revision.
$logger = LoggerFactory::getInstance( 'editpage' );
if ( $this->contentModel !== $mainSlot->getModel() ) {
$logger->warning( "Overriding content model from current edit {prev} to {new}", [
'prev' => $this->contentModel,
'new' => $mainSlot->getModel(),
'title' => $this->getTitle()->getPrefixedDBkey(),
'method' => __METHOD__
] );
$this->contentModel = $mainSlot->getModel();
}
// Given that the content models should match, the current selected
// format should be supported.
if ( !$content->isSupportedFormat( $this->contentFormat ) ) {
$revFormat = $mainSlot->getFormat();
if ( $revFormat === null ) {
$revFormat = $this->contentHandlerFactory
->getContentHandler( $mainSlot->getModel() )
->getDefaultFormat();
}
$logger->warning( "Current revision content format unsupported. Overriding {prev} to {new}", [
'prev' => $this->contentFormat,
'new' => $revFormat,
'title' => $this->getTitle()->getPrefixedDBkey(),
'method' => __METHOD__
] );
$this->contentFormat = $revFormat;
}
}
return $content;
}
/**
* Use this method before edit() to preload some content into the edit box
*
* @param Content $content
*
* @since 1.21
*/
public function setPreloadedContent( Content $content ) {
$this->mPreloadContent = $content;
}
/**
* Get the contents to be preloaded into the box, either set by
* an earlier setPreloadText() or by loading the given page.
*
* @param string $preload Representing the title to preload from.
* @param array $params Parameters to use (interface-message style) in the preloaded text
*
* @return Content
*
* @since 1.21
*/
protected function getPreloadedContent( $preload, $params = [] ) {
if ( !empty( $this->mPreloadContent ) ) {
return $this->mPreloadContent;
}
$handler = $this->contentHandlerFactory->getContentHandler( $this->contentModel );
if ( $preload === '' ) {
return $handler->makeEmptyContent();
}
$user = $this->context->getUser();
$title = Title::newFromText( $preload );
# Check for existence to avoid getting MediaWiki:Noarticletext
if ( !$this->isPageExistingAndViewable( $title, $user ) ) {
// TODO: somehow show a warning to the user!
return $handler->makeEmptyContent();
}
$page = WikiPage::factory( $title );
if ( $page->isRedirect() ) {
$title = $page->getRedirectTarget();
# Same as before
if ( !$this->isPageExistingAndViewable( $title, $user ) ) {
// TODO: somehow show a warning to the user!
return $handler->makeEmptyContent();
}
$page = WikiPage::factory( $title );
}
$parserOptions = ParserOptions::newFromUser( $user );
$content = $page->getContent( RevisionRecord::RAW );
if ( !$content ) {
// TODO: somehow show a warning to the user!
return $handler->makeEmptyContent();
}
if ( $content->getModel() !== $handler->getModelID() ) {
$converted = $content->convert( $handler->getModelID() );
if ( !$converted ) {
// TODO: somehow show a warning to the user!
wfDebug( "Attempt to preload incompatible content: " .
"can't convert " . $content->getModel() .
" to " . $handler->getModelID() );
return $handler->makeEmptyContent();
}
$content = $converted;
}
return $content->preloadTransform( $title, $parserOptions, $params );
}
/**
* Verify if a given title exists and the given user is allowed to view it
*
* @see EditPage::getPreloadedContent()
* @param Title|null $title
* @param User $user
* @return bool
* @throws Exception
*/
private function isPageExistingAndViewable( $title, User $user ) {
return $title && $title->exists() && $this->permManager->userCan( 'read', $user, $title );
}
/**
* Make sure the form isn't faking a user's credentials.
*
* @param WebRequest &$request
* @return bool
* @internal
*/
public function tokenOk( &$request ) {
$token = $request->getVal( 'wpEditToken' );
$user = $this->context->getUser();
$this->mTokenOk = $user->matchEditToken( $token );
$this->mTokenOkExceptSuffix = $user->matchEditTokenNoSuffix( $token );
return $this->mTokenOk;
}
/**
* Sets post-edit cookie indicating the user just saved a particular revision.
*
* This uses a temporary cookie for each revision ID so separate saves will never
* interfere with each other.
*
* Article::view deletes the cookie on server-side after the redirect and
* converts the value to the global JavaScript variable wgPostEdit.
*
* If the variable were set on the server, it would be cached, which is unwanted
* since the post-edit state should only apply to the load right after the save.
*
* @param int $statusValue The status value (to check for new article status)
*/
protected function setPostEditCookie( $statusValue ) {
$revisionId = $this->page->getLatest();
$postEditKey = self::POST_EDIT_COOKIE_KEY_PREFIX . $revisionId;
$val = 'saved';
if ( $statusValue == self::AS_SUCCESS_NEW_ARTICLE ) {
$val = 'created';
} elseif ( $this->oldid ) {
$val = 'restored';
}
$response = $this->context->getRequest()->response();
$response->setCookie( $postEditKey, $val, time() + self::POST_EDIT_COOKIE_DURATION );
}
/**
* Attempt submission
* @param array|bool &$resultDetails See docs for $result in internalAttemptSave
* @throws UserBlockedError|ReadOnlyError|ThrottledError|PermissionsError
* @return Status The resulting status object.
*/
public function attemptSave( &$resultDetails = false ) {
// TODO: MCR:
// * treat $this->minoredit like $this->markAsBot and check isAllowed( 'minoredit' )!
// * add $this->autopatrol like $this->markAsBot and check isAllowed( 'autopatrol' )!
// This is needed since PageUpdater no longer checks these rights!
// Allow bots to exempt some edits from bot flagging
$markAsBot = $this->markAsBot
&& $this->permManager->userHasRight( $this->context->getUser(), 'bot' );
$status = $this->internalAttemptSave( $resultDetails, $markAsBot );
$this->getHookRunner()->onEditPage__attemptSave_after( $this, $status, $resultDetails );
return $status;
}
/**
* Log when a page was successfully saved after the edit conflict view
*/
private function incrementResolvedConflicts() {
if ( $this->context->getRequest()->getText( 'mode' ) !== 'conflict' ) {
return;
}
$this->getEditConflictHelper()->incrementResolvedStats( $this->context->getUser() );
}
/**
* Handle status, such as after attempt save
*
* @param Status $status
* @param array|bool $resultDetails
*
* @throws ErrorPageError
* @return bool False, if output is done, true if rest of the form should be displayed
*/
private function handleStatus( Status $status, $resultDetails ) {
/**
* @todo FIXME: once the interface for internalAttemptSave() is made
* nicer, this should use the message in $status
*/
if ( $status->value == self::AS_SUCCESS_UPDATE
|| $status->value == self::AS_SUCCESS_NEW_ARTICLE
) {
$this->incrementResolvedConflicts();
$this->didSave = true;
if ( !$resultDetails['nullEdit'] ) {
$this->setPostEditCookie( $status->value );
}
}
$out = $this->context->getOutput();
// "wpExtraQueryRedirect" is a hidden input to modify
// after save URL and is not used by actual edit form
$request = $this->context->getRequest();
$extraQueryRedirect = $request->getVal( 'wpExtraQueryRedirect' );
switch ( $status->value ) {
case self::AS_HOOK_ERROR_EXPECTED:
case self::AS_CONTENT_TOO_BIG:
case self::AS_ARTICLE_WAS_DELETED:
case self::AS_CONFLICT_DETECTED:
case self::AS_SUMMARY_NEEDED:
case self::AS_TEXTBOX_EMPTY:
case self::AS_MAX_ARTICLE_SIZE_EXCEEDED:
case self::AS_END:
case self::AS_BLANK_ARTICLE:
case self::AS_SELF_REDIRECT:
return true;
case self::AS_HOOK_ERROR:
return false;
case self::AS_CANNOT_USE_CUSTOM_MODEL:
wfDeprecated(
__METHOD__ . ' with $status->value == AS_CANNOT_USE_CUSTOM_MODEL',
'1.35'
);
// ...and fall through to next case
case self::AS_PARSE_ERROR:
case self::AS_UNICODE_NOT_SUPPORTED:
$out->wrapWikiTextAsInterface( 'error',
$status->getWikiText( false, false, $this->context->getLanguage() )
);
return true;
case self::AS_SUCCESS_NEW_ARTICLE:
$query = $resultDetails['redirect'] ? 'redirect=no' : '';
if ( $extraQueryRedirect ) {
if ( $query !== '' ) {
$query .= '&';
}
$query .= $extraQueryRedirect;
}
$anchor = $resultDetails['sectionanchor'] ?? '';
$out->redirect( $this->mTitle->getFullURL( $query ) . $anchor );
return false;
case self::AS_SUCCESS_UPDATE:
$extraQuery = '';
$sectionanchor = $resultDetails['sectionanchor'];
// Give extensions a chance to modify URL query on update
$this->getHookRunner()->onArticleUpdateBeforeRedirect( $this->mArticle,
$sectionanchor, $extraQuery );
if ( $resultDetails['redirect'] ) {
if ( $extraQuery !== '' ) {
$extraQuery = '&' . $extraQuery;
}
$extraQuery = 'redirect=no' . $extraQuery;
}
if ( $extraQueryRedirect ) {
if ( $extraQuery !== '' ) {
$extraQuery .= '&';
}
$extraQuery .= $extraQueryRedirect;
}
$out->redirect( $this->mTitle->getFullURL( $extraQuery ) . $sectionanchor );
return false;
case self::AS_SPAM_ERROR:
$this->spamPageWithContent( $resultDetails['spam'] ?? false );
return false;
case self::AS_BLOCKED_PAGE_FOR_USER:
throw new UserBlockedError(
$this->context->getUser()->getBlock(),
$this->context->getUser(),
$this->context->getLanguage(),
$request->getIP()
);
case self::AS_IMAGE_REDIRECT_ANON:
case self::AS_IMAGE_REDIRECT_LOGGED:
throw new PermissionsError( 'upload' );
case self::AS_READ_ONLY_PAGE_ANON:
case self::AS_READ_ONLY_PAGE_LOGGED:
throw new PermissionsError( 'edit' );
case self::AS_READ_ONLY_PAGE:
throw new ReadOnlyError;
case self::AS_RATE_LIMITED:
throw new ThrottledError();
case self::AS_NO_CREATE_PERMISSION:
$permission = $this->mTitle->isTalkPage() ? 'createtalk' : 'createpage';
throw new PermissionsError( $permission );
case self::AS_NO_CHANGE_CONTENT_MODEL:
throw new PermissionsError( 'editcontentmodel' );
default:
// We don't recognize $status->value. The only way that can happen
// is if an extension hook aborted from inside ArticleSave.
// Render the status object into $this->hookError
// FIXME this sucks, we should just use the Status object throughout
$this->hookError = '
';
return true;
}
}
/**
* Run hooks that can filter edits just before they get saved.
*
* @param Content $content The Content to filter.
* @param Status $status For reporting the outcome to the caller
* @param User $user The user performing the edit
*
* @return bool
*/
protected function runPostMergeFilters( Content $content, Status $status, User $user ) {
// Run old style post-section-merge edit filter
if ( $this->hookError != '' ) {
# ...or the hook could be expecting us to produce an error
$status->fatal( 'hookaborted' );
$status->value = self::AS_HOOK_ERROR_EXPECTED;
return false;
}
// Run new style post-section-merge edit filter
if ( !$this->getHookRunner()->onEditFilterMergedContent( $this->context, $content,
$status, $this->summary, $user, $this->minoredit )
) {
# Error messages etc. could be handled within the hook...
if ( $status->isGood() ) {
$status->fatal( 'hookaborted' );
// Not setting $this->hookError here is a hack to allow the hook
// to cause a return to the edit page without $this->hookError
// being set. This is used by ConfirmEdit to display a captcha
// without any error message cruft.
} else {
$this->hookError = $this->formatStatusErrors( $status );
}
// Use the existing $status->value if the hook set it
if ( !$status->value ) {
$status->value = self::AS_HOOK_ERROR;
}
return false;
} elseif ( !$status->isOK() ) {
# ...or the hook could be expecting us to produce an error
// FIXME this sucks, we should just use the Status object throughout
if ( !$status->getErrors() ) {
// Provide a fallback error message if none was set
$status->fatal( 'hookaborted' );
}
$this->hookError = $this->formatStatusErrors( $status );
$status->value = self::AS_HOOK_ERROR_EXPECTED;
return false;
}
return true;
}
/**
* Wrap status errors in an errorbox for increased visibility
*
* @param Status $status
* @return string Wikitext
*/
private function formatStatusErrors( Status $status ) {
$errmsg = $status->getWikiText(
'edit-error-short',
'edit-error-long',
$this->context->getLanguage()
);
return <<
{$errmsg}
ERROR;
}
/**
* Return the summary to be used for a new section.
*
* @param string|null &$sectionanchor Set to the section anchor text
* @return string
*/
private function newSectionSummary( &$sectionanchor = null ) {
if ( $this->sectiontitle !== '' ) {
$sectionanchor = $this->guessSectionName( $this->sectiontitle );
// If no edit summary was specified, create one automatically from the section
// title and have it link to the new section. Otherwise, respect the summary as
// passed.
if ( $this->summary === '' ) {
$cleanSectionTitle = MediaWikiServices::getInstance()->getParser()
->stripSectionName( $this->sectiontitle );
return $this->context->msg( 'newsectionsummary' )
->plaintextParams( $cleanSectionTitle )->inContentLanguage()->text();
}
} elseif ( $this->summary !== '' ) {
$sectionanchor = $this->guessSectionName( $this->summary );
# This is a new section, so create a link to the new section
# in the revision summary.
$cleanSummary = MediaWikiServices::getInstance()->getParser()
->stripSectionName( $this->summary );
return $this->context->msg( 'newsectionsummary' )
->plaintextParams( $cleanSummary )->inContentLanguage()->text();
}
return $this->summary;
}
/**
* Attempt submission (no UI)
*
* @param array &$result Array to add statuses to, currently with the
* possible keys:
* - spam (string): Spam string from content if any spam is detected by
* matchSpamRegex.
* - sectionanchor (string): Section anchor for a section save.
* - nullEdit (bool): Set if doEditContent is OK. True if null edit,
* false otherwise.
* - redirect (bool): Set if doEditContent is OK. True if resulting
* revision is a redirect.
* @param bool $markAsBot True if edit is being made under the bot right
* and the bot wishes the edit to be marked as such.
*
* @return Status Status object, possibly with a message, but always with
* one of the AS_* constants in $status->value,
*
* @todo FIXME: This interface is TERRIBLE, but hard to get rid of due to
* various error display idiosyncrasies. There are also lots of cases
* where error metadata is set in the object and retrieved later instead
* of being returned, e.g. AS_CONTENT_TOO_BIG and
* AS_BLOCKED_PAGE_FOR_USER. All that stuff needs to be cleaned up some
* time.
*/
public function internalAttemptSave( &$result, $markAsBot = false ) {
$status = Status::newGood();
$user = $this->context->getUser();
if ( !$this->getHookRunner()->onEditPage__attemptSave( $this ) ) {
wfDebug( "Hook 'EditPage::attemptSave' aborted article saving" );
$status->fatal( 'hookaborted' );
$status->value = self::AS_HOOK_ERROR;
return $status;
}
if ( $this->unicodeCheck !== self::UNICODE_CHECK ) {
$status->fatal( 'unicode-support-fail' );
$status->value = self::AS_UNICODE_NOT_SUPPORTED;
return $status;
}
$request = $this->context->getRequest();
$spam = $request->getText( 'wpAntispam' );
if ( $spam !== '' ) {
wfDebugLog(
'SimpleAntiSpam',
$user->getName() .
' editing "' .
$this->mTitle->getPrefixedText() .
'" submitted bogus field "' .
$spam .
'"'
);
$status->fatal( 'spamprotectionmatch', false );
$status->value = self::AS_SPAM_ERROR;
return $status;
}
try {
# Construct Content object
$textbox_content = $this->toEditContent( $this->textbox1 );
} catch ( MWContentSerializationException $ex ) {
$status->fatal(
'content-failed-to-parse',
$this->contentModel,
$this->contentFormat,
$ex->getMessage()
);
$status->value = self::AS_PARSE_ERROR;
return $status;
}
# Check image redirect
if ( $this->mTitle->getNamespace() == NS_FILE &&
$textbox_content->isRedirect() &&
!$this->permManager->userHasRight( $user, 'upload' )
) {
$code = $user->isAnon() ? self::AS_IMAGE_REDIRECT_ANON : self::AS_IMAGE_REDIRECT_LOGGED;
$status->setResult( false, $code );
return $status;
}
# Check for spam
$spamRegexChecker = MediaWikiServices::getInstance()->getSpamChecker();
$match = $spamRegexChecker->checkSummary( $this->summary );
if ( $match === false && $this->section == 'new' ) {
# $wgSpamRegex is enforced on this new heading/summary because, unlike
# regular summaries, it is added to the actual wikitext.
if ( $this->sectiontitle !== '' ) {
# This branch is taken when the API is used with the 'sectiontitle' parameter.
$match = $spamRegexChecker->checkContent( $this->sectiontitle );
} else {
# This branch is taken when the "Add Topic" user interface is used, or the API
# is used with the 'summary' parameter.
$match = $spamRegexChecker->checkContent( $this->summary );
}
}
if ( $match === false ) {
$match = $spamRegexChecker->checkContent( $this->textbox1 );
}
if ( $match !== false ) {
$result['spam'] = $match;
$ip = $request->getIP();
$pdbk = $this->mTitle->getPrefixedDBkey();
$match = str_replace( "\n", '', $match );
wfDebugLog( 'SpamRegex', "$ip spam regex hit [[$pdbk]]: \"$match\"" );
$status->fatal( 'spamprotectionmatch', $match );
$status->value = self::AS_SPAM_ERROR;
return $status;
}
if ( !$this->getHookRunner()->onEditFilter( $this, $this->textbox1, $this->section,
$this->hookError, $this->summary )
) {
# Error messages etc. could be handled within the hook...
$status->fatal( 'hookaborted' );
$status->value = self::AS_HOOK_ERROR;
return $status;
} elseif ( $this->hookError != '' ) {
# ...or the hook could be expecting us to produce an error
$status->fatal( 'hookaborted' );
$status->value = self::AS_HOOK_ERROR_EXPECTED;
return $status;
}
if ( $this->permManager->isBlockedFrom( $user, $this->mTitle ) ) {
// Auto-block user's IP if the account was "hard" blocked
if ( !wfReadOnly() ) {
$user->spreadAnyEditBlock();
}
# Check block state against master, thus 'false'.
$status->setResult( false, self::AS_BLOCKED_PAGE_FOR_USER );
return $status;
}
$this->contentLength = strlen( $this->textbox1 );
$config = $this->context->getConfig();
$maxArticleSize = $config->get( 'MaxArticleSize' );
if ( $this->contentLength > $maxArticleSize * 1024 ) {
// Error will be displayed by showEditForm()
$this->tooBig = true;
$status->setResult( false, self::AS_CONTENT_TOO_BIG );
return $status;
}
if ( !$this->permManager->userHasRight( $user, 'edit' ) ) {
if ( $user->isAnon() ) {
$status->setResult( false, self::AS_READ_ONLY_PAGE_ANON );
return $status;
} else {
$status->fatal( 'readonlytext' );
$status->value = self::AS_READ_ONLY_PAGE_LOGGED;
return $status;
}
}
$changingContentModel = false;
if ( $this->contentModel !== $this->mTitle->getContentModel() ) {
if ( !$this->permManager->userHasRight( $user, 'editcontentmodel' ) ) {
$status->setResult( false, self::AS_NO_CHANGE_CONTENT_MODEL );
return $status;
}
// Make sure the user can edit the page under the new content model too
$titleWithNewContentModel = clone $this->mTitle;
$titleWithNewContentModel->setContentModel( $this->contentModel );
$canEditModel = $this->permManager->userCan(
'editcontentmodel',
$user,
$titleWithNewContentModel
);
if (
!$canEditModel
|| !$this->permManager->userCan( 'edit', $user, $titleWithNewContentModel )
) {
$status->setResult( false, self::AS_NO_CHANGE_CONTENT_MODEL );
return $status;
}
$changingContentModel = true;
$oldContentModel = $this->mTitle->getContentModel();
}
if ( $this->changeTags ) {
$changeTagsStatus = ChangeTags::canAddTagsAccompanyingChange(
$this->changeTags, $user );
if ( !$changeTagsStatus->isOK() ) {
$changeTagsStatus->value = self::AS_CHANGE_TAG_ERROR;
return $changeTagsStatus;
}
}
if ( wfReadOnly() ) {
$status->fatal( 'readonlytext' );
$status->value = self::AS_READ_ONLY_PAGE;
return $status;
}
if ( $user->pingLimiter() || $user->pingLimiter( 'linkpurge', 0 )
|| ( $changingContentModel && $user->pingLimiter( 'editcontentmodel' ) )
) {
$status->fatal( 'actionthrottledtext' );
$status->value = self::AS_RATE_LIMITED;
return $status;
}
# If the article has been deleted while editing, don't save it without
# confirmation
if ( $this->wasDeletedSinceLastEdit() && !$this->recreate ) {
$status->setResult( false, self::AS_ARTICLE_WAS_DELETED );
return $status;
}
# Load the page data from the master. If anything changes in the meantime,
# we detect it by using page_latest like a token in a 1 try compare-and-swap.
$this->page->loadPageData( 'fromdbmaster' );
$new = !$this->page->exists();
if ( $new ) {
// Late check for create permission, just in case *PARANOIA*
if ( !$this->permManager->userCan( 'create', $user, $this->mTitle ) ) {
$status->fatal( 'nocreatetext' );
$status->value = self::AS_NO_CREATE_PERMISSION;
wfDebug( __METHOD__ . ": no create permission" );
return $status;
}
// Don't save a new page if it's blank or if it's a MediaWiki:
// message with content equivalent to default (allow empty pages
// in this case to disable messages, see T52124)
$defaultMessageText = $this->mTitle->getDefaultMessageText();
if ( $this->mTitle->getNamespace() === NS_MEDIAWIKI && $defaultMessageText !== false ) {
$defaultText = $defaultMessageText;
} else {
$defaultText = '';
}
if ( !$this->allowBlankArticle && $this->textbox1 === $defaultText ) {
$this->blankArticle = true;
$status->fatal( 'blankarticle' );
$status->setResult( false, self::AS_BLANK_ARTICLE );
return $status;
}
if ( !$this->runPostMergeFilters( $textbox_content, $status, $user ) ) {
return $status;
}
$content = $textbox_content;
$result['sectionanchor'] = '';
if ( $this->section == 'new' ) {
// @phan-suppress-next-line PhanSuspiciousValueComparison
if ( $this->sectiontitle !== '' ) {
// Insert the section title above the content.
$content = $content->addSectionHeader( $this->sectiontitle );
} elseif ( $this->summary !== '' ) {
// Insert the section title above the content.
$content = $content->addSectionHeader( $this->summary );
}
$this->summary = $this->newSectionSummary( $result['sectionanchor'] );
}
$status->value = self::AS_SUCCESS_NEW_ARTICLE;
} else { # not $new
# Article exists. Check for edit conflict.
$this->page->clear(); # Force reload of dates, etc.
$timestamp = $this->page->getTimestamp();
$latest = $this->page->getLatest();
wfDebug( "timestamp: {$timestamp}, edittime: {$this->edittime}" );
wfDebug( "revision: {$latest}, editRevId: {$this->editRevId}" );
// An edit conflict is detected if the current revision is different from the
// revision that was current when editing was initiated on the client.
// This is checked based on the timestamp and revision ID.
// TODO: the timestamp based check can probably go away now.
if ( ( $this->edittime !== null && $this->edittime != $timestamp )
|| ( $this->editRevId !== null && $this->editRevId != $latest )
) {
$this->isConflict = true;
if ( $this->section == 'new' ) {
if ( $this->page->getUserText() == $user->getName() &&
$this->page->getComment() == $this->newSectionSummary()
) {
// Probably a duplicate submission of a new comment.
// This can happen when CDN resends a request after
// a timeout but the first one actually went through.
wfDebug( __METHOD__
. ": duplicate new section submission; trigger edit conflict!" );
} else {
// New comment; suppress conflict.
$this->isConflict = false;
wfDebug( __METHOD__ . ": conflict suppressed; new section" );
}
} elseif ( $this->section == ''
&& $this->edittime
&& $this->revisionStore->userWasLastToEdit(
wfGetDB( DB_MASTER ),
$this->mTitle->getArticleID(),
$user->getId(),
$this->edittime
)
) {
# Suppress edit conflict with self, except for section edits where merging is required.
wfDebug( __METHOD__ . ": Suppressing edit conflict, same user." );
$this->isConflict = false;
}
}
// If sectiontitle is set, use it, otherwise use the summary as the section title.
// @phan-suppress-next-line PhanSuspiciousValueComparison
if ( $this->sectiontitle !== '' ) {
$sectionTitle = $this->sectiontitle;
} else {
$sectionTitle = $this->summary;
}
$content = null;
if ( $this->isConflict ) {
wfDebug( __METHOD__
. ": conflict! getting section '{$this->section}' for time '{$this->edittime}'"
. " (id '{$this->editRevId}') (article time '{$timestamp}')" );
// @TODO: replaceSectionAtRev() with base ID (not prior current) for ?oldid=X case
// ...or disable section editing for non-current revisions (not exposed anyway).
if ( $this->editRevId !== null ) {
$content = $this->page->replaceSectionAtRev(
$this->section,
$textbox_content,
$sectionTitle,
$this->editRevId
);
} else {
$content = $this->page->replaceSectionContent(
$this->section,
$textbox_content,
$sectionTitle,
$this->edittime
);
}
} else {
wfDebug( __METHOD__ . ": getting section '{$this->section}'" );
$content = $this->page->replaceSectionContent(
$this->section,
$textbox_content,
$sectionTitle
);
}
if ( $content === null ) {
wfDebug( __METHOD__ . ": activating conflict; section replace failed." );
$this->isConflict = true;
$content = $textbox_content; // do not try to merge here!
} elseif ( $this->isConflict ) {
# Attempt merge
if ( $this->mergeChangesIntoContent( $content ) ) {
// Successful merge! Maybe we should tell the user the good news?
$this->isConflict = false;
wfDebug( __METHOD__ . ": Suppressing edit conflict, successful merge." );
} else {
$this->section = '';
$this->textbox1 = ContentHandler::getContentText( $content );
wfDebug( __METHOD__ . ": Keeping edit conflict, failed merge." );
}
}
if ( $this->isConflict ) {
$status->setResult( false, self::AS_CONFLICT_DETECTED );
return $status;
}
if ( !$this->runPostMergeFilters( $content, $status, $user ) ) {
return $status;
}
if ( $this->section == 'new' ) {
// Handle the user preference to force summaries here
if ( !$this->allowBlankSummary && trim( $this->summary ) == '' ) {
$this->missingSummary = true;
$status->fatal( 'missingsummary' ); // or 'missingcommentheader' if $section == 'new'. Blegh
$status->value = self::AS_SUMMARY_NEEDED;
return $status;
}
// Do not allow the user to post an empty comment
if ( $this->textbox1 == '' ) {
$this->missingComment = true;
$status->fatal( 'missingcommenttext' );
$status->value = self::AS_TEXTBOX_EMPTY;
return $status;
}
} elseif ( !$this->allowBlankSummary
&& !$content->equals( $this->getOriginalContent( $user ) )
&& !$content->isRedirect()
&& md5( $this->summary ) == $this->autoSumm
) {
$this->missingSummary = true;
$status->fatal( 'missingsummary' );
$status->value = self::AS_SUMMARY_NEEDED;
return $status;
}
# All's well
$sectionanchor = '';
if ( $this->section == 'new' ) {
$this->summary = $this->newSectionSummary( $sectionanchor );
} elseif ( $this->section != '' ) {
# Try to get a section anchor from the section source, redirect
# to edited section if header found.
# XXX: Might be better to integrate this into Article::replaceSectionAtRev
# for duplicate heading checking and maybe parsing.
$hasmatch = preg_match( "/^ *([=]{1,6})(.*?)(\\1) *\\n/i", $this->textbox1, $matches );
# We can't deal with anchors, includes, html etc in the header for now,
# headline would need to be parsed to improve this.
if ( $hasmatch && strlen( $matches[2] ) > 0 ) {
$sectionanchor = $this->guessSectionName( $matches[2] );
}
}
$result['sectionanchor'] = $sectionanchor;
// Save errors may fall down to the edit form, but we've now
// merged the section into full text. Clear the section field
// so that later submission of conflict forms won't try to
// replace that into a duplicated mess.
$this->textbox1 = $this->toEditText( $content );
$this->section = '';
$status->value = self::AS_SUCCESS_UPDATE;
}
if ( !$this->allowSelfRedirect
&& $content->isRedirect()
&& $content->getRedirectTarget()->equals( $this->getTitle() )
) {
// If the page already redirects to itself, don't warn.
$currentTarget = $this->getCurrentContent()->getRedirectTarget();
if ( !$currentTarget || !$currentTarget->equals( $this->getTitle() ) ) {
$this->selfRedirect = true;
$status->fatal( 'selfredirect' );
$status->value = self::AS_SELF_REDIRECT;
return $status;
}
}
// Check for length errors again now that the section is merged in
$this->contentLength = strlen( $this->toEditText( $content ) );
if ( $this->contentLength > $maxArticleSize * 1024 ) {
$this->tooBig = true;
$status->setResult( false, self::AS_MAX_ARTICLE_SIZE_EXCEEDED );
return $status;
}
$flags = EDIT_AUTOSUMMARY |
( $new ? EDIT_NEW : EDIT_UPDATE ) |
( ( $this->minoredit && !$this->isNew ) ? EDIT_MINOR : 0 ) |
( $markAsBot ? EDIT_FORCE_BOT : 0 );
$doEditStatus = $this->page->doEditContent(
$content,
$this->summary,
$flags,
$this->undoAfter ?: false,
$user,
$content->getDefaultFormat(),
$this->changeTags,
$this->undidRev
);
if ( !$doEditStatus->isOK() ) {
// Failure from doEdit()
// Show the edit conflict page for certain recognized errors from doEdit(),
// but don't show it for errors from extension hooks
$errors = $doEditStatus->getErrorsArray();
if ( in_array( $errors[0][0],
[ 'edit-gone-missing', 'edit-conflict', 'edit-already-exists' ] )
) {
$this->isConflict = true;
}
// Destroys data doEdit() put in $status->value but who cares
$doEditStatus->value = self::AS_END;
return $doEditStatus;
}
$result['nullEdit'] = $doEditStatus->hasMessage( 'edit-no-change' );
if ( $result['nullEdit'] ) {
// We don't know if it was a null edit until now, so increment here
$user->pingLimiter( 'linkpurge' );
}
$result['redirect'] = $content->isRedirect();
$this->updateWatchlist();
// If the content model changed, add a log entry
if ( $changingContentModel ) {
$this->addContentModelChangeLogEntry(
$user,
$new ? false : $oldContentModel,
$this->contentModel,
$this->summary
);
}
return $status;
}
/**
* @param User $user
* @param string|false $oldModel false if the page is being newly created
* @param string $newModel
* @param string $reason
*/
protected function addContentModelChangeLogEntry( User $user, $oldModel, $newModel, $reason ) {
$new = $oldModel === false;
$log = new ManualLogEntry( 'contentmodel', $new ? 'new' : 'change' );
$log->setPerformer( $user );
$log->setTarget( $this->mTitle );
$log->setComment( $reason );
$log->setParameters( [
'4::oldmodel' => $oldModel,
'5::newmodel' => $newModel
] );
$logid = $log->insert();
$log->publish( $logid );
}
/**
* Register the change of watch status
*/
protected function updateWatchlist() {
$user = $this->context->getUser();
if ( !$user->isLoggedIn() ) {
return;
}
$title = $this->mTitle;
$watch = $this->watchthis;
$watchlistExpiry = $this->watchlistExpiry;
// This can't run as a DeferredUpdate due to a possible race condition
// when the post-edit redirect happens if the pendingUpdates queue is
// too large to finish in time (T259564)
WatchAction::doWatchOrUnwatch( $watch, $title, $user, $watchlistExpiry );
// Add a job to purge expired watchlist items. Jobs will only be added at the rate
// specified by $wgWatchlistPurgeRate, which by default is every tenth edit.
if ( $this->watchlistExpiryEnabled ) {
$purgeRate = $this->getContext()->getConfig()->get( 'WatchlistPurgeRate' );
$this->watchedItemStore->enqueueWatchlistExpiryJob( $purgeRate );
}
}
/**
* Attempts to do 3-way merge of edit content with a base revision
* and current content, in case of edit conflict, in whichever way appropriate
* for the content type.
*
* @since 1.21
*
* @param Content &$editContent
*
* @return bool
*/
private function mergeChangesIntoContent( &$editContent ) {
// This is the revision that was current at the time editing was initiated on the client,
// even if the edit was based on an old revision.
$baseRevRecord = $this->getExpectedParentRevision();
$baseContent = $baseRevRecord ?
$baseRevRecord->getContent( SlotRecord::MAIN ) :
null;
if ( $baseContent === null ) {
return false;
}
// The current state, we want to merge updates into it
$currentRevisionRecord = $this->revisionStore->getRevisionByTitle(
$this->mTitle,
0,
RevisionStore::READ_LATEST
);
$currentContent = $currentRevisionRecord
? $currentRevisionRecord->getContent( SlotRecord::MAIN )
: null;
if ( $currentContent === null ) {
return false;
}
$result = $this->contentHandlerFactory
->getContentHandler( $baseContent->getModel() )
->merge3( $baseContent, $editContent, $currentContent );
if ( $result ) {
$editContent = $result;
// Update parentRevId to what we just merged.
$this->parentRevId = $currentRevisionRecord->getId();
return true;
}
return false;
}
/**
* Returns the revision that was current at the time editing was initiated on the client,
* even if the edit was based on an old revision.
*
* @deprecated since 1.35, use ::getExpectedParentRevision
*
* @warning this method is very poorly named. If the user opened the form with ?oldid=X,
* one might think of X as the "base revision", which is NOT what this returns,
* see oldid for that. One might further assume that this corresponds to the $baseRevId
* parameter of WikiPage::doEditContent, which is not the case either.
* getExpectedParentRevision() would perhaps be a better name.
*
* @return Revision|null Current version when editing was initiated on the client
*/
public function getBaseRevision() {
wfDeprecated( __METHOD__, '1.35' );
if ( $this->mBaseRevision === false ) {
$revRecord = $this->getExpectedParentRevision();
$this->mBaseRevision = $revRecord ? new Revision( $revRecord ) : null;
}
return $this->mBaseRevision;
}
/**
* Returns the RevisionRecord corresponding to the revision that was current at the time
* editing was initiated on the client even if the edit was based on an old revision
*
* @since 1.35
* @return RevisionRecord|null Current revision when editing was initiated on the client
*/
public function getExpectedParentRevision() {
if ( $this->mExpectedParentRevision === false ) {
$revRecord = null;
if ( $this->editRevId ) {
$revRecord = $this->revisionStore->getRevisionById(
$this->editRevId,
RevisionStore::READ_LATEST
);
} else {
$revRecord = $this->revisionStore->getRevisionByTimestamp(
$this->getTitle(),
$this->edittime,
RevisionStore::READ_LATEST
);
}
$this->mExpectedParentRevision = $revRecord;
}
return $this->mExpectedParentRevision;
}
/**
* Check given input text against $wgSpamRegex, and return the text of the first match.
*
* @deprecated since 1.35, use the new SpamChecker service
*
* @param string $text
*
* @return string|bool Matching string or false
*/
public static function matchSpamRegex( $text ) {
wfDeprecated( __METHOD__, '1.35' );
return MediaWikiServices::getInstance()->getSpamChecker()->checkContent( $text );
}
/**
* Check given input text against $wgSummarySpamRegex, and return the text of the first match.
*
* @deprecated since 1.35, use the new SpamChecker service
*
* @param string $text
*
* @return string|bool Matching string or false
*/
public static function matchSummarySpamRegex( $text ) {
wfDeprecated( __METHOD__, '1.35' );
return MediaWikiServices::getInstance()->getSpamChecker()->checkSummary( $text );
}
public function setHeaders() {
$out = $this->context->getOutput();
$out->addModules( 'mediawiki.action.edit' );
$out->addModuleStyles( 'mediawiki.action.edit.styles' );
$out->addModuleStyles( 'mediawiki.editfont.styles' );
$user = $this->context->getUser();
if ( $user->getOption( 'uselivepreview' ) ) {
$out->addModules( 'mediawiki.action.edit.preview' );
}
if ( $user->getOption( 'useeditwarning' ) ) {
$out->addModules( 'mediawiki.action.edit.editWarning' );
}
if ( $this->watchlistExpiryEnabled && $user->isRegistered() ) {
$out->addModules( 'mediawiki.action.edit.watchlistExpiry' );
}
# Enabled article-related sidebar, toplinks, etc.
$out->setArticleRelated( true );
$contextTitle = $this->getContextTitle();
if ( $this->isConflict ) {
$msg = 'editconflict';
} elseif ( $contextTitle->exists() && $this->section != '' ) {
$msg = $this->section == 'new' ? 'editingcomment' : 'editingsection';
} else {
$msg = $contextTitle->exists()
|| ( $contextTitle->getNamespace() == NS_MEDIAWIKI
&& $contextTitle->getDefaultMessageText() !== false
)
? 'editing'
: 'creating';
}
# Use the title defined by DISPLAYTITLE magic word when present
# NOTE: getDisplayTitle() returns HTML while getPrefixedText() returns plain text.
# setPageTitle() treats the input as wikitext, which should be safe in either case.
$displayTitle = isset( $this->mParserOutput ) ? $this->mParserOutput->getDisplayTitle() : false;
if ( $displayTitle === false ) {
$displayTitle = $contextTitle->getPrefixedText();
} else {
$out->setDisplayTitle( $displayTitle );
}
$out->setPageTitle( $this->context->msg( $msg, $displayTitle ) );
$config = $this->context->getConfig();
# Transmit the name of the message to JavaScript for live preview
# Keep Resources.php/mediawiki.action.edit.preview in sync with the possible keys
$out->addJsConfigVars( [
'wgEditMessage' => $msg,
'wgAjaxEditStash' => $config->get( 'AjaxEditStash' ),
] );
// Add whether to use 'save' or 'publish' messages to JavaScript for post-edit, other
// editors, etc.
$out->addJsConfigVars(
'wgEditSubmitButtonLabelPublish',
$config->get( 'EditSubmitButtonLabelPublish' )
);
}
/**
* Show all applicable editing introductions
*/
protected function showIntro() {
if ( $this->suppressIntro ) {
return;
}
$out = $this->context->getOutput();
$namespace = $this->mTitle->getNamespace();
if ( $namespace == NS_MEDIAWIKI ) {
# Show a warning if editing an interface message
$out->wrapWikiMsg( "
\n$1\n
", 'editinginterface' );
# If this is a default message (but not css, json, or js),
# show a hint that it is translatable on translatewiki.net
if (
!$this->mTitle->hasContentModel( CONTENT_MODEL_CSS )
&& !$this->mTitle->hasContentModel( CONTENT_MODEL_JSON )
&& !$this->mTitle->hasContentModel( CONTENT_MODEL_JAVASCRIPT )
) {
$defaultMessageText = $this->mTitle->getDefaultMessageText();
if ( $defaultMessageText !== false ) {
$out->wrapWikiMsg( "
\n$1\n
",
'translateinterface' );
}
}
} elseif ( $namespace == NS_FILE ) {
# Show a hint to shared repo
$file = MediaWikiServices::getInstance()->getRepoGroup()->findFile( $this->mTitle );
if ( $file && !$file->isLocal() ) {
$descUrl = $file->getDescriptionUrl();
# there must be a description url to show a hint to shared repo
if ( $descUrl ) {
if ( !$this->mTitle->exists() ) {
$out->wrapWikiMsg( "
", [
'sharedupload-desc-edit', $file->getRepo()->getDisplayName(), $descUrl
] );
}
}
}
}
# Show a warning message when someone creates/edits a user (talk) page but the user does not exist
# Show log extract when the user is currently blocked
if ( $namespace == NS_USER || $namespace == NS_USER_TALK ) {
$username = explode( '/', $this->mTitle->getText(), 2 )[0];
$user = User::newFromName( $username, false /* allow IP users */ );
$ip = User::isIP( $username );
$block = DatabaseBlock::newFromTarget( $user, $user );
if ( !( $user && $user->isLoggedIn() ) && !$ip ) { # User does not exist
$out->wrapWikiMsg( "
\n$1\n
",
[ 'userpage-userdoesnotexist', wfEscapeWikiText( $username ) ] );
} elseif (
$block !== null &&
$block->getType() != DatabaseBlock::TYPE_AUTO &&
( $block->isSitewide() || $user->isBlockedFrom( $this->mTitle ) )
) {
// Show log extract if the user is sitewide blocked or is partially
// blocked and not allowed to edit their user page or user talk page
LogEventsList::showLogExtract(
$out,
'block',
MediaWikiServices::getInstance()->getNamespaceInfo()->
getCanonicalName( NS_USER ) . ':' . $block->getTarget(),
'',
[
'lim' => 1,
'showIfEmpty' => false,
'msgKey' => [
'blocked-notice-logextract',
$user->getName() # Support GENDER in notice
]
]
);
}
}
# Try to add a custom edit intro, or use the standard one if this is not possible.
if ( !$this->showCustomIntro() && !$this->mTitle->exists() ) {
$helpLink = wfExpandUrl( Skin::makeInternalOrExternalUrl(
$this->context->msg( 'helppage' )->inContentLanguage()->text()
) );
if ( $this->context->getUser()->isLoggedIn() ) {
$out->wrapWikiMsg(
// Suppress the external link icon, consider the help url an internal one
"
\n$1\n
",
[
'newarticletext',
$helpLink
]
);
} else {
$out->wrapWikiMsg(
// Suppress the external link icon, consider the help url an internal one
"
\n$1\n
",
[
'newarticletextanon',
$helpLink
]
);
}
}
# Give a notice if the user is editing a deleted/moved page...
if ( !$this->mTitle->exists() ) {
$dbr = wfGetDB( DB_REPLICA );
LogEventsList::showLogExtract( $out, [ 'delete', 'move' ], $this->mTitle,
'',
[
'lim' => 10,
'conds' => [ 'log_action != ' . $dbr->addQuotes( 'revision' ) ],
'showIfEmpty' => false,
'msgKey' => [ 'recreate-moveddeleted-warn' ]
]
);
}
}
/**
* Attempt to show a custom editing introduction, if supplied
*
* @return bool
*/
protected function showCustomIntro() {
if ( $this->editintro ) {
$title = Title::newFromText( $this->editintro );
if ( $this->isPageExistingAndViewable( $title, $this->context->getUser() ) ) {
// Added using template syntax, to take 's into account.
$this->context->getOutput()->addWikiTextAsContent(
'
{{:' . $title->getFullText() . '}}
',
/*linestart*/true,
$this->mTitle
);
return true;
}
}
return false;
}
/**
* Gets an editable textual representation of $content.
* The textual representation can be turned by into a Content object by the
* toEditContent() method.
*
* If $content is null or false or a string, $content is returned unchanged.
*
* If the given Content object is not of a type that can be edited using
* the text base EditPage, an exception will be raised. Set
* $this->allowNonTextContent to true to allow editing of non-textual
* content.
*
* @param Content|null|bool|string $content
* @return string|false|null The editable text form of the content.
*
* @throws MWException If $content is not an instance of TextContent and
* $this->allowNonTextContent is not true.
*/
protected function toEditText( $content ) {
if ( $content === null || $content === false || is_string( $content ) ) {
return $content;
}
if ( !$this->isSupportedContentModel( $content->getModel() ) ) {
throw new MWException( 'This content model is not supported: ' . $content->getModel() );
}
return $content->serialize( $this->contentFormat );
}
/**
* Turns the given text into a Content object by unserializing it.
*
* If the resulting Content object is not of a type that can be edited using
* the text base EditPage, an exception will be raised. Set
* $this->allowNonTextContent to true to allow editing of non-textual
* content.
*
* @param string|null|bool $text Text to unserialize
* @return Content|bool|null The content object created from $text. If $text was false
* or null, then false or null will be returned instead.
*
* @throws MWException If unserializing the text results in a Content
* object that is not an instance of TextContent and
* $this->allowNonTextContent is not true.
*/
protected function toEditContent( $text ) {
if ( $text === false || $text === null ) {
return $text;
}
$content = ContentHandler::makeContent( $text, $this->getTitle(),
$this->contentModel, $this->contentFormat );
if ( !$this->isSupportedContentModel( $content->getModel() ) ) {
throw new MWException( 'This content model is not supported: ' . $content->getModel() );
}
return $content;
}
/**
* Send the edit form and related headers to OutputPage
* @param callable|null $formCallback That takes an OutputPage parameter; will be called
* during form output near the top, for captchas and the like.
*
* The $formCallback parameter is deprecated since MediaWiki 1.25. Please
* use the EditPage::showEditForm:fields hook instead.
*/
public function showEditForm( $formCallback = null ) {
# need to parse the preview early so that we know which templates are used,
# otherwise users with "show preview after edit box" will get a blank list
# we parse this near the beginning so that setHeaders can do the title
# setting work instead of leaving it in getPreviewText
$previewOutput = '';
if ( $this->formtype == 'preview' ) {
$previewOutput = $this->getPreviewText();
}
$out = $this->context->getOutput();
$this->getHookRunner()->onEditPage__showEditForm_initial( $this, $out );
$this->setHeaders();
$this->addTalkPageText();
$this->addEditNotices();
if ( !$this->isConflict &&
$this->section != '' &&
!$this->isSectionEditSupported() ) {
// We use $this->section to much before this and getVal('wgSection') directly in other places
// at this point we can't reset $this->section to '' to fallback to non-section editing.
// Someone is welcome to try refactoring though
$out->showErrorPage( 'sectioneditnotsupported-title', 'sectioneditnotsupported-text' );
return;
}
$this->showHeader();
$out->addHTML( $this->editFormPageTop );
$user = $this->context->getUser();
if ( $user->getOption( 'previewontop' ) ) {
$this->displayPreviewArea( $previewOutput, true );
}
$out->addHTML( $this->editFormTextTop );
if ( $this->wasDeletedSinceLastEdit() && $this->formtype !== 'save' ) {
$out->wrapWikiMsg( "
\n$1\n
",
'deletedwhileediting' );
}
// @todo add EditForm plugin interface and use it here!
// search for textarea1 and textarea2, and allow EditForm to override all uses.
$out->addHTML( Html::openElement(
'form',
[
'class' => 'mw-editform',
'id' => self::EDITFORM_ID,
'name' => self::EDITFORM_ID,
'method' => 'post',
'action' => $this->getActionURL( $this->getContextTitle() ),
'enctype' => 'multipart/form-data'
]
) );
if ( is_callable( $formCallback ) ) {
wfWarn( 'The $formCallback parameter to ' . __METHOD__ . 'is deprecated' );
call_user_func_array( $formCallback, [ &$out ] );
}
// Add a check for Unicode support
$out->addHTML( Html::hidden( 'wpUnicodeCheck', self::UNICODE_CHECK ) );
// Add an empty field to trip up spambots
$out->addHTML(
Xml::openElement( 'div', [ 'id' => 'antispam-container', 'style' => 'display: none;' ] )
. Html::rawElement(
'label',
[ 'for' => 'wpAntispam' ],
$this->context->msg( 'simpleantispam-label' )->parse()
)
. Xml::element(
'input',
[
'type' => 'text',
'name' => 'wpAntispam',
'id' => 'wpAntispam',
'value' => ''
]
)
. Xml::closeElement( 'div' )
);
$this->getHookRunner()->onEditPage__showEditForm_fields( $this, $out );
// Put these up at the top to ensure they aren't lost on early form submission
$this->showFormBeforeText();
if ( $this->wasDeletedSinceLastEdit() && $this->formtype == 'save' ) {
$username = $this->lastDelete->user_name;
$comment = CommentStore::getStore()
->getComment( 'log_comment', $this->lastDelete )->text;
// It is better to not parse the comment at all than to have templates expanded in the middle
// TODO: can the checkLabel be moved outside of the div so that wrapWikiMsg could be used?
$key = $comment === ''
? 'confirmrecreate-noreason'
: 'confirmrecreate';
$out->addHTML(
'
",
[ 'userjsyoucanpreview' ]
);
}
}
}
}
$this->addPageProtectionWarningHeaders();
$this->addLongPageWarningHeader();
# Add header copyright warning
$this->showHeaderCopyrightWarning();
}
/**
* Helper function for summary input functions, which returns the necessary
* attributes for the input.
*
* @param array|null $inputAttrs Array of attrs to use on the input
* @return array
*/
private function getSummaryInputAttributes( array $inputAttrs = null ) {
// 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.
return ( is_array( $inputAttrs ) ? $inputAttrs : [] ) + [
'id' => 'wpSummary',
'name' => 'wpSummary',
'maxlength' => CommentStore::COMMENT_CHARACTER_LIMIT,
'tabindex' => 1,
'size' => 60,
'spellcheck' => 'true',
];
}
/**
* Builds a standard summary input with a label.
*
* @param string $summary The value of the summary input
* @param string|null $labelText The html to place inside the label
* @param array|null $inputAttrs Array of attrs to use on the input
*
* @return OOUI\FieldLayout OOUI FieldLayout with Label and Input
*/
public function getSummaryInputWidget( $summary = "", $labelText = null, $inputAttrs = null ) {
$inputAttrs = OOUI\Element::configFromHtmlAttributes(
$this->getSummaryInputAttributes( $inputAttrs )
);
$inputAttrs += [
'title' => Linker::titleAttrib( 'summary' ),
'accessKey' => Linker::accesskey( 'summary' ),
];
// For compatibility with old scripts and extensions, we want the legacy 'id' on the ``
$inputAttrs['inputId'] = $inputAttrs['id'];
$inputAttrs['id'] = 'wpSummaryWidget';
return new OOUI\FieldLayout(
new OOUI\TextInputWidget( [
'value' => $summary,
'infusable' => true,
] + $inputAttrs ),
[
'label' => new OOUI\HtmlSnippet( $labelText ),
'align' => 'top',
'id' => 'wpSummaryLabel',
'classes' => [ $this->missingSummary ? 'mw-summarymissed' : 'mw-summary' ],
]
);
}
/**
* @param bool $isSubjectPreview True if this is the section subject/title
* up top, or false if this is the comment summary
* down below the textarea
* @param string $summary The text of the summary to display
*/
protected function showSummaryInput( $isSubjectPreview, $summary = "" ) {
# Add a class if 'missingsummary' is triggered to allow styling of the summary line
$summaryClass = $this->missingSummary ? 'mw-summarymissed' : 'mw-summary';
if ( $isSubjectPreview ) {
if ( $this->nosummary ) {
return;
}
} elseif ( !$this->mShowSummaryField ) {
return;
}
$labelText = $this->context->msg( $isSubjectPreview ? 'subject' : 'summary' )->parse();
$this->context->getOutput()->addHTML( $this->getSummaryInputWidget(
$summary,
$labelText,
[ 'class' => $summaryClass ]
) );
}
/**
* @param bool $isSubjectPreview True if this is the section subject/title
* up top, or false if this is the comment summary
* down below the textarea
* @param string $summary The text of the summary to display
* @return string
*/
protected function getSummaryPreview( $isSubjectPreview, $summary = "" ) {
// avoid spaces in preview, gets always trimmed on save
$summary = trim( $summary );
if ( !$summary || ( !$this->preview && !$this->diff ) ) {
return "";
}
if ( $isSubjectPreview ) {
$summary = $this->context->msg( 'newsectionsummary' )
->rawParams( MediaWikiServices::getInstance()->getParser()
->stripSectionName( $summary ) )
->inContentLanguage()->text();
}
$message = $isSubjectPreview ? 'subject-preview' : 'summary-preview';
$summary = $this->context->msg( $message )->parse()
. Linker::commentBlock( $summary, $this->mTitle, $isSubjectPreview );
return Xml::tags( 'div', [ 'class' => 'mw-summary-preview' ], $summary );
}
protected function showFormBeforeText() {
$out = $this->context->getOutput();
$out->addHTML( Html::hidden( 'wpSection', $this->section ) );
$out->addHTML( Html::hidden( 'wpStarttime', $this->starttime ) );
$out->addHTML( Html::hidden( 'wpEdittime', $this->edittime ) );
$out->addHTML( Html::hidden( 'editRevId', $this->editRevId ) );
$out->addHTML( Html::hidden( 'wpScrolltop', $this->scrolltop, [ 'id' => 'wpScrolltop' ] ) );
}
protected function showFormAfterText() {
/**
* To make it harder for someone to slip a user a page
* which submits an edit form to the wiki without their
* knowledge, a random token is associated with the login
* session. If it's not passed back with the submission,
* we won't save the page, or render user JavaScript and
* CSS previews.
*
* For anon editors, who may not have a session, we just
* include the constant suffix to prevent editing from
* broken text-mangling proxies.
*/
$this->context->getOutput()->addHTML(
"\n" .
Html::hidden( "wpEditToken", $this->context->getUser()->getEditToken() ) .
"\n"
);
}
/**
* Subpage overridable method for printing the form for page content editing
* By default this simply outputs wpTextbox1
* Subclasses can override this to provide a custom UI for editing;
* be it a form, or simply wpTextbox1 with a modified content that will be
* reverse modified when extracted from the post data.
* Note that this is basically the inverse for importContentFormData
*/
protected function showContentForm() {
$this->showTextbox1();
}
/**
* Method to output wpTextbox1
* The $textoverride method can be used by subclasses overriding showContentForm
* to pass back to this method.
*
* @param array|null $customAttribs Array of html attributes to use in the textarea
* @param string|null $textoverride Optional text to override $this->textarea1 with
*/
protected function showTextbox1( $customAttribs = null, $textoverride = null ) {
if ( $this->wasDeletedSinceLastEdit() && $this->formtype == 'save' ) {
$attribs = [ 'style' => 'display:none;' ];
} else {
$builder = new TextboxBuilder();
$classes = $builder->getTextboxProtectionCSSClasses( $this->getTitle() );
# Is an old revision being edited?
if ( $this->isOldRev ) {
$classes[] = 'mw-textarea-oldrev';
}
$attribs = [
'aria-label' => $this->context->msg( 'edit-textarea-aria-label' )->text(),
'tabindex' => 1
];
if ( is_array( $customAttribs ) ) {
$attribs += $customAttribs;
}
$attribs = $builder->mergeClassesIntoAttributes( $classes, $attribs );
}
$this->showTextbox(
$textoverride ?? $this->textbox1,
'wpTextbox1',
$attribs
);
}
protected function showTextbox2() {
$this->showTextbox( $this->textbox2, 'wpTextbox2', [ 'tabindex' => 6, 'readonly' ] );
}
protected function showTextbox( $text, $name, $customAttribs = [] ) {
$builder = new TextboxBuilder();
$attribs = $builder->buildTextboxAttribs(
$name,
$customAttribs,
$this->context->getUser(),
$this->mTitle
);
$this->context->getOutput()->addHTML(
Html::textarea( $name, $builder->addNewLineAtEnd( $text ), $attribs )
);
}
protected function displayPreviewArea( $previewOutput, $isOnTop = false ) {
$classes = [];
if ( $isOnTop ) {
$classes[] = 'ontop';
}
$attribs = [ 'id' => 'wikiPreview', 'class' => implode( ' ', $classes ) ];
if ( $this->formtype != 'preview' ) {
$attribs['style'] = 'display: none;';
}
$out = $this->context->getOutput();
$out->addHTML( Xml::openElement( 'div', $attribs ) );
if ( $this->formtype == 'preview' ) {
$this->showPreview( $previewOutput );
} else {
// Empty content container for LivePreview
$pageViewLang = $this->mTitle->getPageViewLanguage();
$attribs = [ 'lang' => $pageViewLang->getHtmlCode(), 'dir' => $pageViewLang->getDir(),
'class' => 'mw-content-' . $pageViewLang->getDir() ];
$out->addHTML( Html::rawElement( 'div', $attribs ) );
}
$out->addHTML( '' );
if ( $this->formtype == 'diff' ) {
try {
$this->showDiff();
} catch ( MWContentSerializationException $ex ) {
$msg = $this->context->msg(
'content-failed-to-parse',
$this->contentModel,
$this->contentFormat,
$ex->getMessage()
);
$out->wrapWikiTextAsInterface( 'error', $msg->plain() );
}
}
}
/**
* Append preview output to OutputPage.
* Includes category rendering if this is a category page.
*
* @param string $text The HTML to be output for the preview.
*/
protected function showPreview( $text ) {
if ( $this->mArticle instanceof CategoryPage ) {
$this->mArticle->openShowCategory();
}
# This hook seems slightly odd here, but makes things more
# consistent for extensions.
$out = $this->context->getOutput();
$this->getHookRunner()->onOutputPageBeforeHTML( $out, $text );
$out->addHTML( $text );
if ( $this->mArticle instanceof CategoryPage ) {
$this->mArticle->closeShowCategory();
}
}
/**
* Get a diff between the current contents of the edit box and the
* version of the page we're editing from.
*
* If this is a section edit, we'll replace the section as for final
* save and then make a comparison.
*/
public function showDiff() {
$oldtitlemsg = 'currentrev';
# if message does not exist, show diff against the preloaded default
if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI && !$this->mTitle->exists() ) {
$oldtext = $this->mTitle->getDefaultMessageText();
if ( $oldtext !== false ) {
$oldtitlemsg = 'defaultmessagetext';
$oldContent = $this->toEditContent( $oldtext );
} else {
$oldContent = null;
}
} else {
$oldContent = $this->getCurrentContent();
}
$textboxContent = $this->toEditContent( $this->textbox1 );
if ( $this->editRevId !== null ) {
$newContent = $this->page->replaceSectionAtRev(
$this->section, $textboxContent, $this->summary, $this->editRevId
);
} else {
$newContent = $this->page->replaceSectionContent(
$this->section, $textboxContent, $this->summary, $this->edittime
);
}
if ( $newContent ) {
$this->getHookRunner()->onEditPageGetDiffContent( $this, $newContent );
$user = $this->context->getUser();
$popts = ParserOptions::newFromUserAndLang( $user,
MediaWikiServices::getInstance()->getContentLanguage() );
$newContent = $newContent->preSaveTransform( $this->mTitle, $user, $popts );
}
if ( ( $oldContent && !$oldContent->isEmpty() ) || ( $newContent && !$newContent->isEmpty() ) ) {
$oldtitle = $this->context->msg( $oldtitlemsg )->parse();
$newtitle = $this->context->msg( 'yourtext' )->parse();
if ( !$oldContent ) {
$oldContent = $newContent->getContentHandler()->makeEmptyContent();
}
if ( !$newContent ) {
$newContent = $oldContent->getContentHandler()->makeEmptyContent();
}
$de = $oldContent->getContentHandler()->createDifferenceEngine( $this->context );
$de->setContent( $oldContent, $newContent );
$difftext = $de->getDiff( $oldtitle, $newtitle );
$de->showDiffStyle();
} else {
$difftext = '';
}
$this->context->getOutput()->addHTML( '
' . $difftext . '
' );
}
/**
* Show the header copyright warning.
*/
protected function showHeaderCopyrightWarning() {
$msg = 'editpage-head-copy-warn';
if ( !$this->context->msg( $msg )->isDisabled() ) {
$this->context->getOutput()->wrapWikiMsg( "
\n$1\n
",
'editpage-head-copy-warn' );
}
}
/**
* Give a chance for site and per-namespace customizations of
* terms of service summary link that might exist separately
* from the copyright notice.
*
* This will display between the save button and the edit tools,
* so should remain short!
*/
protected function showTosSummary() {
$msg = 'editpage-tos-summary';
$this->getHookRunner()->onEditPageTosSummary( $this->mTitle, $msg );
if ( !$this->context->msg( $msg )->isDisabled() ) {
$out = $this->context->getOutput();
$out->addHTML( '
' );
$out->addWikiMsg( $msg );
$out->addHTML( '
' );
}
}
/**
* Inserts optional text shown below edit and upload forms. Can be used to offer special
* characters not present on most keyboards for copying/pasting.
*/
protected function showEditTools() {
$this->context->getOutput()->addHTML( '
";
}
}
# If we're adding a comment, we need to show the
# summary as the headline
if ( $this->section === "new" && $this->summary !== "" ) {
$content = $content->addSectionHeader( $this->summary );
}
$this->getHookRunner()->onEditPageGetPreviewContent( $this, $content );
$parserResult = $this->doPreviewParse( $content );
$parserOutput = $parserResult['parserOutput'];
$previewHTML = $parserResult['html'];
$this->mParserOutput = $parserOutput;
$out->addParserOutputMetadata( $parserOutput );
if ( $out->userCanPreview() ) {
$out->addContentOverride( $this->getTitle(), $content );
}
if ( count( $parserOutput->getWarnings() ) ) {
$note .= "\n\n" . implode( "\n\n", $parserOutput->getWarnings() );
}
} catch ( MWContentSerializationException $ex ) {
$m = $this->context->msg(
'content-failed-to-parse',
$this->contentModel,
$this->contentFormat,
$ex->getMessage()
);
$note .= "\n\n" . $m->plain(); # gets parsed down below
$previewHTML = '';
}
if ( $this->isConflict ) {
$conflict = Html::rawElement(
'div', [ 'id' => 'mw-previewconflict', 'class' => 'warningbox' ],
$this->context->msg( 'previewconflict' )->escaped()
);
} else {
$conflict = '';
}
$previewhead = Html::rawElement(
'div', [ 'class' => 'previewnote' ],
Html::rawElement(
'h2', [ 'id' => 'mw-previewheader' ],
$this->context->msg( 'preview' )->escaped()
) .
Html::rawElement( 'div', [ 'class' => 'warningbox' ],
$out->parseAsInterface( $note )
) . $conflict
);
$pageViewLang = $this->mTitle->getPageViewLanguage();
$attribs = [ 'lang' => $pageViewLang->getHtmlCode(), 'dir' => $pageViewLang->getDir(),
'class' => 'mw-content-' . $pageViewLang->getDir() ];
$previewHTML = Html::rawElement( 'div', $attribs, $previewHTML );
return $previewhead . $previewHTML . $this->previewTextAfterContent;
}
private function incrementEditFailureStats( $failureType ) {
$stats = MediaWikiServices::getInstance()->getStatsdDataFactory();
$stats->increment( 'edit.failures.' . $failureType );
}
/**
* Get parser options for a preview
* @return ParserOptions
*/
protected function getPreviewParserOptions() {
$parserOptions = $this->page->makeParserOptions( $this->context );
$parserOptions->setIsPreview( true );
$parserOptions->setIsSectionPreview( $this->section !== null && $this->section !== '' );
$parserOptions->enableLimitReport();
// XXX: we could call $parserOptions->setCurrentRevisionCallback here to force the
// current revision to be null during PST, until setupFakeRevision is called on
// the ParserOptions. Currently, we rely on Parser::getRevisionObject() to ignore
// existing revisions in preview mode.
return $parserOptions;
}
/**
* Parse the page for a preview. Subclasses may override this class, in order
* to parse with different options, or to otherwise modify the preview HTML.
*
* @param Content $content The page content
* @return array with keys:
* - parserOutput: The ParserOutput object
* - html: The HTML to be displayed
*/
protected function doPreviewParse( Content $content ) {
$user = $this->context->getUser();
$parserOptions = $this->getPreviewParserOptions();
// NOTE: preSaveTransform doesn't have a fake revision to operate on.
// Parser::getRevisionObject() will return null in preview mode,
// causing the context user to be used for {{subst:REVISIONUSER}}.
// XXX: Alternatively, we could also call setupFakeRevision() a second time:
// once before PST with $content, and then after PST with $pstContent.
$pstContent = $content->preSaveTransform( $this->mTitle, $user, $parserOptions );
$scopedCallback = $parserOptions->setupFakeRevision( $this->mTitle, $pstContent, $user );
$parserOutput = $pstContent->getParserOutput( $this->mTitle, null, $parserOptions );
ScopedCallback::consume( $scopedCallback );
return [
'parserOutput' => $parserOutput,
'html' => $parserOutput->getText( [
'enableSectionEditLinks' => false
] )
];
}
/**
* @return array
*/
public function getTemplates() {
if ( $this->preview || $this->section != '' ) {
$templates = [];
if ( !isset( $this->mParserOutput ) ) {
return $templates;
}
foreach ( $this->mParserOutput->getTemplates() as $ns => $template ) {
foreach ( array_keys( $template ) as $dbk ) {
$templates[] = Title::makeTitle( $ns, $dbk );
}
}
return $templates;
} else {
return $this->mTitle->getTemplateLinksFrom();
}
}
/**
* Allow extensions to provide a toolbar.
*
* @return string|null
*/
public static function getEditToolbar() {
$startingToolbar = '';
$toolbar = $startingToolbar;
if ( !Hooks::runner()->onEditPageBeforeEditToolbar( $toolbar ) ) {
return null;
}
// Don't add a pointless `
` to the page unless a hook caller populated it
return ( $toolbar === $startingToolbar ) ? null : $toolbar;
}
/**
* Return an array of checkbox definitions.
*
* Array keys correspond to the `` 'name' attribute to use for each checkbox.
*
* Array values are associative arrays with the following keys:
* - 'label-message' (required): message for label text
* - 'id' (required): 'id' attribute for the ``
* - 'default' (required): default checkedness (true or false)
* - 'title-message' (optional): used to generate 'title' attribute for the `