3 * User interface for page editing.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 use MediaWiki\EditPage\TextboxBuilder
;
24 use MediaWiki\EditPage\TextConflictHelper
;
25 use MediaWiki\Logger\LoggerFactory
;
26 use MediaWiki\MediaWikiServices
;
27 use Wikimedia\ScopedCallback
;
30 * The edit page/HTML interface (split from Article)
31 * The actual database and text munging is still in Article,
32 * but it should get easier to call those from alternate
35 * EditPage cares about two distinct titles:
36 * $this->mContextTitle is the page that forms submit to, links point to,
37 * redirects go to, etc. $this->mTitle (as well as $mArticle) is the
38 * page in the database that is actually being edited. These are
39 * usually the same, but they are now allowed to be different.
41 * Surgeon General's Warning: prolonged exposure to this class is known to cause
42 * headaches, which may be fatal.
46 * Used for Unicode support checks
48 const UNICODE_CHECK
= 'β³π²β₯πππΎπΈβ΄πΉβ―';
51 * Status: Article successfully updated
53 const AS_SUCCESS_UPDATE
= 200;
56 * Status: Article successfully created
58 const AS_SUCCESS_NEW_ARTICLE
= 201;
61 * Status: Article update aborted by a hook function
63 const AS_HOOK_ERROR
= 210;
66 * Status: A hook function returned an error
68 const AS_HOOK_ERROR_EXPECTED
= 212;
71 * Status: User is blocked from editing this page
73 const AS_BLOCKED_PAGE_FOR_USER
= 215;
76 * Status: Content too big (> $wgMaxArticleSize)
78 const AS_CONTENT_TOO_BIG
= 216;
81 * Status: this anonymous user is not allowed to edit this page
83 const AS_READ_ONLY_PAGE_ANON
= 218;
86 * Status: this logged in user is not allowed to edit this page
88 const AS_READ_ONLY_PAGE_LOGGED
= 219;
91 * Status: wiki is in readonly mode (wfReadOnly() == true)
93 const AS_READ_ONLY_PAGE
= 220;
96 * Status: rate limiter for action 'edit' was tripped
98 const AS_RATE_LIMITED
= 221;
101 * Status: article was deleted while editing and param wpRecreate == false or form
104 const AS_ARTICLE_WAS_DELETED
= 222;
107 * Status: user tried to create this page, but is not allowed to do that
108 * ( Title->userCan('create') == false )
110 const AS_NO_CREATE_PERMISSION
= 223;
113 * Status: user tried to create a blank page and wpIgnoreBlankArticle == false
115 const AS_BLANK_ARTICLE
= 224;
118 * Status: (non-resolvable) edit conflict
120 const AS_CONFLICT_DETECTED
= 225;
123 * Status: no edit summary given and the user has forceeditsummary set and the user is not
124 * editing in his own userspace or talkspace and wpIgnoreBlankSummary == false
126 const AS_SUMMARY_NEEDED
= 226;
129 * Status: user tried to create a new section without content
131 const AS_TEXTBOX_EMPTY
= 228;
134 * Status: article is too big (> $wgMaxArticleSize), after merging in the new section
136 const AS_MAX_ARTICLE_SIZE_EXCEEDED
= 229;
139 * Status: WikiPage::doEdit() was unsuccessful
144 * Status: summary contained spam according to one of the regexes in $wgSummarySpamRegex
146 const AS_SPAM_ERROR
= 232;
149 * Status: anonymous user is not allowed to upload (User::isAllowed('upload') == false)
151 const AS_IMAGE_REDIRECT_ANON
= 233;
154 * Status: logged in user is not allowed to upload (User::isAllowed('upload') == false)
156 const AS_IMAGE_REDIRECT_LOGGED
= 234;
159 * Status: user tried to modify the content model, but is not allowed to do that
160 * ( User::isAllowed('editcontentmodel') == false )
162 const AS_NO_CHANGE_CONTENT_MODEL
= 235;
165 * Status: user tried to create self-redirect (redirect to the same article) and
166 * wpIgnoreSelfRedirect == false
168 const AS_SELF_REDIRECT
= 236;
171 * Status: an error relating to change tagging. Look at the message key for
174 const AS_CHANGE_TAG_ERROR
= 237;
177 * Status: can't parse content
179 const AS_PARSE_ERROR
= 240;
182 * Status: when changing the content model is disallowed due to
183 * $wgContentHandlerUseDB being false
185 const AS_CANNOT_USE_CUSTOM_MODEL
= 241;
188 * Status: edit rejected because browser doesn't support Unicode.
190 const AS_UNICODE_NOT_SUPPORTED
= 242;
193 * HTML id and name for the beginning of the edit form.
195 const EDITFORM_ID
= 'editform';
198 * Prefix of key for cookie used to pass post-edit state.
199 * The revision id edited is added after this
201 const POST_EDIT_COOKIE_KEY_PREFIX
= 'PostEditRevision';
204 * Duration of PostEdit cookie, in seconds.
205 * The cookie will be removed instantly if the JavaScript runs.
207 * Otherwise, though, we don't want the cookies to accumulate.
208 * RFC 2109 ( https://www.ietf.org/rfc/rfc2109.txt ) specifies a possible
209 * limit of only 20 cookies per domain. This still applies at least to some
210 * versions of IE without full updates:
211 * https://blogs.msdn.com/b/ieinternals/archive/2009/08/20/wininet-ie-cookie-internals-faq.aspx
213 * A value of 20 minutes should be enough to take into account slow loads and minor
214 * clock skew while still avoiding cookie accumulation when JavaScript is turned off.
216 const POST_EDIT_COOKIE_DURATION
= 1200;
219 * @deprecated for public usage since 1.30 use EditPage::getArticle()
227 * @deprecated for public usage since 1.30 use EditPage::getTitle()
232 /** @var null|Title */
233 private $mContextTitle = null;
236 public $action = 'submit';
238 /** @var bool Whether an edit conflict needs to be resolved. Detected based on whether
239 * $editRevId is different than the latest revision. When a conflict has successfully
240 * been resolved by a 3-way-merge, this field is set to false.
242 public $isConflict = false;
244 /** @var bool New page or new section */
245 public $isNew = false;
248 public $deletedSinceEdit;
254 * True the first time the edit form is rendered, false after re-rendering
255 * with diff, save prompts, etc.
259 /** @var bool|stdClass */
263 public $mTokenOk = false;
266 public $mTokenOkExceptSuffix = false;
269 public $mTriedSave = false;
272 public $incompleteForm = false;
275 public $tooBig = false;
278 public $missingComment = false;
281 public $missingSummary = false;
284 public $allowBlankSummary = false;
287 protected $blankArticle = false;
290 protected $allowBlankArticle = false;
293 protected $selfRedirect = false;
296 protected $allowSelfRedirect = false;
299 public $autoSumm = '';
302 public $hookError = '';
304 /** @var ParserOutput */
305 public $mParserOutput;
307 /** @var bool Has a summary been preset using GET parameter &summary= ? */
308 public $hasPresetSummary = false;
310 /** @var Revision|bool|null A revision object corresponding to $this->editRevId. */
311 public $mBaseRevision = false;
314 public $mShowSummaryField = true;
319 public $save = false;
322 public $preview = false;
325 public $diff = false;
328 public $minoredit = false;
331 public $watchthis = false;
334 public $recreate = false;
337 * Page content input field.
339 public $textbox1 = '';
342 public $textbox2 = '';
345 public $summary = '';
348 * If true, hide the summary field.
350 public $nosummary = false;
353 * Timestamp of the latest revision of the page when editing was initiated
356 public $edittime = '';
358 /** @var int Revision ID of the latest revision of the page when editing
359 * was initiated on the client. This is used to detect and resolve edit
362 * @note 0 if the page did not exist at that time.
363 * @note When starting an edit from an old revision, this still records the current
364 * revision at the time, not the one the edit is based on.
367 * @see getBaseRevision()
369 private $editRevId = null;
372 public $section = '';
375 public $sectiontitle = '';
378 * Timestamp from the first time the edit form was rendered.
380 public $starttime = '';
382 /** @var int Revision ID the edit is based on, or 0 if it's the current revision.
383 * FIXME: This isn't used in conflict resolution--provide a better
384 * justification or merge with parentRevId.
389 /** @var int Revision ID the edit is based on, adjusted when an edit conflict is resolved.
392 * @see getparentRevId()
394 public $parentRevId = 0;
397 public $editintro = '';
400 public $scrolltop = null;
406 public $contentModel;
408 /** @var null|string */
409 public $contentFormat = null;
411 /** @var null|array */
412 private $changeTags = null;
414 # Placeholders for text injection by hooks (must be HTML)
415 # extensions should take care to _append_ to the present value
417 /** @var string Before even the preview */
418 public $editFormPageTop = '';
419 public $editFormTextTop = '';
420 public $editFormTextBeforeContent = '';
421 public $editFormTextAfterWarn = '';
422 public $editFormTextAfterTools = '';
423 public $editFormTextBottom = '';
424 public $editFormTextAfterContent = '';
425 public $previewTextAfterContent = '';
426 public $mPreloadContent = null;
428 /* $didSave should be set to true whenever an article was successfully altered. */
429 public $didSave = false;
430 public $undidRev = 0;
432 public $suppressIntro = false;
438 protected $contentLength = false;
441 * @var bool Set in ApiEditPage, based on ContentHandler::allowsDirectApiEditing
443 private $enableApiEditOverride = false;
446 * @var IContextSource
451 * @var bool Whether an old revision is edited
453 private $isOldRev = false;
456 * @var string|null What the user submitted in the 'wpUnicodeCheck' field
458 private $unicodeCheck;
461 * Factory function to create an edit conflict helper
465 private $editConflictHelperFactory;
468 * @var TextConflictHelper|null
470 private $editConflictHelper;
473 * @param Article $article
475 public function __construct( Article
$article ) {
476 $this->mArticle
= $article;
477 $this->page
= $article->getPage(); // model object
478 $this->mTitle
= $article->getTitle();
480 // Make sure the local context is in sync with other member variables.
481 // Particularly make sure everything is using the same WikiPage instance.
482 // This should probably be the case in Article as well, but it's
483 // particularly important for EditPage, to make use of the in-place caching
484 // facility in WikiPage::prepareContentForEdit.
485 $this->context
= new DerivativeContext( $article->getContext() );
486 $this->context
->setWikiPage( $this->page
);
487 $this->context
->setTitle( $this->mTitle
);
489 $this->contentModel
= $this->mTitle
->getContentModel();
491 $handler = ContentHandler
::getForModelID( $this->contentModel
);
492 $this->contentFormat
= $handler->getDefaultFormat();
493 $this->editConflictHelperFactory
= [ $this, 'newTextConflictHelper' ];
499 public function getArticle() {
500 return $this->mArticle
;
505 * @return IContextSource
507 public function getContext() {
508 return $this->context
;
515 public function getTitle() {
516 return $this->mTitle
;
520 * Set the context Title object
522 * @param Title|null $title Title object or null
524 public function setContextTitle( $title ) {
525 $this->mContextTitle
= $title;
529 * Get the context title object.
531 * If not set, $wgTitle will be returned, but this is deprecated. This will
532 * throw an exception.
536 public function getContextTitle() {
537 if ( is_null( $this->mContextTitle
) ) {
538 wfDeprecated( __METHOD__
. ' called with no title set', '1.32' );
542 return $this->mContextTitle
;
547 * Returns if the given content model is editable.
549 * @param string $modelId The ID of the content model to test. Use CONTENT_MODEL_XXX constants.
551 * @throws MWException If $modelId has no known handler
553 public function isSupportedContentModel( $modelId ) {
554 return $this->enableApiEditOverride
=== true ||
555 ContentHandler
::getForModelID( $modelId )->supportsDirectEditing();
559 * Allow editing of content that supports API direct editing, but not general
560 * direct editing. Set to false by default.
562 * @param bool $enableOverride
564 public function setApiEditOverride( $enableOverride ) {
565 $this->enableApiEditOverride
= $enableOverride;
569 * @deprecated since 1.29, call edit directly
571 public function submit() {
572 wfDeprecated( __METHOD__
, '1.29' );
577 * This is the function that gets called for "action=edit". It
578 * sets up various member variables, then passes execution to
579 * another function, usually showEditForm()
581 * The edit form is self-submitting, so that when things like
582 * preview and edit conflicts occur, we get the same form back
583 * with the extra stuff added. Only when the final submission
584 * is made and all is well do we actually save and redirect to
585 * the newly-edited page.
587 public function edit() {
588 // Allow extensions to modify/prevent this form or submission
589 if ( !Hooks
::run( 'AlternateEdit', [ $this ] ) ) {
593 wfDebug( __METHOD__
. ": enter\n" );
595 $request = $this->context
->getRequest();
596 // If they used redlink=1 and the page exists, redirect to the main article
597 if ( $request->getBool( 'redlink' ) && $this->mTitle
->exists() ) {
598 $this->context
->getOutput()->redirect( $this->mTitle
->getFullURL() );
602 $this->importFormData( $request );
603 $this->firsttime
= false;
605 if ( wfReadOnly() && $this->save
) {
608 $this->preview
= true;
612 $this->formtype
= 'save';
613 } elseif ( $this->preview
) {
614 $this->formtype
= 'preview';
615 } elseif ( $this->diff
) {
616 $this->formtype
= 'diff';
617 } else { # First time through
618 $this->firsttime
= true;
619 if ( $this->previewOnOpen() ) {
620 $this->formtype
= 'preview';
622 $this->formtype
= 'initial';
626 $permErrors = $this->getEditPermissionErrors( $this->save ?
'secure' : 'full' );
628 wfDebug( __METHOD__
. ": User can't edit\n" );
630 if ( $this->context
->getUser()->getBlock() ) {
631 // track block with a cookie if it doesn't exists already
632 $this->context
->getUser()->trackBlockWithCookie();
634 // Auto-block user's IP if the account was "hard" blocked
635 if ( !wfReadOnly() ) {
636 DeferredUpdates
::addCallableUpdate( function () {
637 $this->context
->getUser()->spreadAnyEditBlock();
641 $config = $this->context
->getConfig();
642 if ( $config->get( 'EnableBlockNoticeStats' ) ) {
643 $wiki = $config->get( 'DBname' );
644 $statsd = MediaWikiServices
::getInstance()->getStatsdDataFactory();
645 $statsd->increment( 'BlockNotices.' . $wiki . '.WikitextEditor.shown' );
648 $this->displayPermissionsError( $permErrors );
653 $revision = $this->mArticle
->getRevisionFetched();
654 // Disallow editing revisions with content models different from the current one
655 // Undo edits being an exception in order to allow reverting content model changes.
657 && $revision->getContentModel() !== $this->contentModel
660 if ( $this->undidRev
) {
661 $undidRevObj = Revision
::newFromId( $this->undidRev
);
662 $prevRev = $undidRevObj ?
$undidRevObj->getPrevious() : null;
664 if ( !$this->undidRev
666 ||
$prevRev->getContentModel() !== $this->contentModel
668 $this->displayViewSourcePage(
669 $this->getContentObject(),
671 'contentmodelediterror',
672 $revision->getContentModel(),
680 $this->isConflict
= false;
682 # Show applicable editing introductions
683 if ( $this->formtype
== 'initial' ||
$this->firsttime
) {
687 # Attempt submission here. This will check for edit conflicts,
688 # and redundantly check for locked database, blocked IPs, etc.
689 # that edit() already checked just in case someone tries to sneak
690 # in the back door with a hand-edited submission URL.
692 if ( 'save' == $this->formtype
) {
693 $resultDetails = null;
694 $status = $this->attemptSave( $resultDetails );
695 if ( !$this->handleStatus( $status, $resultDetails ) ) {
700 # First time through: get contents, set time for conflict
702 if ( 'initial' == $this->formtype ||
$this->firsttime
) {
703 if ( $this->initialiseForm() === false ) {
704 $out = $this->context
->getOutput();
705 if ( $out->getRedirect() === '' ) { // mcrundo hack redirects, don't override it
706 $this->noSuchSectionPage();
711 if ( !$this->mTitle
->getArticleID() ) {
712 Hooks
::run( 'EditFormPreloadText', [ &$this->textbox1
, &$this->mTitle
] );
714 Hooks
::run( 'EditFormInitialText', [ $this ] );
719 $this->showEditForm();
723 * @param string $rigor Same format as Title::getUserPermissionErrors()
726 protected function getEditPermissionErrors( $rigor = 'secure' ) {
727 $user = $this->context
->getUser();
728 $permErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $user, $rigor );
729 # Can this title be created?
730 if ( !$this->mTitle
->exists() ) {
731 $permErrors = array_merge(
734 $this->mTitle
->getUserPermissionsErrors( 'create', $user, $rigor ),
739 # Ignore some permissions errors when a user is just previewing/viewing diffs
741 foreach ( $permErrors as $error ) {
742 if ( ( $this->preview ||
$this->diff
)
744 $error[0] == 'blockedtext' ||
745 $error[0] == 'autoblockedtext' ||
746 $error[0] == 'systemblockedtext'
752 $permErrors = wfArrayDiff2( $permErrors, $remove );
758 * Display a permissions error page, like OutputPage::showPermissionsErrorPage(),
759 * but with the following differences:
760 * - If redlink=1, the user will be redirected to the page
761 * - If there is content to display or the error occurs while either saving,
762 * previewing or showing the difference, it will be a
763 * "View source for ..." page displaying the source code after the error message.
766 * @param array $permErrors Array of permissions errors, as returned by
767 * Title::getUserPermissionsErrors().
768 * @throws PermissionsError
770 protected function displayPermissionsError( array $permErrors ) {
771 $out = $this->context
->getOutput();
772 if ( $this->context
->getRequest()->getBool( 'redlink' ) ) {
773 // The edit page was reached via a red link.
774 // Redirect to the article page and let them click the edit tab if
775 // they really want a permission error.
776 $out->redirect( $this->mTitle
->getFullURL() );
780 $content = $this->getContentObject();
782 # Use the normal message if there's nothing to display
783 if ( $this->firsttime
&& ( !$content ||
$content->isEmpty() ) ) {
784 $action = $this->mTitle
->exists() ?
'edit' :
785 ( $this->mTitle
->isTalkPage() ?
'createtalk' : 'createpage' );
786 throw new PermissionsError( $action, $permErrors );
789 $this->displayViewSourcePage(
791 $out->formatPermissionsErrorMessage( $permErrors, 'edit' )
796 * Display a read-only View Source page
797 * @param Content $content
798 * @param string $errorMessage additional wikitext error message to display
800 protected function displayViewSourcePage( Content
$content, $errorMessage = '' ) {
801 $out = $this->context
->getOutput();
802 Hooks
::run( 'EditPage::showReadOnlyForm:initial', [ $this, &$out ] );
804 $out->setRobotPolicy( 'noindex,nofollow' );
805 $out->setPageTitle( $this->context
->msg(
807 $this->getContextTitle()->getPrefixedText()
809 $out->addBacklinkSubtitle( $this->getContextTitle() );
810 $out->addHTML( $this->editFormPageTop
);
811 $out->addHTML( $this->editFormTextTop
);
813 if ( $errorMessage !== '' ) {
814 $out->addWikiTextAsInterface( $errorMessage );
815 $out->addHTML( "<hr />\n" );
818 # If the user made changes, preserve them when showing the markup
819 # (This happens when a user is blocked during edit, for instance)
820 if ( !$this->firsttime
) {
821 $text = $this->textbox1
;
822 $out->addWikiMsg( 'viewyourtext' );
825 $text = $this->toEditText( $content );
826 } catch ( MWException
$e ) {
827 # Serialize using the default format if the content model is not supported
828 # (e.g. for an old revision with a different model)
829 $text = $content->serialize();
831 $out->addWikiMsg( 'viewsourcetext' );
834 $out->addHTML( $this->editFormTextBeforeContent
);
835 $this->showTextbox( $text, 'wpTextbox1', [ 'readonly' ] );
836 $out->addHTML( $this->editFormTextAfterContent
);
838 $out->addHTML( $this->makeTemplatesOnThisPageList( $this->getTemplates() ) );
840 $out->addModules( 'mediawiki.action.edit.collapsibleFooter' );
842 $out->addHTML( $this->editFormTextBottom
);
843 if ( $this->mTitle
->exists() ) {
844 $out->returnToMain( null, $this->mTitle
);
849 * Should we show a preview when the edit form is first shown?
853 protected function previewOnOpen() {
854 $config = $this->context
->getConfig();
855 $previewOnOpenNamespaces = $config->get( 'PreviewOnOpenNamespaces' );
856 $request = $this->context
->getRequest();
857 if ( $config->get( 'RawHtml' ) ) {
858 // If raw HTML is enabled, disable preview on open
859 // since it has to be posted with a token for
863 if ( $request->getVal( 'preview' ) == 'yes' ) {
864 // Explicit override from request
866 } elseif ( $request->getVal( 'preview' ) == 'no' ) {
867 // Explicit override from request
869 } elseif ( $this->section
== 'new' ) {
870 // Nothing *to* preview for new sections
872 } elseif ( ( $request->getVal( 'preload' ) !== null ||
$this->mTitle
->exists() )
873 && $this->context
->getUser()->getOption( 'previewonfirst' )
875 // Standard preference behavior
877 } elseif ( !$this->mTitle
->exists()
878 && isset( $previewOnOpenNamespaces[$this->mTitle
->getNamespace()] )
879 && $previewOnOpenNamespaces[$this->mTitle
->getNamespace()]
881 // Categories are special
889 * Checks whether the user entered a skin name in uppercase,
890 * e.g. "User:Example/Monobook.css" instead of "monobook.css"
894 protected function isWrongCaseUserConfigPage() {
895 if ( $this->mTitle
->isUserConfigPage() ) {
896 $name = $this->mTitle
->getSkinFromConfigSubpage();
897 $skins = array_merge(
898 array_keys( Skin
::getSkinNames() ),
901 return !in_array( $name, $skins )
902 && in_array( strtolower( $name ), $skins );
909 * Returns whether section editing is supported for the current page.
910 * Subclasses may override this to replace the default behavior, which is
911 * to check ContentHandler::supportsSections.
913 * @return bool True if this edit page supports sections, false otherwise.
915 protected function isSectionEditSupported() {
916 $contentHandler = ContentHandler
::getForTitle( $this->mTitle
);
917 return $contentHandler->supportsSections();
921 * This function collects the form data and uses it to populate various member variables.
922 * @param WebRequest &$request
923 * @throws ErrorPageError
925 public function importFormData( &$request ) {
926 # Section edit can come from either the form or a link
927 $this->section
= $request->getVal( 'wpSection', $request->getVal( 'section' ) );
929 if ( $this->section
!== null && $this->section
!== '' && !$this->isSectionEditSupported() ) {
930 throw new ErrorPageError( 'sectioneditnotsupported-title', 'sectioneditnotsupported-text' );
933 $this->isNew
= !$this->mTitle
->exists() ||
$this->section
== 'new';
935 if ( $request->wasPosted() ) {
936 # These fields need to be checked for encoding.
937 # Also remove trailing whitespace, but don't remove _initial_
938 # whitespace from the text boxes. This may be significant formatting.
939 $this->textbox1
= rtrim( $request->getText( 'wpTextbox1' ) );
940 if ( !$request->getCheck( 'wpTextbox2' ) ) {
941 // Skip this if wpTextbox2 has input, it indicates that we came
942 // from a conflict page with raw page text, not a custom form
943 // modified by subclasses
944 $textbox1 = $this->importContentFormData( $request );
945 if ( $textbox1 !== null ) {
946 $this->textbox1
= $textbox1;
950 $this->unicodeCheck
= $request->getText( 'wpUnicodeCheck' );
952 $this->summary
= $request->getText( 'wpSummary' );
954 # If the summary consists of a heading, e.g. '==Foobar==', extract the title from the
955 # header syntax, e.g. 'Foobar'. This is mainly an issue when we are using wpSummary for
957 $this->summary
= preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->summary
);
959 # Treat sectiontitle the same way as summary.
960 # Note that wpSectionTitle is not yet a part of the actual edit form, as wpSummary is
961 # currently doing double duty as both edit summary and section title. Right now this
962 # is just to allow API edits to work around this limitation, but this should be
963 # incorporated into the actual edit form when EditPage is rewritten (T20654, T28312).
964 $this->sectiontitle
= $request->getText( 'wpSectionTitle' );
965 $this->sectiontitle
= preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->sectiontitle
);
967 $this->edittime
= $request->getVal( 'wpEdittime' );
968 $this->editRevId
= $request->getIntOrNull( 'editRevId' );
969 $this->starttime
= $request->getVal( 'wpStarttime' );
971 $undidRev = $request->getInt( 'wpUndidRevision' );
973 $this->undidRev
= $undidRev;
976 $this->scrolltop
= $request->getIntOrNull( 'wpScrolltop' );
978 if ( $this->textbox1
=== '' && $request->getVal( 'wpTextbox1' ) === null ) {
979 // wpTextbox1 field is missing, possibly due to being "too big"
980 // according to some filter rules such as Suhosin's setting for
981 // suhosin.request.max_value_length (d'oh)
982 $this->incompleteForm
= true;
984 // If we receive the last parameter of the request, we can fairly
985 // claim the POST request has not been truncated.
986 $this->incompleteForm
= !$request->getVal( 'wpUltimateParam' );
988 if ( $this->incompleteForm
) {
989 # If the form is incomplete, force to preview.
990 wfDebug( __METHOD__
. ": Form data appears to be incomplete\n" );
991 wfDebug( "POST DATA: " . var_export( $request->getPostValues(), true ) . "\n" );
992 $this->preview
= true;
994 $this->preview
= $request->getCheck( 'wpPreview' );
995 $this->diff
= $request->getCheck( 'wpDiff' );
997 // Remember whether a save was requested, so we can indicate
998 // if we forced preview due to session failure.
999 $this->mTriedSave
= !$this->preview
;
1001 if ( $this->tokenOk( $request ) ) {
1002 # Some browsers will not report any submit button
1003 # if the user hits enter in the comment box.
1004 # The unmarked state will be assumed to be a save,
1005 # if the form seems otherwise complete.
1006 wfDebug( __METHOD__
. ": Passed token check.\n" );
1007 } elseif ( $this->diff
) {
1008 # Failed token check, but only requested "Show Changes".
1009 wfDebug( __METHOD__
. ": Failed token check; Show Changes requested.\n" );
1011 # Page might be a hack attempt posted from
1012 # an external site. Preview instead of saving.
1013 wfDebug( __METHOD__
. ": Failed token check; forcing preview\n" );
1014 $this->preview
= true;
1017 $this->save
= !$this->preview
&& !$this->diff
;
1018 if ( !preg_match( '/^\d{14}$/', $this->edittime
) ) {
1019 $this->edittime
= null;
1022 if ( !preg_match( '/^\d{14}$/', $this->starttime
) ) {
1023 $this->starttime
= null;
1026 $this->recreate
= $request->getCheck( 'wpRecreate' );
1028 $this->minoredit
= $request->getCheck( 'wpMinoredit' );
1029 $this->watchthis
= $request->getCheck( 'wpWatchthis' );
1031 $user = $this->context
->getUser();
1032 # Don't force edit summaries when a user is editing their own user or talk page
1033 if ( ( $this->mTitle
->mNamespace
== NS_USER ||
$this->mTitle
->mNamespace
== NS_USER_TALK
)
1034 && $this->mTitle
->getText() == $user->getName()
1036 $this->allowBlankSummary
= true;
1038 $this->allowBlankSummary
= $request->getBool( 'wpIgnoreBlankSummary' )
1039 ||
!$user->getOption( 'forceeditsummary' );
1042 $this->autoSumm
= $request->getText( 'wpAutoSummary' );
1044 $this->allowBlankArticle
= $request->getBool( 'wpIgnoreBlankArticle' );
1045 $this->allowSelfRedirect
= $request->getBool( 'wpIgnoreSelfRedirect' );
1047 $changeTags = $request->getVal( 'wpChangeTags' );
1048 if ( is_null( $changeTags ) ||
$changeTags === '' ) {
1049 $this->changeTags
= [];
1051 $this->changeTags
= array_filter( array_map( 'trim', explode( ',',
1055 # Not a posted form? Start with nothing.
1056 wfDebug( __METHOD__
. ": Not a posted form.\n" );
1057 $this->textbox1
= '';
1058 $this->summary
= '';
1059 $this->sectiontitle
= '';
1060 $this->edittime
= '';
1061 $this->editRevId
= null;
1062 $this->starttime
= wfTimestampNow();
1063 $this->edit
= false;
1064 $this->preview
= false;
1065 $this->save
= false;
1066 $this->diff
= false;
1067 $this->minoredit
= false;
1068 // Watch may be overridden by request parameters
1069 $this->watchthis
= $request->getBool( 'watchthis', false );
1070 $this->recreate
= false;
1072 // When creating a new section, we can preload a section title by passing it as the
1073 // preloadtitle parameter in the URL (T15100)
1074 if ( $this->section
== 'new' && $request->getVal( 'preloadtitle' ) ) {
1075 $this->sectiontitle
= $request->getVal( 'preloadtitle' );
1076 // Once wpSummary isn't being use for setting section titles, we should delete this.
1077 $this->summary
= $request->getVal( 'preloadtitle' );
1078 } elseif ( $this->section
!= 'new' && $request->getVal( 'summary' ) !== '' ) {
1079 $this->summary
= $request->getText( 'summary' );
1080 if ( $this->summary
!== '' ) {
1081 $this->hasPresetSummary
= true;
1085 if ( $request->getVal( 'minor' ) ) {
1086 $this->minoredit
= true;
1090 $this->oldid
= $request->getInt( 'oldid' );
1091 $this->parentRevId
= $request->getInt( 'parentRevId' );
1093 $this->bot
= $request->getBool( 'bot', true );
1094 $this->nosummary
= $request->getBool( 'nosummary' );
1096 // May be overridden by revision.
1097 $this->contentModel
= $request->getText( 'model', $this->contentModel
);
1098 // May be overridden by revision.
1099 $this->contentFormat
= $request->getText( 'format', $this->contentFormat
);
1102 $handler = ContentHandler
::getForModelID( $this->contentModel
);
1103 } catch ( MWUnknownContentModelException
$e ) {
1104 throw new ErrorPageError(
1105 'editpage-invalidcontentmodel-title',
1106 'editpage-invalidcontentmodel-text',
1107 [ wfEscapeWikiText( $this->contentModel
) ]
1111 if ( !$handler->isSupportedFormat( $this->contentFormat
) ) {
1112 throw new ErrorPageError(
1113 'editpage-notsupportedcontentformat-title',
1114 'editpage-notsupportedcontentformat-text',
1116 wfEscapeWikiText( $this->contentFormat
),
1117 wfEscapeWikiText( ContentHandler
::getLocalizedName( $this->contentModel
) )
1123 * @todo Check if the desired model is allowed in this namespace, and if
1124 * a transition from the page's current model to the new model is
1128 $this->editintro
= $request->getText( 'editintro',
1129 // Custom edit intro for new sections
1130 $this->section
=== 'new' ?
'MediaWiki:addsection-editintro' : '' );
1132 // Allow extensions to modify form data
1133 Hooks
::run( 'EditPage::importFormData', [ $this, $request ] );
1137 * Subpage overridable method for extracting the page content data from the
1138 * posted form to be placed in $this->textbox1, if using customized input
1139 * this method should be overridden and return the page text that will be used
1140 * for saving, preview parsing and so on...
1142 * @param WebRequest &$request
1143 * @return string|null
1145 protected function importContentFormData( &$request ) {
1146 return; // Don't do anything, EditPage already extracted wpTextbox1
1150 * Initialise form fields in the object
1151 * Called on the first invocation, e.g. when a user clicks an edit link
1152 * @return bool If the requested section is valid
1154 public function initialiseForm() {
1155 $this->edittime
= $this->page
->getTimestamp();
1156 $this->editRevId
= $this->page
->getLatest();
1158 $content = $this->getContentObject( false ); # TODO: track content object?!
1159 if ( $content === false ) {
1162 $this->textbox1
= $this->toEditText( $content );
1164 $user = $this->context
->getUser();
1165 // activate checkboxes if user wants them to be always active
1166 # Sort out the "watch" checkbox
1167 if ( $user->getOption( 'watchdefault' ) ) {
1169 $this->watchthis
= true;
1170 } elseif ( $user->getOption( 'watchcreations' ) && !$this->mTitle
->exists() ) {
1172 $this->watchthis
= true;
1173 } elseif ( $user->isWatched( $this->mTitle
) ) {
1175 $this->watchthis
= true;
1177 if ( $user->getOption( 'minordefault' ) && !$this->isNew
) {
1178 $this->minoredit
= true;
1180 if ( $this->textbox1
=== false ) {
1187 * @param Content|null $def_content The default value to return
1189 * @return Content|null Content on success, $def_content for invalid sections
1193 protected function getContentObject( $def_content = null ) {
1196 $user = $this->context
->getUser();
1197 $request = $this->context
->getRequest();
1198 // For message page not locally set, use the i18n message.
1199 // For other non-existent articles, use preload text if any.
1200 if ( !$this->mTitle
->exists() ||
$this->section
== 'new' ) {
1201 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
&& $this->section
!= 'new' ) {
1202 # If this is a system message, get the default text.
1203 $msg = $this->mTitle
->getDefaultMessageText();
1205 $content = $this->toEditContent( $msg );
1207 if ( $content === false ) {
1208 # If requested, preload some text.
1209 $preload = $request->getVal( 'preload',
1210 // Custom preload text for new sections
1211 $this->section
=== 'new' ?
'MediaWiki:addsection-preload' : '' );
1212 $params = $request->getArray( 'preloadparams', [] );
1214 $content = $this->getPreloadedContent( $preload, $params );
1216 // For existing pages, get text based on "undo" or section parameters.
1218 if ( $this->section
!= '' ) {
1219 // Get section edit text (returns $def_text for invalid sections)
1220 $orig = $this->getOriginalContent( $user );
1221 $content = $orig ?
$orig->getSection( $this->section
) : null;
1224 $content = $def_content;
1227 $undoafter = $request->getInt( 'undoafter' );
1228 $undo = $request->getInt( 'undo' );
1230 if ( $undo > 0 && $undoafter > 0 ) {
1231 $undorev = Revision
::newFromId( $undo );
1232 $oldrev = Revision
::newFromId( $undoafter );
1235 # Sanity check, make sure it's the right page,
1236 # the revisions exist and they were not deleted.
1237 # Otherwise, $content will be left as-is.
1238 if ( !is_null( $undorev ) && !is_null( $oldrev ) &&
1239 !$undorev->isDeleted( Revision
::DELETED_TEXT
) &&
1240 !$oldrev->isDeleted( Revision
::DELETED_TEXT
)
1242 if ( WikiPage
::hasDifferencesOutsideMainSlot( $undorev, $oldrev )
1243 ||
!$this->isSupportedContentModel( $oldrev->getContentModel() )
1245 // Hack for undo while EditPage can't handle multi-slot editing
1246 $this->context
->getOutput()->redirect( $this->mTitle
->getFullURL( [
1247 'action' => 'mcrundo',
1249 'undoafter' => $undoafter,
1253 $content = $this->page
->getUndoContent( $undorev, $oldrev );
1255 if ( $content === false ) {
1256 # Warn the user that something went wrong
1257 $undoMsg = 'failure';
1261 if ( $undoMsg === null ) {
1262 $oldContent = $this->page
->getContent( Revision
::RAW
);
1263 $popts = ParserOptions
::newFromUserAndLang(
1264 $user, MediaWikiServices
::getInstance()->getContentLanguage() );
1265 $newContent = $content->preSaveTransform( $this->mTitle
, $user, $popts );
1266 if ( $newContent->getModel() !== $oldContent->getModel() ) {
1267 // The undo may change content
1268 // model if its reverting the top
1269 // edit. This can result in
1270 // mismatched content model/format.
1271 $this->contentModel
= $newContent->getModel();
1272 $this->contentFormat
= $oldrev->getContentFormat();
1275 if ( $newContent->equals( $oldContent ) ) {
1276 # Tell the user that the undo results in no change,
1277 # i.e. the revisions were already undone.
1278 $undoMsg = 'nochange';
1281 # Inform the user of our success and set an automatic edit summary
1282 $undoMsg = 'success';
1284 # If we just undid one rev, use an autosummary
1285 $firstrev = $oldrev->getNext();
1286 if ( $firstrev && $firstrev->getId() == $undo ) {
1287 $userText = $undorev->getUserText();
1288 if ( $userText === '' ) {
1289 $undoSummary = $this->context
->msg(
1290 'undo-summary-username-hidden',
1292 )->inContentLanguage()->text();
1294 $undoSummary = $this->context
->msg(
1298 )->inContentLanguage()->text();
1300 if ( $this->summary
=== '' ) {
1301 $this->summary
= $undoSummary;
1303 $this->summary
= $undoSummary . $this->context
->msg( 'colon-separator' )
1304 ->inContentLanguage()->text() . $this->summary
;
1306 $this->undidRev
= $undo;
1308 $this->formtype
= 'diff';
1312 // Failed basic sanity checks.
1313 // Older revisions may have been removed since the link
1314 // was created, or we may simply have got bogus input.
1318 $out = $this->context
->getOutput();
1319 // Messages: undo-success, undo-failure, undo-main-slot-only, undo-norev,
1321 $class = ( $undoMsg == 'success' ?
'' : 'error ' ) . "mw-undo-{$undoMsg}";
1322 $this->editFormPageTop
.= Html
::rawElement(
1323 'div', [ 'class' => $class ],
1324 $out->parseAsInterface(
1325 $this->context
->msg( 'undo-' . $undoMsg )->plain()
1330 if ( $content === false ) {
1331 // Hack for restoring old revisions while EditPage
1332 // can't handle multi-slot editing.
1334 $curRevision = $this->page
->getRevision();
1335 $oldRevision = $this->mArticle
->getRevisionFetched();
1339 && $curRevision->getId() !== $oldRevision->getId()
1340 && ( WikiPage
::hasDifferencesOutsideMainSlot( $oldRevision, $curRevision )
1341 ||
!$this->isSupportedContentModel( $oldRevision->getContentModel() ) )
1343 $this->context
->getOutput()->redirect(
1344 $this->mTitle
->getFullURL(
1346 'action' => 'mcrrestore',
1347 'restore' => $oldRevision->getId(),
1356 if ( $content === false ) {
1357 $content = $this->getOriginalContent( $user );
1366 * Get the content of the wanted revision, without section extraction.
1368 * The result of this function can be used to compare user's input with
1369 * section replaced in its context (using WikiPage::replaceSectionAtRev())
1370 * to the original text of the edit.
1372 * This differs from Article::getContent() that when a missing revision is
1373 * encountered the result will be null and not the
1374 * 'missing-revision' message.
1377 * @param User $user The user to get the revision for
1378 * @return Content|null
1380 private function getOriginalContent( User
$user ) {
1381 if ( $this->section
== 'new' ) {
1382 return $this->getCurrentContent();
1384 $revision = $this->mArticle
->getRevisionFetched();
1385 if ( $revision === null ) {
1386 $handler = ContentHandler
::getForModelID( $this->contentModel
);
1387 return $handler->makeEmptyContent();
1389 $content = $revision->getContent( Revision
::FOR_THIS_USER
, $user );
1394 * Get the edit's parent revision ID
1396 * The "parent" revision is the ancestor that should be recorded in this
1397 * page's revision history. It is either the revision ID of the in-memory
1398 * article content, or in the case of a 3-way merge in order to rebase
1399 * across a recoverable edit conflict, the ID of the newer revision to
1400 * which we have rebased this page.
1403 * @return int Revision ID
1405 public function getParentRevId() {
1406 if ( $this->parentRevId
) {
1407 return $this->parentRevId
;
1409 return $this->mArticle
->getRevIdFetched();
1414 * Get the current content of the page. This is basically similar to
1415 * WikiPage::getContent( Revision::RAW ) except that when the page doesn't exist an empty
1416 * content object is returned instead of null.
1421 protected function getCurrentContent() {
1422 $rev = $this->page
->getRevision();
1423 $content = $rev ?
$rev->getContent( Revision
::RAW
) : null;
1425 if ( $content === false ||
$content === null ) {
1426 $handler = ContentHandler
::getForModelID( $this->contentModel
);
1427 return $handler->makeEmptyContent();
1428 } elseif ( !$this->undidRev
) {
1429 // Content models should always be the same since we error
1430 // out if they are different before this point (in ->edit()).
1431 // The exception being, during an undo, the current revision might
1432 // differ from the prior revision.
1433 $logger = LoggerFactory
::getInstance( 'editpage' );
1434 if ( $this->contentModel
!== $rev->getContentModel() ) {
1435 $logger->warning( "Overriding content model from current edit {prev} to {new}", [
1436 'prev' => $this->contentModel
,
1437 'new' => $rev->getContentModel(),
1438 'title' => $this->getTitle()->getPrefixedDBkey(),
1439 'method' => __METHOD__
1441 $this->contentModel
= $rev->getContentModel();
1444 // Given that the content models should match, the current selected
1445 // format should be supported.
1446 if ( !$content->isSupportedFormat( $this->contentFormat
) ) {
1447 $logger->warning( "Current revision content format unsupported. Overriding {prev} to {new}", [
1449 'prev' => $this->contentFormat
,
1450 'new' => $rev->getContentFormat(),
1451 'title' => $this->getTitle()->getPrefixedDBkey(),
1452 'method' => __METHOD__
1454 $this->contentFormat
= $rev->getContentFormat();
1461 * Use this method before edit() to preload some content into the edit box
1463 * @param Content $content
1467 public function setPreloadedContent( Content
$content ) {
1468 $this->mPreloadContent
= $content;
1472 * Get the contents to be preloaded into the box, either set by
1473 * an earlier setPreloadText() or by loading the given page.
1475 * @param string $preload Representing the title to preload from.
1476 * @param array $params Parameters to use (interface-message style) in the preloaded text
1482 protected function getPreloadedContent( $preload, $params = [] ) {
1483 if ( !empty( $this->mPreloadContent
) ) {
1484 return $this->mPreloadContent
;
1487 $handler = ContentHandler
::getForModelID( $this->contentModel
);
1489 if ( $preload === '' ) {
1490 return $handler->makeEmptyContent();
1493 $user = $this->context
->getUser();
1494 $title = Title
::newFromText( $preload );
1495 # Check for existence to avoid getting MediaWiki:Noarticletext
1496 if ( $title === null ||
!$title->exists() ||
!$title->userCan( 'read', $user ) ) {
1497 // TODO: somehow show a warning to the user!
1498 return $handler->makeEmptyContent();
1501 $page = WikiPage
::factory( $title );
1502 if ( $page->isRedirect() ) {
1503 $title = $page->getRedirectTarget();
1505 if ( $title === null ||
!$title->exists() ||
!$title->userCan( 'read', $user ) ) {
1506 // TODO: somehow show a warning to the user!
1507 return $handler->makeEmptyContent();
1509 $page = WikiPage
::factory( $title );
1512 $parserOptions = ParserOptions
::newFromUser( $user );
1513 $content = $page->getContent( Revision
::RAW
);
1516 // TODO: somehow show a warning to the user!
1517 return $handler->makeEmptyContent();
1520 if ( $content->getModel() !== $handler->getModelID() ) {
1521 $converted = $content->convert( $handler->getModelID() );
1523 if ( !$converted ) {
1524 // TODO: somehow show a warning to the user!
1525 wfDebug( "Attempt to preload incompatible content: " .
1526 "can't convert " . $content->getModel() .
1527 " to " . $handler->getModelID() );
1529 return $handler->makeEmptyContent();
1532 $content = $converted;
1535 return $content->preloadTransform( $title, $parserOptions, $params );
1539 * Make sure the form isn't faking a user's credentials.
1541 * @param WebRequest &$request
1545 public function tokenOk( &$request ) {
1546 $token = $request->getVal( 'wpEditToken' );
1547 $user = $this->context
->getUser();
1548 $this->mTokenOk
= $user->matchEditToken( $token );
1549 $this->mTokenOkExceptSuffix
= $user->matchEditTokenNoSuffix( $token );
1550 return $this->mTokenOk
;
1554 * Sets post-edit cookie indicating the user just saved a particular revision.
1556 * This uses a temporary cookie for each revision ID so separate saves will never
1557 * interfere with each other.
1559 * Article::view deletes the cookie on server-side after the redirect and
1560 * converts the value to the global JavaScript variable wgPostEdit.
1562 * If the variable were set on the server, it would be cached, which is unwanted
1563 * since the post-edit state should only apply to the load right after the save.
1565 * @param int $statusValue The status value (to check for new article status)
1567 protected function setPostEditCookie( $statusValue ) {
1568 $revisionId = $this->page
->getLatest();
1569 $postEditKey = self
::POST_EDIT_COOKIE_KEY_PREFIX
. $revisionId;
1572 if ( $statusValue == self
::AS_SUCCESS_NEW_ARTICLE
) {
1574 } elseif ( $this->oldid
) {
1578 $response = $this->context
->getRequest()->response();
1579 $response->setCookie( $postEditKey, $val, time() + self
::POST_EDIT_COOKIE_DURATION
);
1583 * Attempt submission
1584 * @param array|bool &$resultDetails See docs for $result in internalAttemptSave
1585 * @throws UserBlockedError|ReadOnlyError|ThrottledError|PermissionsError
1586 * @return Status The resulting status object.
1588 public function attemptSave( &$resultDetails = false ) {
1589 // TODO: MCR: treat $this->minoredit like $this->bot and check isAllowed( 'minoredit' )!
1590 // Also, add $this->autopatrol like $this->bot and check isAllowed( 'autopatrol' )!
1591 // This is needed since PageUpdater no longer checks these rights!
1593 // Allow bots to exempt some edits from bot flagging
1594 $bot = $this->context
->getUser()->isAllowed( 'bot' ) && $this->bot
;
1595 $status = $this->internalAttemptSave( $resultDetails, $bot );
1597 Hooks
::run( 'EditPage::attemptSave:after', [ $this, $status, $resultDetails ] );
1603 * Log when a page was successfully saved after the edit conflict view
1605 private function incrementResolvedConflicts() {
1606 if ( $this->context
->getRequest()->getText( 'mode' ) !== 'conflict' ) {
1610 $this->getEditConflictHelper()->incrementResolvedStats();
1614 * Handle status, such as after attempt save
1616 * @param Status $status
1617 * @param array|bool $resultDetails
1619 * @throws ErrorPageError
1620 * @return bool False, if output is done, true if rest of the form should be displayed
1622 private function handleStatus( Status
$status, $resultDetails ) {
1624 * @todo FIXME: once the interface for internalAttemptSave() is made
1625 * nicer, this should use the message in $status
1627 if ( $status->value
== self
::AS_SUCCESS_UPDATE
1628 ||
$status->value
== self
::AS_SUCCESS_NEW_ARTICLE
1630 $this->incrementResolvedConflicts();
1632 $this->didSave
= true;
1633 if ( !$resultDetails['nullEdit'] ) {
1634 $this->setPostEditCookie( $status->value
);
1638 $out = $this->context
->getOutput();
1640 // "wpExtraQueryRedirect" is a hidden input to modify
1641 // after save URL and is not used by actual edit form
1642 $request = $this->context
->getRequest();
1643 $extraQueryRedirect = $request->getVal( 'wpExtraQueryRedirect' );
1645 switch ( $status->value
) {
1646 case self
::AS_HOOK_ERROR_EXPECTED
:
1647 case self
::AS_CONTENT_TOO_BIG
:
1648 case self
::AS_ARTICLE_WAS_DELETED
:
1649 case self
::AS_CONFLICT_DETECTED
:
1650 case self
::AS_SUMMARY_NEEDED
:
1651 case self
::AS_TEXTBOX_EMPTY
:
1652 case self
::AS_MAX_ARTICLE_SIZE_EXCEEDED
:
1654 case self
::AS_BLANK_ARTICLE
:
1655 case self
::AS_SELF_REDIRECT
:
1658 case self
::AS_HOOK_ERROR
:
1661 case self
::AS_CANNOT_USE_CUSTOM_MODEL
:
1662 case self
::AS_PARSE_ERROR
:
1663 case self
::AS_UNICODE_NOT_SUPPORTED
:
1664 $out->wrapWikiTextAsInterface( 'error', $status->getWikiText() );
1667 case self
::AS_SUCCESS_NEW_ARTICLE
:
1668 $query = $resultDetails['redirect'] ?
'redirect=no' : '';
1669 if ( $extraQueryRedirect ) {
1670 if ( $query === '' ) {
1671 $query = $extraQueryRedirect;
1673 $query = $query . '&' . $extraQueryRedirect;
1676 $anchor = $resultDetails['sectionanchor'] ??
'';
1677 $out->redirect( $this->mTitle
->getFullURL( $query ) . $anchor );
1680 case self
::AS_SUCCESS_UPDATE
:
1682 $sectionanchor = $resultDetails['sectionanchor'];
1684 // Give extensions a chance to modify URL query on update
1686 'ArticleUpdateBeforeRedirect',
1687 [ $this->mArticle
, &$sectionanchor, &$extraQuery ]
1690 if ( $resultDetails['redirect'] ) {
1691 if ( $extraQuery == '' ) {
1692 $extraQuery = 'redirect=no';
1694 $extraQuery = 'redirect=no&' . $extraQuery;
1697 if ( $extraQueryRedirect ) {
1698 if ( $extraQuery === '' ) {
1699 $extraQuery = $extraQueryRedirect;
1701 $extraQuery = $extraQuery . '&' . $extraQueryRedirect;
1705 $out->redirect( $this->mTitle
->getFullURL( $extraQuery ) . $sectionanchor );
1708 case self
::AS_SPAM_ERROR
:
1709 $this->spamPageWithContent( $resultDetails['spam'] );
1712 case self
::AS_BLOCKED_PAGE_FOR_USER
:
1713 throw new UserBlockedError( $this->context
->getUser()->getBlock() );
1715 case self
::AS_IMAGE_REDIRECT_ANON
:
1716 case self
::AS_IMAGE_REDIRECT_LOGGED
:
1717 throw new PermissionsError( 'upload' );
1719 case self
::AS_READ_ONLY_PAGE_ANON
:
1720 case self
::AS_READ_ONLY_PAGE_LOGGED
:
1721 throw new PermissionsError( 'edit' );
1723 case self
::AS_READ_ONLY_PAGE
:
1724 throw new ReadOnlyError
;
1726 case self
::AS_RATE_LIMITED
:
1727 throw new ThrottledError();
1729 case self
::AS_NO_CREATE_PERMISSION
:
1730 $permission = $this->mTitle
->isTalkPage() ?
'createtalk' : 'createpage';
1731 throw new PermissionsError( $permission );
1733 case self
::AS_NO_CHANGE_CONTENT_MODEL
:
1734 throw new PermissionsError( 'editcontentmodel' );
1737 // We don't recognize $status->value. The only way that can happen
1738 // is if an extension hook aborted from inside ArticleSave.
1739 // Render the status object into $this->hookError
1740 // FIXME this sucks, we should just use the Status object throughout
1741 $this->hookError
= '<div class="error">' . "\n" . $status->getWikiText() .
1748 * Run hooks that can filter edits just before they get saved.
1750 * @param Content $content The Content to filter.
1751 * @param Status $status For reporting the outcome to the caller
1752 * @param User $user The user performing the edit
1756 protected function runPostMergeFilters( Content
$content, Status
$status, User
$user ) {
1757 // Run old style post-section-merge edit filter
1758 if ( $this->hookError
!= '' ) {
1759 # ...or the hook could be expecting us to produce an error
1760 $status->fatal( 'hookaborted' );
1761 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1765 // Run new style post-section-merge edit filter
1766 if ( !Hooks
::run( 'EditFilterMergedContent',
1767 [ $this->context
, $content, $status, $this->summary
,
1768 $user, $this->minoredit
] )
1770 # Error messages etc. could be handled within the hook...
1771 if ( $status->isGood() ) {
1772 $status->fatal( 'hookaborted' );
1773 // Not setting $this->hookError here is a hack to allow the hook
1774 // to cause a return to the edit page without $this->hookError
1775 // being set. This is used by ConfirmEdit to display a captcha
1776 // without any error message cruft.
1778 $this->hookError
= $this->formatStatusErrors( $status );
1780 // Use the existing $status->value if the hook set it
1781 if ( !$status->value
) {
1782 $status->value
= self
::AS_HOOK_ERROR
;
1785 } elseif ( !$status->isOK() ) {
1786 # ...or the hook could be expecting us to produce an error
1787 // FIXME this sucks, we should just use the Status object throughout
1788 $this->hookError
= $this->formatStatusErrors( $status );
1789 $status->fatal( 'hookaborted' );
1790 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1798 * Wrap status errors in an errorbox for increased visibility
1800 * @param Status $status
1801 * @return string Wikitext
1803 private function formatStatusErrors( Status
$status ) {
1804 $errmsg = $status->getWikiText(
1807 $this->context
->getLanguage()
1810 <div class="errorbox">
1818 * Return the summary to be used for a new section.
1820 * @param string $sectionanchor Set to the section anchor text
1823 private function newSectionSummary( &$sectionanchor = null ) {
1826 if ( $this->sectiontitle
!== '' ) {
1827 $sectionanchor = $this->guessSectionName( $this->sectiontitle
);
1828 // If no edit summary was specified, create one automatically from the section
1829 // title and have it link to the new section. Otherwise, respect the summary as
1831 if ( $this->summary
=== '' ) {
1832 $cleanSectionTitle = $wgParser->stripSectionName( $this->sectiontitle
);
1833 return $this->context
->msg( 'newsectionsummary' )
1834 ->plaintextParams( $cleanSectionTitle )->inContentLanguage()->text();
1836 } elseif ( $this->summary
!== '' ) {
1837 $sectionanchor = $this->guessSectionName( $this->summary
);
1838 # This is a new section, so create a link to the new section
1839 # in the revision summary.
1840 $cleanSummary = $wgParser->stripSectionName( $this->summary
);
1841 return $this->context
->msg( 'newsectionsummary' )
1842 ->plaintextParams( $cleanSummary )->inContentLanguage()->text();
1844 return $this->summary
;
1848 * Attempt submission (no UI)
1850 * @param array &$result Array to add statuses to, currently with the
1852 * - spam (string): Spam string from content if any spam is detected by
1854 * - sectionanchor (string): Section anchor for a section save.
1855 * - nullEdit (bool): Set if doEditContent is OK. True if null edit,
1857 * - redirect (bool): Set if doEditContent is OK. True if resulting
1858 * revision is a redirect.
1859 * @param bool $bot True if edit is being made under the bot right.
1861 * @return Status Status object, possibly with a message, but always with
1862 * one of the AS_* constants in $status->value,
1864 * @todo FIXME: This interface is TERRIBLE, but hard to get rid of due to
1865 * various error display idiosyncrasies. There are also lots of cases
1866 * where error metadata is set in the object and retrieved later instead
1867 * of being returned, e.g. AS_CONTENT_TOO_BIG and
1868 * AS_BLOCKED_PAGE_FOR_USER. All that stuff needs to be cleaned up some
1871 public function internalAttemptSave( &$result, $bot = false ) {
1872 $status = Status
::newGood();
1873 $user = $this->context
->getUser();
1875 if ( !Hooks
::run( 'EditPage::attemptSave', [ $this ] ) ) {
1876 wfDebug( "Hook 'EditPage::attemptSave' aborted article saving\n" );
1877 $status->fatal( 'hookaborted' );
1878 $status->value
= self
::AS_HOOK_ERROR
;
1882 if ( $this->unicodeCheck
!== self
::UNICODE_CHECK
) {
1883 $status->fatal( 'unicode-support-fail' );
1884 $status->value
= self
::AS_UNICODE_NOT_SUPPORTED
;
1888 $request = $this->context
->getRequest();
1889 $spam = $request->getText( 'wpAntispam' );
1890 if ( $spam !== '' ) {
1895 $this->mTitle
->getPrefixedText() .
1896 '" submitted bogus field "' .
1900 $status->fatal( 'spamprotectionmatch', false );
1901 $status->value
= self
::AS_SPAM_ERROR
;
1906 # Construct Content object
1907 $textbox_content = $this->toEditContent( $this->textbox1
);
1908 } catch ( MWContentSerializationException
$ex ) {
1910 'content-failed-to-parse',
1911 $this->contentModel
,
1912 $this->contentFormat
,
1915 $status->value
= self
::AS_PARSE_ERROR
;
1919 # Check image redirect
1920 if ( $this->mTitle
->getNamespace() == NS_FILE
&&
1921 $textbox_content->isRedirect() &&
1922 !$user->isAllowed( 'upload' )
1924 $code = $user->isAnon() ? self
::AS_IMAGE_REDIRECT_ANON
: self
::AS_IMAGE_REDIRECT_LOGGED
;
1925 $status->setResult( false, $code );
1931 $match = self
::matchSummarySpamRegex( $this->summary
);
1932 if ( $match === false && $this->section
== 'new' ) {
1933 # $wgSpamRegex is enforced on this new heading/summary because, unlike
1934 # regular summaries, it is added to the actual wikitext.
1935 if ( $this->sectiontitle
!== '' ) {
1936 # This branch is taken when the API is used with the 'sectiontitle' parameter.
1937 $match = self
::matchSpamRegex( $this->sectiontitle
);
1939 # This branch is taken when the "Add Topic" user interface is used, or the API
1940 # is used with the 'summary' parameter.
1941 $match = self
::matchSpamRegex( $this->summary
);
1944 if ( $match === false ) {
1945 $match = self
::matchSpamRegex( $this->textbox1
);
1947 if ( $match !== false ) {
1948 $result['spam'] = $match;
1949 $ip = $request->getIP();
1950 $pdbk = $this->mTitle
->getPrefixedDBkey();
1951 $match = str_replace( "\n", '', $match );
1952 wfDebugLog( 'SpamRegex', "$ip spam regex hit [[$pdbk]]: \"$match\"" );
1953 $status->fatal( 'spamprotectionmatch', $match );
1954 $status->value
= self
::AS_SPAM_ERROR
;
1959 [ $this, $this->textbox1
, $this->section
, &$this->hookError
, $this->summary
] )
1961 # Error messages etc. could be handled within the hook...
1962 $status->fatal( 'hookaborted' );
1963 $status->value
= self
::AS_HOOK_ERROR
;
1965 } elseif ( $this->hookError
!= '' ) {
1966 # ...or the hook could be expecting us to produce an error
1967 $status->fatal( 'hookaborted' );
1968 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1972 if ( $user->isBlockedFrom( $this->mTitle
) ) {
1973 // Auto-block user's IP if the account was "hard" blocked
1974 if ( !wfReadOnly() ) {
1975 $user->spreadAnyEditBlock();
1977 # Check block state against master, thus 'false'.
1978 $status->setResult( false, self
::AS_BLOCKED_PAGE_FOR_USER
);
1982 $this->contentLength
= strlen( $this->textbox1
);
1983 $config = $this->context
->getConfig();
1984 $maxArticleSize = $config->get( 'MaxArticleSize' );
1985 if ( $this->contentLength
> $maxArticleSize * 1024 ) {
1986 // Error will be displayed by showEditForm()
1987 $this->tooBig
= true;
1988 $status->setResult( false, self
::AS_CONTENT_TOO_BIG
);
1992 if ( !$user->isAllowed( 'edit' ) ) {
1993 if ( $user->isAnon() ) {
1994 $status->setResult( false, self
::AS_READ_ONLY_PAGE_ANON
);
1997 $status->fatal( 'readonlytext' );
1998 $status->value
= self
::AS_READ_ONLY_PAGE_LOGGED
;
2003 $changingContentModel = false;
2004 if ( $this->contentModel
!== $this->mTitle
->getContentModel() ) {
2005 if ( !$config->get( 'ContentHandlerUseDB' ) ) {
2006 $status->fatal( 'editpage-cannot-use-custom-model' );
2007 $status->value
= self
::AS_CANNOT_USE_CUSTOM_MODEL
;
2009 } elseif ( !$user->isAllowed( 'editcontentmodel' ) ) {
2010 $status->setResult( false, self
::AS_NO_CHANGE_CONTENT_MODEL
);
2013 // Make sure the user can edit the page under the new content model too
2014 $titleWithNewContentModel = clone $this->mTitle
;
2015 $titleWithNewContentModel->setContentModel( $this->contentModel
);
2016 if ( !$titleWithNewContentModel->userCan( 'editcontentmodel', $user )
2017 ||
!$titleWithNewContentModel->userCan( 'edit', $user )
2019 $status->setResult( false, self
::AS_NO_CHANGE_CONTENT_MODEL
);
2023 $changingContentModel = true;
2024 $oldContentModel = $this->mTitle
->getContentModel();
2027 if ( $this->changeTags
) {
2028 $changeTagsStatus = ChangeTags
::canAddTagsAccompanyingChange(
2029 $this->changeTags
, $user );
2030 if ( !$changeTagsStatus->isOK() ) {
2031 $changeTagsStatus->value
= self
::AS_CHANGE_TAG_ERROR
;
2032 return $changeTagsStatus;
2036 if ( wfReadOnly() ) {
2037 $status->fatal( 'readonlytext' );
2038 $status->value
= self
::AS_READ_ONLY_PAGE
;
2041 if ( $user->pingLimiter() ||
$user->pingLimiter( 'linkpurge', 0 )
2042 ||
( $changingContentModel && $user->pingLimiter( 'editcontentmodel' ) )
2044 $status->fatal( 'actionthrottledtext' );
2045 $status->value
= self
::AS_RATE_LIMITED
;
2049 # If the article has been deleted while editing, don't save it without
2051 if ( $this->wasDeletedSinceLastEdit() && !$this->recreate
) {
2052 $status->setResult( false, self
::AS_ARTICLE_WAS_DELETED
);
2056 # Load the page data from the master. If anything changes in the meantime,
2057 # we detect it by using page_latest like a token in a 1 try compare-and-swap.
2058 $this->page
->loadPageData( 'fromdbmaster' );
2059 $new = !$this->page
->exists();
2062 // Late check for create permission, just in case *PARANOIA*
2063 if ( !$this->mTitle
->userCan( 'create', $user ) ) {
2064 $status->fatal( 'nocreatetext' );
2065 $status->value
= self
::AS_NO_CREATE_PERMISSION
;
2066 wfDebug( __METHOD__
. ": no create permission\n" );
2070 // Don't save a new page if it's blank or if it's a MediaWiki:
2071 // message with content equivalent to default (allow empty pages
2072 // in this case to disable messages, see T52124)
2073 $defaultMessageText = $this->mTitle
->getDefaultMessageText();
2074 if ( $this->mTitle
->getNamespace() === NS_MEDIAWIKI
&& $defaultMessageText !== false ) {
2075 $defaultText = $defaultMessageText;
2080 if ( !$this->allowBlankArticle
&& $this->textbox1
=== $defaultText ) {
2081 $this->blankArticle
= true;
2082 $status->fatal( 'blankarticle' );
2083 $status->setResult( false, self
::AS_BLANK_ARTICLE
);
2087 if ( !$this->runPostMergeFilters( $textbox_content, $status, $user ) ) {
2091 $content = $textbox_content;
2093 $result['sectionanchor'] = '';
2094 if ( $this->section
== 'new' ) {
2095 if ( $this->sectiontitle
!== '' ) {
2096 // Insert the section title above the content.
2097 $content = $content->addSectionHeader( $this->sectiontitle
);
2098 } elseif ( $this->summary
!== '' ) {
2099 // Insert the section title above the content.
2100 $content = $content->addSectionHeader( $this->summary
);
2102 $this->summary
= $this->newSectionSummary( $result['sectionanchor'] );
2105 $status->value
= self
::AS_SUCCESS_NEW_ARTICLE
;
2109 # Article exists. Check for edit conflict.
2111 $this->page
->clear(); # Force reload of dates, etc.
2112 $timestamp = $this->page
->getTimestamp();
2113 $latest = $this->page
->getLatest();
2115 wfDebug( "timestamp: {$timestamp}, edittime: {$this->edittime}\n" );
2117 // An edit conflict is detected if the current revision is different from the
2118 // revision that was current when editing was initiated on the client.
2119 // This is checked based on the timestamp and revision ID.
2120 // TODO: the timestamp based check can probably go away now.
2121 if ( $timestamp != $this->edittime
2122 ||
( $this->editRevId
!== null && $this->editRevId
!= $latest )
2124 $this->isConflict
= true;
2125 if ( $this->section
== 'new' ) {
2126 if ( $this->page
->getUserText() == $user->getName() &&
2127 $this->page
->getComment() == $this->newSectionSummary()
2129 // Probably a duplicate submission of a new comment.
2130 // This can happen when CDN resends a request after
2131 // a timeout but the first one actually went through.
2133 . ": duplicate new section submission; trigger edit conflict!\n" );
2135 // New comment; suppress conflict.
2136 $this->isConflict
= false;
2137 wfDebug( __METHOD__
. ": conflict suppressed; new section\n" );
2139 } elseif ( $this->section
== ''
2140 && Revision
::userWasLastToEdit(
2141 DB_MASTER
, $this->mTitle
->getArticleID(),
2142 $user->getId(), $this->edittime
2145 # Suppress edit conflict with self, except for section edits where merging is required.
2146 wfDebug( __METHOD__
. ": Suppressing edit conflict, same user.\n" );
2147 $this->isConflict
= false;
2151 // If sectiontitle is set, use it, otherwise use the summary as the section title.
2152 if ( $this->sectiontitle
!== '' ) {
2153 $sectionTitle = $this->sectiontitle
;
2155 $sectionTitle = $this->summary
;
2160 if ( $this->isConflict
) {
2162 . ": conflict! getting section '{$this->section}' for time '{$this->edittime}'"
2163 . " (id '{$this->editRevId}') (article time '{$timestamp}')\n" );
2164 // @TODO: replaceSectionAtRev() with base ID (not prior current) for ?oldid=X case
2165 // ...or disable section editing for non-current revisions (not exposed anyway).
2166 if ( $this->editRevId
!== null ) {
2167 $content = $this->page
->replaceSectionAtRev(
2174 $content = $this->page
->replaceSectionContent(
2182 wfDebug( __METHOD__
. ": getting section '{$this->section}'\n" );
2183 $content = $this->page
->replaceSectionContent(
2190 if ( is_null( $content ) ) {
2191 wfDebug( __METHOD__
. ": activating conflict; section replace failed.\n" );
2192 $this->isConflict
= true;
2193 $content = $textbox_content; // do not try to merge here!
2194 } elseif ( $this->isConflict
) {
2196 if ( $this->mergeChangesIntoContent( $content ) ) {
2197 // Successful merge! Maybe we should tell the user the good news?
2198 $this->isConflict
= false;
2199 wfDebug( __METHOD__
. ": Suppressing edit conflict, successful merge.\n" );
2201 $this->section
= '';
2202 $this->textbox1
= ContentHandler
::getContentText( $content );
2203 wfDebug( __METHOD__
. ": Keeping edit conflict, failed merge.\n" );
2207 if ( $this->isConflict
) {
2208 $status->setResult( false, self
::AS_CONFLICT_DETECTED
);
2212 if ( !$this->runPostMergeFilters( $content, $status, $user ) ) {
2216 if ( $this->section
== 'new' ) {
2217 // Handle the user preference to force summaries here
2218 if ( !$this->allowBlankSummary
&& trim( $this->summary
) == '' ) {
2219 $this->missingSummary
= true;
2220 $status->fatal( 'missingsummary' ); // or 'missingcommentheader' if $section == 'new'. Blegh
2221 $status->value
= self
::AS_SUMMARY_NEEDED
;
2225 // Do not allow the user to post an empty comment
2226 if ( $this->textbox1
== '' ) {
2227 $this->missingComment
= true;
2228 $status->fatal( 'missingcommenttext' );
2229 $status->value
= self
::AS_TEXTBOX_EMPTY
;
2232 } elseif ( !$this->allowBlankSummary
2233 && !$content->equals( $this->getOriginalContent( $user ) )
2234 && !$content->isRedirect()
2235 && md5( $this->summary
) == $this->autoSumm
2237 $this->missingSummary
= true;
2238 $status->fatal( 'missingsummary' );
2239 $status->value
= self
::AS_SUMMARY_NEEDED
;
2244 $sectionanchor = '';
2245 if ( $this->section
== 'new' ) {
2246 $this->summary
= $this->newSectionSummary( $sectionanchor );
2247 } elseif ( $this->section
!= '' ) {
2248 # Try to get a section anchor from the section source, redirect
2249 # to edited section if header found.
2250 # XXX: Might be better to integrate this into Article::replaceSectionAtRev
2251 # for duplicate heading checking and maybe parsing.
2252 $hasmatch = preg_match( "/^ *([=]{1,6})(.*?)(\\1) *\\n/i", $this->textbox1
, $matches );
2253 # We can't deal with anchors, includes, html etc in the header for now,
2254 # headline would need to be parsed to improve this.
2255 if ( $hasmatch && strlen( $matches[2] ) > 0 ) {
2256 $sectionanchor = $this->guessSectionName( $matches[2] );
2259 $result['sectionanchor'] = $sectionanchor;
2261 // Save errors may fall down to the edit form, but we've now
2262 // merged the section into full text. Clear the section field
2263 // so that later submission of conflict forms won't try to
2264 // replace that into a duplicated mess.
2265 $this->textbox1
= $this->toEditText( $content );
2266 $this->section
= '';
2268 $status->value
= self
::AS_SUCCESS_UPDATE
;
2271 if ( !$this->allowSelfRedirect
2272 && $content->isRedirect()
2273 && $content->getRedirectTarget()->equals( $this->getTitle() )
2275 // If the page already redirects to itself, don't warn.
2276 $currentTarget = $this->getCurrentContent()->getRedirectTarget();
2277 if ( !$currentTarget ||
!$currentTarget->equals( $this->getTitle() ) ) {
2278 $this->selfRedirect
= true;
2279 $status->fatal( 'selfredirect' );
2280 $status->value
= self
::AS_SELF_REDIRECT
;
2285 // Check for length errors again now that the section is merged in
2286 $this->contentLength
= strlen( $this->toEditText( $content ) );
2287 if ( $this->contentLength
> $maxArticleSize * 1024 ) {
2288 $this->tooBig
= true;
2289 $status->setResult( false, self
::AS_MAX_ARTICLE_SIZE_EXCEEDED
);
2293 $flags = EDIT_AUTOSUMMARY |
2294 ( $new ? EDIT_NEW
: EDIT_UPDATE
) |
2295 ( ( $this->minoredit
&& !$this->isNew
) ? EDIT_MINOR
: 0 ) |
2296 ( $bot ? EDIT_FORCE_BOT
: 0 );
2298 $doEditStatus = $this->page
->doEditContent(
2304 $content->getDefaultFormat(),
2309 if ( !$doEditStatus->isOK() ) {
2310 // Failure from doEdit()
2311 // Show the edit conflict page for certain recognized errors from doEdit(),
2312 // but don't show it for errors from extension hooks
2313 $errors = $doEditStatus->getErrorsArray();
2314 if ( in_array( $errors[0][0],
2315 [ 'edit-gone-missing', 'edit-conflict', 'edit-already-exists' ] )
2317 $this->isConflict
= true;
2318 // Destroys data doEdit() put in $status->value but who cares
2319 $doEditStatus->value
= self
::AS_END
;
2321 return $doEditStatus;
2324 $result['nullEdit'] = $doEditStatus->hasMessage( 'edit-no-change' );
2325 if ( $result['nullEdit'] ) {
2326 // We don't know if it was a null edit until now, so increment here
2327 $user->pingLimiter( 'linkpurge' );
2329 $result['redirect'] = $content->isRedirect();
2331 $this->updateWatchlist();
2333 // If the content model changed, add a log entry
2334 if ( $changingContentModel ) {
2335 $this->addContentModelChangeLogEntry(
2337 $new ?
false : $oldContentModel,
2338 $this->contentModel
,
2348 * @param string|false $oldModel false if the page is being newly created
2349 * @param string $newModel
2350 * @param string $reason
2352 protected function addContentModelChangeLogEntry( User
$user, $oldModel, $newModel, $reason ) {
2353 $new = $oldModel === false;
2354 $log = new ManualLogEntry( 'contentmodel', $new ?
'new' : 'change' );
2355 $log->setPerformer( $user );
2356 $log->setTarget( $this->mTitle
);
2357 $log->setComment( $reason );
2358 $log->setParameters( [
2359 '4::oldmodel' => $oldModel,
2360 '5::newmodel' => $newModel
2362 $logid = $log->insert();
2363 $log->publish( $logid );
2367 * Register the change of watch status
2369 protected function updateWatchlist() {
2370 $user = $this->context
->getUser();
2371 if ( !$user->isLoggedIn() ) {
2375 $title = $this->mTitle
;
2376 $watch = $this->watchthis
;
2377 // Do this in its own transaction to reduce contention...
2378 DeferredUpdates
::addCallableUpdate( function () use ( $user, $title, $watch ) {
2379 if ( $watch == $user->isWatched( $title, User
::IGNORE_USER_RIGHTS
) ) {
2380 return; // nothing to change
2382 WatchAction
::doWatchOrUnwatch( $watch, $title, $user );
2387 * Attempts to do 3-way merge of edit content with a base revision
2388 * and current content, in case of edit conflict, in whichever way appropriate
2389 * for the content type.
2393 * @param Content $editContent
2397 private function mergeChangesIntoContent( &$editContent ) {
2398 $db = wfGetDB( DB_MASTER
);
2400 // This is the revision that was current at the time editing was initiated on the client,
2401 // even if the edit was based on an old revision.
2402 $baseRevision = $this->getBaseRevision();
2403 $baseContent = $baseRevision ?
$baseRevision->getContent() : null;
2405 if ( is_null( $baseContent ) ) {
2409 // The current state, we want to merge updates into it
2410 $currentRevision = Revision
::loadFromTitle( $db, $this->mTitle
);
2411 $currentContent = $currentRevision ?
$currentRevision->getContent() : null;
2413 if ( is_null( $currentContent ) ) {
2417 $handler = ContentHandler
::getForModelID( $baseContent->getModel() );
2419 $result = $handler->merge3( $baseContent, $editContent, $currentContent );
2422 $editContent = $result;
2423 // Update parentRevId to what we just merged.
2424 $this->parentRevId
= $currentRevision->getId();
2432 * Returns the revision that was current at the time editing was initiated on the client,
2433 * even if the edit was based on an old revision.
2435 * @warning this method is very poorly named. If the user opened the form with ?oldid=X,
2436 * one might think of X as the "base revision", which is NOT what this returns,
2437 * see oldid for that. One might further assume that this corresponds to the $baseRevId
2438 * parameter of WikiPage::doEditContent, which is not the case either.
2439 * getExpectedParentRevision() would perhaps be a better name.
2441 * @return Revision|null Current version when editing was initiated on the client
2443 public function getBaseRevision() {
2444 if ( !$this->mBaseRevision
) {
2445 $db = wfGetDB( DB_MASTER
);
2446 $this->mBaseRevision
= $this->editRevId
2447 ? Revision
::newFromId( $this->editRevId
, Revision
::READ_LATEST
)
2448 : Revision
::loadFromTimestamp( $db, $this->mTitle
, $this->edittime
);
2450 return $this->mBaseRevision
;
2454 * Check given input text against $wgSpamRegex, and return the text of the first match.
2456 * @param string $text
2458 * @return string|bool Matching string or false
2460 public static function matchSpamRegex( $text ) {
2461 global $wgSpamRegex;
2462 // For back compatibility, $wgSpamRegex may be a single string or an array of regexes.
2463 $regexes = (array)$wgSpamRegex;
2464 return self
::matchSpamRegexInternal( $text, $regexes );
2468 * Check given input text against $wgSummarySpamRegex, and return the text of the first match.
2470 * @param string $text
2472 * @return string|bool Matching string or false
2474 public static function matchSummarySpamRegex( $text ) {
2475 global $wgSummarySpamRegex;
2476 $regexes = (array)$wgSummarySpamRegex;
2477 return self
::matchSpamRegexInternal( $text, $regexes );
2481 * @param string $text
2482 * @param array $regexes
2483 * @return bool|string
2485 protected static function matchSpamRegexInternal( $text, $regexes ) {
2486 foreach ( $regexes as $regex ) {
2488 if ( preg_match( $regex, $text, $matches ) ) {
2495 public function setHeaders() {
2496 $out = $this->context
->getOutput();
2498 $out->addModules( 'mediawiki.action.edit' );
2499 $out->addModuleStyles( 'mediawiki.action.edit.styles' );
2500 $out->addModuleStyles( 'mediawiki.editfont.styles' );
2502 $user = $this->context
->getUser();
2504 if ( $user->getOption( 'uselivepreview' ) ) {
2505 $out->addModules( 'mediawiki.action.edit.preview' );
2508 if ( $user->getOption( 'useeditwarning' ) ) {
2509 $out->addModules( 'mediawiki.action.edit.editWarning' );
2512 # Enabled article-related sidebar, toplinks, etc.
2513 $out->setArticleRelated( true );
2515 $contextTitle = $this->getContextTitle();
2516 if ( $this->isConflict
) {
2517 $msg = 'editconflict';
2518 } elseif ( $contextTitle->exists() && $this->section
!= '' ) {
2519 $msg = $this->section
== 'new' ?
'editingcomment' : 'editingsection';
2521 $msg = $contextTitle->exists()
2522 ||
( $contextTitle->getNamespace() == NS_MEDIAWIKI
2523 && $contextTitle->getDefaultMessageText() !== false
2529 # Use the title defined by DISPLAYTITLE magic word when present
2530 # NOTE: getDisplayTitle() returns HTML while getPrefixedText() returns plain text.
2531 # setPageTitle() treats the input as wikitext, which should be safe in either case.
2532 $displayTitle = isset( $this->mParserOutput
) ?
$this->mParserOutput
->getDisplayTitle() : false;
2533 if ( $displayTitle === false ) {
2534 $displayTitle = $contextTitle->getPrefixedText();
2536 $out->setDisplayTitle( $displayTitle );
2538 $out->setPageTitle( $this->context
->msg( $msg, $displayTitle ) );
2540 $config = $this->context
->getConfig();
2542 # Transmit the name of the message to JavaScript for live preview
2543 # Keep Resources.php/mediawiki.action.edit.preview in sync with the possible keys
2544 $out->addJsConfigVars( [
2545 'wgEditMessage' => $msg,
2546 'wgAjaxEditStash' => $config->get( 'AjaxEditStash' ),
2549 // Add whether to use 'save' or 'publish' messages to JavaScript for post-edit, other
2551 $out->addJsConfigVars(
2552 'wgEditSubmitButtonLabelPublish',
2553 $config->get( 'EditSubmitButtonLabelPublish' )
2558 * Show all applicable editing introductions
2560 protected function showIntro() {
2561 if ( $this->suppressIntro
) {
2565 $out = $this->context
->getOutput();
2566 $namespace = $this->mTitle
->getNamespace();
2568 if ( $namespace == NS_MEDIAWIKI
) {
2569 # Show a warning if editing an interface message
2570 $out->wrapWikiMsg( "<div class='mw-editinginterface'>\n$1\n</div>", 'editinginterface' );
2571 # If this is a default message (but not css, json, or js),
2572 # show a hint that it is translatable on translatewiki.net
2574 !$this->mTitle
->hasContentModel( CONTENT_MODEL_CSS
)
2575 && !$this->mTitle
->hasContentModel( CONTENT_MODEL_JSON
)
2576 && !$this->mTitle
->hasContentModel( CONTENT_MODEL_JAVASCRIPT
)
2578 $defaultMessageText = $this->mTitle
->getDefaultMessageText();
2579 if ( $defaultMessageText !== false ) {
2580 $out->wrapWikiMsg( "<div class='mw-translateinterface'>\n$1\n</div>",
2581 'translateinterface' );
2584 } elseif ( $namespace == NS_FILE
) {
2585 # Show a hint to shared repo
2586 $file = wfFindFile( $this->mTitle
);
2587 if ( $file && !$file->isLocal() ) {
2588 $descUrl = $file->getDescriptionUrl();
2589 # there must be a description url to show a hint to shared repo
2591 if ( !$this->mTitle
->exists() ) {
2592 $out->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-create\">\n$1\n</div>", [
2593 'sharedupload-desc-create', $file->getRepo()->getDisplayName(), $descUrl
2596 $out->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-edit\">\n$1\n</div>", [
2597 'sharedupload-desc-edit', $file->getRepo()->getDisplayName(), $descUrl
2604 # Show a warning message when someone creates/edits a user (talk) page but the user does not exist
2605 # Show log extract when the user is currently blocked
2606 if ( $namespace == NS_USER ||
$namespace == NS_USER_TALK
) {
2607 $username = explode( '/', $this->mTitle
->getText(), 2 )[0];
2608 $user = User
::newFromName( $username, false /* allow IP users */ );
2609 $ip = User
::isIP( $username );
2610 $block = Block
::newFromTarget( $user, $user );
2611 if ( !( $user && $user->isLoggedIn() ) && !$ip ) { # User does not exist
2612 $out->wrapWikiMsg( "<div class=\"mw-userpage-userdoesnotexist error\">\n$1\n</div>",
2613 [ 'userpage-userdoesnotexist', wfEscapeWikiText( $username ) ] );
2615 !is_null( $block ) &&
2616 $block->getType() != Block
::TYPE_AUTO
&&
2617 ( $block->isSitewide() ||
$user->isBlockedFrom( $this->mTitle
) )
2619 // Show log extract if the user is sitewide blocked or is partially
2620 // blocked and not allowed to edit their user page or user talk page
2621 LogEventsList
::showLogExtract(
2624 MWNamespace
::getCanonicalName( NS_USER
) . ':' . $block->getTarget(),
2628 'showIfEmpty' => false,
2630 'blocked-notice-logextract',
2631 $user->getName() # Support GENDER in notice
2637 # Try to add a custom edit intro, or use the standard one if this is not possible.
2638 if ( !$this->showCustomIntro() && !$this->mTitle
->exists() ) {
2639 $helpLink = wfExpandUrl( Skin
::makeInternalOrExternalUrl(
2640 $this->context
->msg( 'helppage' )->inContentLanguage()->text()
2642 if ( $this->context
->getUser()->isLoggedIn() ) {
2644 // Suppress the external link icon, consider the help url an internal one
2645 "<div class=\"mw-newarticletext plainlinks\">\n$1\n</div>",
2653 // Suppress the external link icon, consider the help url an internal one
2654 "<div class=\"mw-newarticletextanon plainlinks\">\n$1\n</div>",
2656 'newarticletextanon',
2662 # Give a notice if the user is editing a deleted/moved page...
2663 if ( !$this->mTitle
->exists() ) {
2664 $dbr = wfGetDB( DB_REPLICA
);
2666 LogEventsList
::showLogExtract( $out, [ 'delete', 'move' ], $this->mTitle
,
2670 'conds' => [ 'log_action != ' . $dbr->addQuotes( 'revision' ) ],
2671 'showIfEmpty' => false,
2672 'msgKey' => [ 'recreate-moveddeleted-warn' ]
2679 * Attempt to show a custom editing introduction, if supplied
2683 protected function showCustomIntro() {
2684 if ( $this->editintro
) {
2685 $title = Title
::newFromText( $this->editintro
);
2686 if ( $title instanceof Title
&& $title->exists() && $title->userCan( 'read' ) ) {
2687 // Added using template syntax, to take <noinclude>'s into account.
2688 $this->context
->getOutput()->addWikiTextAsContent(
2689 '<div class="mw-editintro">{{:' . $title->getFullText() . '}}</div>',
2700 * Gets an editable textual representation of $content.
2701 * The textual representation can be turned by into a Content object by the
2702 * toEditContent() method.
2704 * If $content is null or false or a string, $content is returned unchanged.
2706 * If the given Content object is not of a type that can be edited using
2707 * the text base EditPage, an exception will be raised. Set
2708 * $this->allowNonTextContent to true to allow editing of non-textual
2711 * @param Content|null|bool|string $content
2712 * @return string The editable text form of the content.
2714 * @throws MWException If $content is not an instance of TextContent and
2715 * $this->allowNonTextContent is not true.
2717 protected function toEditText( $content ) {
2718 if ( $content === null ||
$content === false ||
is_string( $content ) ) {
2722 if ( !$this->isSupportedContentModel( $content->getModel() ) ) {
2723 throw new MWException( 'This content model is not supported: ' . $content->getModel() );
2726 return $content->serialize( $this->contentFormat
);
2730 * Turns the given text into a Content object by unserializing it.
2732 * If the resulting Content object is not of a type that can be edited using
2733 * the text base EditPage, an exception will be raised. Set
2734 * $this->allowNonTextContent to true to allow editing of non-textual
2737 * @param string|null|bool $text Text to unserialize
2738 * @return Content|bool|null The content object created from $text. If $text was false
2739 * or null, then false or null will be returned instead.
2741 * @throws MWException If unserializing the text results in a Content
2742 * object that is not an instance of TextContent and
2743 * $this->allowNonTextContent is not true.
2745 protected function toEditContent( $text ) {
2746 if ( $text === false ||
$text === null ) {
2750 $content = ContentHandler
::makeContent( $text, $this->getTitle(),
2751 $this->contentModel
, $this->contentFormat
);
2753 if ( !$this->isSupportedContentModel( $content->getModel() ) ) {
2754 throw new MWException( 'This content model is not supported: ' . $content->getModel() );
2761 * Send the edit form and related headers to OutputPage
2762 * @param callable|null $formCallback That takes an OutputPage parameter; will be called
2763 * during form output near the top, for captchas and the like.
2765 * The $formCallback parameter is deprecated since MediaWiki 1.25. Please
2766 * use the EditPage::showEditForm:fields hook instead.
2768 public function showEditForm( $formCallback = null ) {
2769 # need to parse the preview early so that we know which templates are used,
2770 # otherwise users with "show preview after edit box" will get a blank list
2771 # we parse this near the beginning so that setHeaders can do the title
2772 # setting work instead of leaving it in getPreviewText
2773 $previewOutput = '';
2774 if ( $this->formtype
== 'preview' ) {
2775 $previewOutput = $this->getPreviewText();
2778 $out = $this->context
->getOutput();
2780 // Avoid PHP 7.1 warning of passing $this by reference
2782 Hooks
::run( 'EditPage::showEditForm:initial', [ &$editPage, &$out ] );
2784 $this->setHeaders();
2786 $this->addTalkPageText();
2787 $this->addEditNotices();
2789 if ( !$this->isConflict
&&
2790 $this->section
!= '' &&
2791 !$this->isSectionEditSupported() ) {
2792 // We use $this->section to much before this and getVal('wgSection') directly in other places
2793 // at this point we can't reset $this->section to '' to fallback to non-section editing.
2794 // Someone is welcome to try refactoring though
2795 $out->showErrorPage( 'sectioneditnotsupported-title', 'sectioneditnotsupported-text' );
2799 $this->showHeader();
2801 $out->addHTML( $this->editFormPageTop
);
2803 $user = $this->context
->getUser();
2804 if ( $user->getOption( 'previewontop' ) ) {
2805 $this->displayPreviewArea( $previewOutput, true );
2808 $out->addHTML( $this->editFormTextTop
);
2810 if ( $this->wasDeletedSinceLastEdit() ) {
2811 if ( $this->formtype
!== 'save' ) {
2812 $out->wrapWikiMsg( "<div class='error mw-deleted-while-editing'>\n$1\n</div>",
2813 'deletedwhileediting' );
2817 // @todo add EditForm plugin interface and use it here!
2818 // search for textarea1 and textarea2, and allow EditForm to override all uses.
2819 $out->addHTML( Html
::openElement(
2822 'class' => 'mw-editform',
2823 'id' => self
::EDITFORM_ID
,
2824 'name' => self
::EDITFORM_ID
,
2826 'action' => $this->getActionURL( $this->getContextTitle() ),
2827 'enctype' => 'multipart/form-data'
2831 if ( is_callable( $formCallback ) ) {
2832 wfWarn( 'The $formCallback parameter to ' . __METHOD__
. 'is deprecated' );
2833 call_user_func_array( $formCallback, [ &$out ] );
2836 // Add a check for Unicode support
2837 $out->addHTML( Html
::hidden( 'wpUnicodeCheck', self
::UNICODE_CHECK
) );
2839 // Add an empty field to trip up spambots
2841 Xml
::openElement( 'div', [ 'id' => 'antispam-container', 'style' => 'display: none;' ] )
2844 [ 'for' => 'wpAntispam' ],
2845 $this->context
->msg( 'simpleantispam-label' )->parse()
2851 'name' => 'wpAntispam',
2852 'id' => 'wpAntispam',
2856 . Xml
::closeElement( 'div' )
2859 // Avoid PHP 7.1 warning of passing $this by reference
2861 Hooks
::run( 'EditPage::showEditForm:fields', [ &$editPage, &$out ] );
2863 // Put these up at the top to ensure they aren't lost on early form submission
2864 $this->showFormBeforeText();
2866 if ( $this->wasDeletedSinceLastEdit() && 'save' == $this->formtype
) {
2867 $username = $this->lastDelete
->user_name
;
2868 $comment = CommentStore
::getStore()
2869 ->getComment( 'log_comment', $this->lastDelete
)->text
;
2871 // It is better to not parse the comment at all than to have templates expanded in the middle
2872 // TODO: can the checkLabel be moved outside of the div so that wrapWikiMsg could be used?
2873 $key = $comment === ''
2874 ?
'confirmrecreate-noreason'
2875 : 'confirmrecreate';
2877 '<div class="mw-confirm-recreate">' .
2878 $this->context
->msg( $key, $username, "<nowiki>$comment</nowiki>" )->parse() .
2879 Xml
::checkLabel( $this->context
->msg( 'recreate' )->text(), 'wpRecreate', 'wpRecreate', false,
2880 [ 'title' => Linker
::titleAttrib( 'recreate' ), 'tabindex' => 1, 'id' => 'wpRecreate' ]
2886 # When the summary is hidden, also hide them on preview/show changes
2887 if ( $this->nosummary
) {
2888 $out->addHTML( Html
::hidden( 'nosummary', true ) );
2891 # If a blank edit summary was previously provided, and the appropriate
2892 # user preference is active, pass a hidden tag as wpIgnoreBlankSummary. This will stop the
2893 # user being bounced back more than once in the event that a summary
2896 # For a bit more sophisticated detection of blank summaries, hash the
2897 # automatic one and pass that in the hidden field wpAutoSummary.
2898 if ( $this->missingSummary ||
( $this->section
== 'new' && $this->nosummary
) ) {
2899 $out->addHTML( Html
::hidden( 'wpIgnoreBlankSummary', true ) );
2902 if ( $this->undidRev
) {
2903 $out->addHTML( Html
::hidden( 'wpUndidRevision', $this->undidRev
) );
2906 if ( $this->selfRedirect
) {
2907 $out->addHTML( Html
::hidden( 'wpIgnoreSelfRedirect', true ) );
2910 if ( $this->hasPresetSummary
) {
2911 // If a summary has been preset using &summary= we don't want to prompt for
2912 // a different summary. Only prompt for a summary if the summary is blanked.
2914 $this->autoSumm
= md5( '' );
2917 $autosumm = $this->autoSumm
!== '' ?
$this->autoSumm
: md5( $this->summary
);
2918 $out->addHTML( Html
::hidden( 'wpAutoSummary', $autosumm ) );
2920 $out->addHTML( Html
::hidden( 'oldid', $this->oldid
) );
2921 $out->addHTML( Html
::hidden( 'parentRevId', $this->getParentRevId() ) );
2923 $out->addHTML( Html
::hidden( 'format', $this->contentFormat
) );
2924 $out->addHTML( Html
::hidden( 'model', $this->contentModel
) );
2928 if ( $this->section
== 'new' ) {
2929 $this->showSummaryInput( true, $this->summary
);
2930 $out->addHTML( $this->getSummaryPreview( true, $this->summary
) );
2933 $out->addHTML( $this->editFormTextBeforeContent
);
2934 if ( $this->isConflict
) {
2935 // In an edit conflict, we turn textbox2 into the user's text,
2936 // and textbox1 into the stored version
2937 $this->textbox2
= $this->textbox1
;
2939 $content = $this->getCurrentContent();
2940 $this->textbox1
= $this->toEditText( $content );
2942 $editConflictHelper = $this->getEditConflictHelper();
2943 $editConflictHelper->setTextboxes( $this->textbox2
, $this->textbox1
);
2944 $editConflictHelper->setContentModel( $this->contentModel
);
2945 $editConflictHelper->setContentFormat( $this->contentFormat
);
2946 $out->addHTML( $editConflictHelper->getEditFormHtmlBeforeContent() );
2949 if ( !$this->mTitle
->isUserConfigPage() ) {
2950 $out->addHTML( self
::getEditToolbar( $this->mTitle
) );
2953 if ( $this->blankArticle
) {
2954 $out->addHTML( Html
::hidden( 'wpIgnoreBlankArticle', true ) );
2957 if ( $this->isConflict
) {
2958 // In an edit conflict bypass the overridable content form method
2959 // and fallback to the raw wpTextbox1 since editconflicts can't be
2960 // resolved between page source edits and custom ui edits using the
2962 $conflictTextBoxAttribs = [];
2963 if ( $this->wasDeletedSinceLastEdit() ) {
2964 $conflictTextBoxAttribs['style'] = 'display:none;';
2965 } elseif ( $this->isOldRev
) {
2966 $conflictTextBoxAttribs['class'] = 'mw-textarea-oldrev';
2969 $out->addHTML( $editConflictHelper->getEditConflictMainTextBox( $conflictTextBoxAttribs ) );
2970 $out->addHTML( $editConflictHelper->getEditFormHtmlAfterContent() );
2972 $this->showContentForm();
2975 $out->addHTML( $this->editFormTextAfterContent
);
2977 $this->showStandardInputs();
2979 $this->showFormAfterText();
2981 $this->showTosSummary();
2983 $this->showEditTools();
2985 $out->addHTML( $this->editFormTextAfterTools
. "\n" );
2987 $out->addHTML( $this->makeTemplatesOnThisPageList( $this->getTemplates() ) );
2989 $out->addHTML( Html
::rawElement( 'div', [ 'class' => 'hiddencats' ],
2990 Linker
::formatHiddenCategories( $this->page
->getHiddenCategories() ) ) );
2992 $out->addHTML( Html
::rawElement( 'div', [ 'class' => 'limitreport' ],
2993 self
::getPreviewLimitReport( $this->mParserOutput
) ) );
2995 $out->addModules( 'mediawiki.action.edit.collapsibleFooter' );
2997 if ( $this->isConflict
) {
2999 $this->showConflict();
3000 } catch ( MWContentSerializationException
$ex ) {
3001 // this can't really happen, but be nice if it does.
3002 $msg = $this->context
->msg(
3003 'content-failed-to-parse',
3004 $this->contentModel
,
3005 $this->contentFormat
,
3008 $out->wrapWikiTextAsInterface( 'error', $msg->plain() );
3012 // Set a hidden field so JS knows what edit form mode we are in
3013 if ( $this->isConflict
) {
3015 } elseif ( $this->preview
) {
3017 } elseif ( $this->diff
) {
3022 $out->addHTML( Html
::hidden( 'mode', $mode, [ 'id' => 'mw-edit-mode' ] ) );
3024 // Marker for detecting truncated form data. This must be the last
3025 // parameter sent in order to be of use, so do not move me.
3026 $out->addHTML( Html
::hidden( 'wpUltimateParam', true ) );
3027 $out->addHTML( $this->editFormTextBottom
. "\n</form>\n" );
3029 if ( !$user->getOption( 'previewontop' ) ) {
3030 $this->displayPreviewArea( $previewOutput, false );
3035 * Wrapper around TemplatesOnThisPageFormatter to make
3036 * a "templates on this page" list.
3038 * @param Title[] $templates
3039 * @return string HTML
3041 public function makeTemplatesOnThisPageList( array $templates ) {
3042 $templateListFormatter = new TemplatesOnThisPageFormatter(
3043 $this->context
, MediaWikiServices
::getInstance()->getLinkRenderer()
3046 // preview if preview, else section if section, else false
3048 if ( $this->preview
) {
3050 } elseif ( $this->section
!= '' ) {
3054 return Html
::rawElement( 'div', [ 'class' => 'templatesUsed' ],
3055 $templateListFormatter->format( $templates, $type )
3060 * Extract the section title from current section text, if any.
3062 * @param string $text
3063 * @return string|bool String or false
3065 public static function extractSectionTitle( $text ) {
3066 preg_match( "/^(=+)(.+)\\1\\s*(\n|$)/i", $text, $matches );
3067 if ( !empty( $matches[2] ) ) {
3069 return $wgParser->stripSectionName( trim( $matches[2] ) );
3075 protected function showHeader() {
3076 $out = $this->context
->getOutput();
3077 $user = $this->context
->getUser();
3078 if ( $this->isConflict
) {
3079 $this->addExplainConflictHeader( $out );
3080 $this->editRevId
= $this->page
->getLatest();
3082 if ( $this->section
!= '' && $this->section
!= 'new' ) {
3083 if ( !$this->summary
&& !$this->preview
&& !$this->diff
) {
3084 $sectionTitle = self
::extractSectionTitle( $this->textbox1
); // FIXME: use Content object
3085 if ( $sectionTitle !== false ) {
3086 $this->summary
= "/* $sectionTitle */ ";
3091 $buttonLabel = $this->context
->msg( $this->getSubmitButtonLabel() )->text();
3093 if ( $this->missingComment
) {
3094 $out->wrapWikiMsg( "<div id='mw-missingcommenttext'>\n$1\n</div>", 'missingcommenttext' );
3097 if ( $this->missingSummary
&& $this->section
!= 'new' ) {
3099 "<div id='mw-missingsummary'>\n$1\n</div>",
3100 [ 'missingsummary', $buttonLabel ]
3104 if ( $this->missingSummary
&& $this->section
== 'new' ) {
3106 "<div id='mw-missingcommentheader'>\n$1\n</div>",
3107 [ 'missingcommentheader', $buttonLabel ]
3111 if ( $this->blankArticle
) {
3113 "<div id='mw-blankarticle'>\n$1\n</div>",
3114 [ 'blankarticle', $buttonLabel ]
3118 if ( $this->selfRedirect
) {
3120 "<div id='mw-selfredirect'>\n$1\n</div>",
3121 [ 'selfredirect', $buttonLabel ]
3125 if ( $this->hookError
!== '' ) {
3126 $out->addWikiTextAsInterface( $this->hookError
);
3129 if ( $this->section
!= 'new' ) {
3130 $revision = $this->mArticle
->getRevisionFetched();
3132 // Let sysop know that this will make private content public if saved
3134 if ( !$revision->userCan( Revision
::DELETED_TEXT
, $user ) ) {
3136 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
3137 'rev-deleted-text-permission'
3139 } elseif ( $revision->isDeleted( Revision
::DELETED_TEXT
) ) {
3141 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
3142 'rev-deleted-text-view'
3146 if ( !$revision->isCurrent() ) {
3147 $this->mArticle
->setOldSubtitle( $revision->getId() );
3149 Html
::warningBox( "\n$1\n" ),
3152 $this->isOldRev
= true;
3154 } elseif ( $this->mTitle
->exists() ) {
3155 // Something went wrong
3157 $out->wrapWikiMsg( "<div class='errorbox'>\n$1\n</div>\n",
3158 [ 'missing-revision', $this->oldid
] );
3163 if ( wfReadOnly() ) {
3165 "<div id=\"mw-read-only-warning\">\n$1\n</div>",
3166 [ 'readonlywarning', wfReadOnlyReason() ]
3168 } elseif ( $user->isAnon() ) {
3169 if ( $this->formtype
!= 'preview' ) {
3170 $returntoquery = array_diff_key(
3171 $this->context
->getRequest()->getValues(),
3172 [ 'title' => true, 'returnto' => true, 'returntoquery' => true ]
3175 "<div id='mw-anon-edit-warning' class='warningbox'>\n$1\n</div>",
3176 [ 'anoneditwarning',
3178 SpecialPage
::getTitleFor( 'Userlogin' )->getFullURL( [
3179 'returnto' => $this->getTitle()->getPrefixedDBkey(),
3180 'returntoquery' => wfArrayToCgi( $returntoquery ),
3183 SpecialPage
::getTitleFor( 'CreateAccount' )->getFullURL( [
3184 'returnto' => $this->getTitle()->getPrefixedDBkey(),
3185 'returntoquery' => wfArrayToCgi( $returntoquery ),
3190 $out->wrapWikiMsg( "<div id=\"mw-anon-preview-warning\" class=\"warningbox\">\n$1</div>",
3191 'anonpreviewwarning'
3195 if ( $this->mTitle
->isUserConfigPage() ) {
3196 # Check the skin exists
3197 if ( $this->isWrongCaseUserConfigPage() ) {
3199 "<div class='error' id='mw-userinvalidconfigtitle'>\n$1\n</div>",
3200 [ 'userinvalidconfigtitle', $this->mTitle
->getSkinFromConfigSubpage() ]
3203 if ( $this->getTitle()->isSubpageOf( $user->getUserPage() ) ) {
3204 $isUserCssConfig = $this->mTitle
->isUserCssConfigPage();
3205 $isUserJsonConfig = $this->mTitle
->isUserJsonConfigPage();
3206 $isUserJsConfig = $this->mTitle
->isUserJsConfigPage();
3208 $warning = $isUserCssConfig
3210 : ( $isUserJsonConfig ?
'userjsonispublic' : 'userjsispublic' );
3212 $out->wrapWikiMsg( '<div class="mw-userconfigpublic">$1</div>', $warning );
3214 if ( $this->formtype
!== 'preview' ) {
3215 $config = $this->context
->getConfig();
3216 if ( $isUserCssConfig && $config->get( 'AllowUserCss' ) ) {
3218 "<div id='mw-usercssyoucanpreview'>\n$1\n</div>",
3219 [ 'usercssyoucanpreview' ]
3221 } elseif ( $isUserJsonConfig /* No comparable 'AllowUserJson' */ ) {
3223 "<div id='mw-userjsonyoucanpreview'>\n$1\n</div>",
3224 [ 'userjsonyoucanpreview' ]
3226 } elseif ( $isUserJsConfig && $config->get( 'AllowUserJs' ) ) {
3228 "<div id='mw-userjsyoucanpreview'>\n$1\n</div>",
3229 [ 'userjsyoucanpreview' ]
3237 $this->addPageProtectionWarningHeaders();
3239 $this->addLongPageWarningHeader();
3241 # Add header copyright warning
3242 $this->showHeaderCopyrightWarning();
3246 * Helper function for summary input functions, which returns the necessary
3247 * attributes for the input.
3249 * @param array|null $inputAttrs Array of attrs to use on the input
3252 private function getSummaryInputAttributes( array $inputAttrs = null ) {
3253 $conf = $this->context
->getConfig();
3254 $oldCommentSchema = $conf->get( 'CommentTableSchemaMigrationStage' ) === MIGRATION_OLD
;
3255 // HTML maxlength uses "UTF-16 code units", which means that characters outside BMP
3256 // (e.g. emojis) count for two each. This limit is overridden in JS to instead count
3257 // Unicode codepoints (or 255 UTF-8 bytes for old schema).
3258 return ( is_array( $inputAttrs ) ?
$inputAttrs : [] ) +
[
3259 'id' => 'wpSummary',
3260 'name' => 'wpSummary',
3261 'maxlength' => $oldCommentSchema ?
200 : CommentStore
::COMMENT_CHARACTER_LIMIT
,
3264 'spellcheck' => 'true',
3269 * Builds a standard summary input with a label.
3271 * @param string $summary The value of the summary input
3272 * @param string|null $labelText The html to place inside the label
3273 * @param array|null $inputAttrs Array of attrs to use on the input
3275 * @return OOUI\FieldLayout OOUI FieldLayout with Label and Input
3277 function getSummaryInputWidget( $summary = "", $labelText = null, $inputAttrs = null ) {
3278 $inputAttrs = OOUI\Element
::configFromHtmlAttributes(
3279 $this->getSummaryInputAttributes( $inputAttrs )
3282 'title' => Linker
::titleAttrib( 'summary' ),
3283 'accessKey' => Linker
::accesskey( 'summary' ),
3286 // For compatibility with old scripts and extensions, we want the legacy 'id' on the `<input>`
3287 $inputAttrs['inputId'] = $inputAttrs['id'];
3288 $inputAttrs['id'] = 'wpSummaryWidget';
3290 return new OOUI\
FieldLayout(
3291 new OOUI\
TextInputWidget( [
3292 'value' => $summary,
3293 'infusable' => true,
3296 'label' => new OOUI\
HtmlSnippet( $labelText ),
3298 'id' => 'wpSummaryLabel',
3299 'classes' => [ $this->missingSummary ?
'mw-summarymissed' : 'mw-summary' ],
3305 * @param bool $isSubjectPreview True if this is the section subject/title
3306 * up top, or false if this is the comment summary
3307 * down below the textarea
3308 * @param string $summary The text of the summary to display
3310 protected function showSummaryInput( $isSubjectPreview, $summary = "" ) {
3311 # Add a class if 'missingsummary' is triggered to allow styling of the summary line
3312 $summaryClass = $this->missingSummary ?
'mw-summarymissed' : 'mw-summary';
3313 if ( $isSubjectPreview ) {
3314 if ( $this->nosummary
) {
3318 if ( !$this->mShowSummaryField
) {
3323 $labelText = $this->context
->msg( $isSubjectPreview ?
'subject' : 'summary' )->parse();
3324 $this->context
->getOutput()->addHTML( $this->getSummaryInputWidget(
3327 [ 'class' => $summaryClass ]
3332 * @param bool $isSubjectPreview True if this is the section subject/title
3333 * up top, or false if this is the comment summary
3334 * down below the textarea
3335 * @param string $summary The text of the summary to display
3338 protected function getSummaryPreview( $isSubjectPreview, $summary = "" ) {
3339 // avoid spaces in preview, gets always trimmed on save
3340 $summary = trim( $summary );
3341 if ( !$summary ||
( !$this->preview
&& !$this->diff
) ) {
3347 if ( $isSubjectPreview ) {
3348 $summary = $this->context
->msg( 'newsectionsummary' )
3349 ->rawParams( $wgParser->stripSectionName( $summary ) )
3350 ->inContentLanguage()->text();
3353 $message = $isSubjectPreview ?
'subject-preview' : 'summary-preview';
3355 $summary = $this->context
->msg( $message )->parse()
3356 . Linker
::commentBlock( $summary, $this->mTitle
, $isSubjectPreview );
3357 return Xml
::tags( 'div', [ 'class' => 'mw-summary-preview' ], $summary );
3360 protected function showFormBeforeText() {
3361 $out = $this->context
->getOutput();
3362 $out->addHTML( Html
::hidden( 'wpSection', $this->section
) );
3363 $out->addHTML( Html
::hidden( 'wpStarttime', $this->starttime
) );
3364 $out->addHTML( Html
::hidden( 'wpEdittime', $this->edittime
) );
3365 $out->addHTML( Html
::hidden( 'editRevId', $this->editRevId
) );
3366 $out->addHTML( Html
::hidden( 'wpScrolltop', $this->scrolltop
, [ 'id' => 'wpScrolltop' ] ) );
3369 protected function showFormAfterText() {
3371 * To make it harder for someone to slip a user a page
3372 * which submits an edit form to the wiki without their
3373 * knowledge, a random token is associated with the login
3374 * session. If it's not passed back with the submission,
3375 * we won't save the page, or render user JavaScript and
3378 * For anon editors, who may not have a session, we just
3379 * include the constant suffix to prevent editing from
3380 * broken text-mangling proxies.
3382 $this->context
->getOutput()->addHTML(
3384 Html
::hidden( "wpEditToken", $this->context
->getUser()->getEditToken() ) .
3390 * Subpage overridable method for printing the form for page content editing
3391 * By default this simply outputs wpTextbox1
3392 * Subclasses can override this to provide a custom UI for editing;
3393 * be it a form, or simply wpTextbox1 with a modified content that will be
3394 * reverse modified when extracted from the post data.
3395 * Note that this is basically the inverse for importContentFormData
3397 protected function showContentForm() {
3398 $this->showTextbox1();
3402 * Method to output wpTextbox1
3403 * The $textoverride method can be used by subclasses overriding showContentForm
3404 * to pass back to this method.
3406 * @param array|null $customAttribs Array of html attributes to use in the textarea
3407 * @param string|null $textoverride Optional text to override $this->textarea1 with
3409 protected function showTextbox1( $customAttribs = null, $textoverride = null ) {
3410 if ( $this->wasDeletedSinceLastEdit() && $this->formtype
== 'save' ) {
3411 $attribs = [ 'style' => 'display:none;' ];
3413 $builder = new TextboxBuilder();
3414 $classes = $builder->getTextboxProtectionCSSClasses( $this->getTitle() );
3416 # Is an old revision being edited?
3417 if ( $this->isOldRev
) {
3418 $classes[] = 'mw-textarea-oldrev';
3421 $attribs = [ 'tabindex' => 1 ];
3423 if ( is_array( $customAttribs ) ) {
3424 $attribs +
= $customAttribs;
3427 $attribs = $builder->mergeClassesIntoAttributes( $classes, $attribs );
3431 $textoverride ??
$this->textbox1
,
3437 protected function showTextbox2() {
3438 $this->showTextbox( $this->textbox2
, 'wpTextbox2', [ 'tabindex' => 6, 'readonly' ] );
3441 protected function showTextbox( $text, $name, $customAttribs = [] ) {
3442 $builder = new TextboxBuilder();
3443 $attribs = $builder->buildTextboxAttribs(
3446 $this->context
->getUser(),
3450 $this->context
->getOutput()->addHTML(
3451 Html
::textarea( $name, $builder->addNewLineAtEnd( $text ), $attribs )
3455 protected function displayPreviewArea( $previewOutput, $isOnTop = false ) {
3458 $classes[] = 'ontop';
3461 $attribs = [ 'id' => 'wikiPreview', 'class' => implode( ' ', $classes ) ];
3463 if ( $this->formtype
!= 'preview' ) {
3464 $attribs['style'] = 'display: none;';
3467 $out = $this->context
->getOutput();
3468 $out->addHTML( Xml
::openElement( 'div', $attribs ) );
3470 if ( $this->formtype
== 'preview' ) {
3471 $this->showPreview( $previewOutput );
3473 // Empty content container for LivePreview
3474 $pageViewLang = $this->mTitle
->getPageViewLanguage();
3475 $attribs = [ 'lang' => $pageViewLang->getHtmlCode(), 'dir' => $pageViewLang->getDir(),
3476 'class' => 'mw-content-' . $pageViewLang->getDir() ];
3477 $out->addHTML( Html
::rawElement( 'div', $attribs ) );
3480 $out->addHTML( '</div>' );
3482 if ( $this->formtype
== 'diff' ) {
3485 } catch ( MWContentSerializationException
$ex ) {
3486 $msg = $this->context
->msg(
3487 'content-failed-to-parse',
3488 $this->contentModel
,
3489 $this->contentFormat
,
3492 $out->wrapWikiTextAsInterface( 'error', $msg->plain() );
3498 * Append preview output to OutputPage.
3499 * Includes category rendering if this is a category page.
3501 * @param string $text The HTML to be output for the preview.
3503 protected function showPreview( $text ) {
3504 if ( $this->mArticle
instanceof CategoryPage
) {
3505 $this->mArticle
->openShowCategory();
3507 # This hook seems slightly odd here, but makes things more
3508 # consistent for extensions.
3509 $out = $this->context
->getOutput();
3510 Hooks
::run( 'OutputPageBeforeHTML', [ &$out, &$text ] );
3511 $out->addHTML( $text );
3512 if ( $this->mArticle
instanceof CategoryPage
) {
3513 $this->mArticle
->closeShowCategory();
3518 * Get a diff between the current contents of the edit box and the
3519 * version of the page we're editing from.
3521 * If this is a section edit, we'll replace the section as for final
3522 * save and then make a comparison.
3524 public function showDiff() {
3525 $oldtitlemsg = 'currentrev';
3526 # if message does not exist, show diff against the preloaded default
3527 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
&& !$this->mTitle
->exists() ) {
3528 $oldtext = $this->mTitle
->getDefaultMessageText();
3529 if ( $oldtext !== false ) {
3530 $oldtitlemsg = 'defaultmessagetext';
3531 $oldContent = $this->toEditContent( $oldtext );
3536 $oldContent = $this->getCurrentContent();
3539 $textboxContent = $this->toEditContent( $this->textbox1
);
3540 if ( $this->editRevId
!== null ) {
3541 $newContent = $this->page
->replaceSectionAtRev(
3542 $this->section
, $textboxContent, $this->summary
, $this->editRevId
3545 $newContent = $this->page
->replaceSectionContent(
3546 $this->section
, $textboxContent, $this->summary
, $this->edittime
3550 if ( $newContent ) {
3551 Hooks
::run( 'EditPageGetDiffContent', [ $this, &$newContent ] );
3553 $user = $this->context
->getUser();
3554 $popts = ParserOptions
::newFromUserAndLang( $user,
3555 MediaWikiServices
::getInstance()->getContentLanguage() );
3556 $newContent = $newContent->preSaveTransform( $this->mTitle
, $user, $popts );
3559 if ( ( $oldContent && !$oldContent->isEmpty() ) ||
( $newContent && !$newContent->isEmpty() ) ) {
3560 $oldtitle = $this->context
->msg( $oldtitlemsg )->parse();
3561 $newtitle = $this->context
->msg( 'yourtext' )->parse();
3563 if ( !$oldContent ) {
3564 $oldContent = $newContent->getContentHandler()->makeEmptyContent();
3567 if ( !$newContent ) {
3568 $newContent = $oldContent->getContentHandler()->makeEmptyContent();
3571 $de = $oldContent->getContentHandler()->createDifferenceEngine( $this->context
);
3572 $de->setContent( $oldContent, $newContent );
3574 $difftext = $de->getDiff( $oldtitle, $newtitle );
3575 $de->showDiffStyle();
3580 $this->context
->getOutput()->addHTML( '<div id="wikiDiff">' . $difftext . '</div>' );
3584 * Show the header copyright warning.
3586 protected function showHeaderCopyrightWarning() {
3587 $msg = 'editpage-head-copy-warn';
3588 if ( !$this->context
->msg( $msg )->isDisabled() ) {
3589 $this->context
->getOutput()->wrapWikiMsg( "<div class='editpage-head-copywarn'>\n$1\n</div>",
3590 'editpage-head-copy-warn' );
3595 * Give a chance for site and per-namespace customizations of
3596 * terms of service summary link that might exist separately
3597 * from the copyright notice.
3599 * This will display between the save button and the edit tools,
3600 * so should remain short!
3602 protected function showTosSummary() {
3603 $msg = 'editpage-tos-summary';
3604 Hooks
::run( 'EditPageTosSummary', [ $this->mTitle
, &$msg ] );
3605 if ( !$this->context
->msg( $msg )->isDisabled() ) {
3606 $out = $this->context
->getOutput();
3607 $out->addHTML( '<div class="mw-tos-summary">' );
3608 $out->addWikiMsg( $msg );
3609 $out->addHTML( '</div>' );
3614 * Inserts optional text shown below edit and upload forms. Can be used to offer special
3615 * characters not present on most keyboards for copying/pasting.
3617 protected function showEditTools() {
3618 $this->context
->getOutput()->addHTML( '<div class="mw-editTools">' .
3619 $this->context
->msg( 'edittools' )->inContentLanguage()->parse() .
3624 * Get the copyright warning
3626 * Renamed to getCopyrightWarning(), old name kept around for backwards compatibility
3629 protected function getCopywarn() {
3630 return self
::getCopyrightWarning( $this->mTitle
);
3634 * Get the copyright warning, by default returns wikitext
3636 * @param Title $title
3637 * @param string $format Output format, valid values are any function of a Message object
3638 * @param Language|string|null $langcode Language code or Language object.
3641 public static function getCopyrightWarning( $title, $format = 'plain', $langcode = null ) {
3642 global $wgRightsText;
3643 if ( $wgRightsText ) {
3644 $copywarnMsg = [ 'copyrightwarning',
3645 '[[' . wfMessage( 'copyrightpage' )->inContentLanguage()->text() . ']]',
3648 $copywarnMsg = [ 'copyrightwarning2',
3649 '[[' . wfMessage( 'copyrightpage' )->inContentLanguage()->text() . ']]' ];
3651 // Allow for site and per-namespace customization of contribution/copyright notice.
3652 Hooks
::run( 'EditPageCopyrightWarning', [ $title, &$copywarnMsg ] );
3654 $msg = wfMessage( ...$copywarnMsg )->title( $title );
3656 $msg->inLanguage( $langcode );
3658 return "<div id=\"editpage-copywarn\">\n" .
3659 $msg->$format() . "\n</div>";
3663 * Get the Limit report for page previews
3666 * @param ParserOutput|null $output ParserOutput object from the parse
3667 * @return string HTML
3669 public static function getPreviewLimitReport( ParserOutput
$output = null ) {
3672 if ( !$output ||
!$output->getLimitReportData() ) {
3676 $limitReport = Html
::rawElement( 'div', [ 'class' => 'mw-limitReportExplanation' ],
3677 wfMessage( 'limitreport-title' )->parseAsBlock()
3680 // Show/hide animation doesn't work correctly on a table, so wrap it in a div.
3681 $limitReport .= Html
::openElement( 'div', [ 'class' => 'preview-limit-report-wrapper' ] );
3683 $limitReport .= Html
::openElement( 'table', [
3684 'class' => 'preview-limit-report wikitable'
3686 Html
::openElement( 'tbody' );
3688 foreach ( $output->getLimitReportData() as $key => $value ) {
3689 if ( Hooks
::run( 'ParserLimitReportFormat',
3690 [ $key, &$value, &$limitReport, true, true ]
3692 $keyMsg = wfMessage( $key );
3693 $valueMsg = wfMessage( [ "$key-value-html", "$key-value" ] );
3694 if ( !$valueMsg->exists() ) {
3695 $valueMsg = new RawMessage( '$1' );
3697 if ( !$keyMsg->isDisabled() && !$valueMsg->isDisabled() ) {
3698 $limitReport .= Html
::openElement( 'tr' ) .
3699 Html
::rawElement( 'th', null, $keyMsg->parse() ) .
3700 Html
::rawElement( 'td', null,
3701 $wgLang->formatNum( $valueMsg->params( $value )->parse() )
3703 Html
::closeElement( 'tr' );
3708 $limitReport .= Html
::closeElement( 'tbody' ) .
3709 Html
::closeElement( 'table' ) .
3710 Html
::closeElement( 'div' );
3712 return $limitReport;
3715 protected function showStandardInputs( &$tabindex = 2 ) {
3716 $out = $this->context
->getOutput();
3717 $out->addHTML( "<div class='editOptions'>\n" );
3719 if ( $this->section
!= 'new' ) {
3720 $this->showSummaryInput( false, $this->summary
);
3721 $out->addHTML( $this->getSummaryPreview( false, $this->summary
) );
3724 $checkboxes = $this->getCheckboxesWidget(
3726 [ 'minor' => $this->minoredit
, 'watch' => $this->watchthis
]
3728 $checkboxesHTML = new OOUI\
HorizontalLayout( [ 'items' => $checkboxes ] );
3730 $out->addHTML( "<div class='editCheckboxes'>" . $checkboxesHTML . "</div>\n" );
3732 // Show copyright warning.
3733 $out->addWikiTextAsInterface( $this->getCopywarn() );
3734 $out->addHTML( $this->editFormTextAfterWarn
);
3736 $out->addHTML( "<div class='editButtons'>\n" );
3737 $out->addHTML( implode( "\n", $this->getEditButtons( $tabindex ) ) . "\n" );
3739 $cancel = $this->getCancelLink();
3741 $message = $this->context
->msg( 'edithelppage' )->inContentLanguage()->text();
3742 $edithelpurl = Skin
::makeInternalOrExternalUrl( $message );
3745 $this->context
->msg( 'edithelp' )->text(),
3746 [ 'target' => 'helpwindow', 'href' => $edithelpurl ],
3749 $this->context
->msg( 'word-separator' )->escaped() .
3750 $this->context
->msg( 'newwindow' )->parse();
3752 $out->addHTML( " <span class='cancelLink'>{$cancel}</span>\n" );
3753 $out->addHTML( " <span class='editHelp'>{$edithelp}</span>\n" );
3754 $out->addHTML( "</div><!-- editButtons -->\n" );
3756 Hooks
::run( 'EditPage::showStandardInputs:options', [ $this, $out, &$tabindex ] );
3758 $out->addHTML( "</div><!-- editOptions -->\n" );
3762 * Show an edit conflict. textbox1 is already shown in showEditForm().
3763 * If you want to use another entry point to this function, be careful.
3765 protected function showConflict() {
3766 $out = $this->context
->getOutput();
3767 // Avoid PHP 7.1 warning of passing $this by reference
3769 if ( Hooks
::run( 'EditPageBeforeConflictDiff', [ &$editPage, &$out ] ) ) {
3770 $this->incrementConflictStats();
3772 $this->getEditConflictHelper()->showEditFormTextAfterFooters();
3776 protected function incrementConflictStats() {
3777 $this->getEditConflictHelper()->incrementConflictStats();
3783 public function getCancelLink() {
3785 if ( !$this->isConflict
&& $this->oldid
> 0 ) {
3786 $cancelParams['oldid'] = $this->oldid
;
3787 } elseif ( $this->getContextTitle()->isRedirect() ) {
3788 $cancelParams['redirect'] = 'no';
3791 return new OOUI\
ButtonWidget( [
3792 'id' => 'mw-editform-cancel',
3793 'href' => $this->getContextTitle()->getLinkURL( $cancelParams ),
3794 'label' => new OOUI\
HtmlSnippet( $this->context
->msg( 'cancel' )->parse() ),
3796 'infusable' => true,
3797 'flags' => 'destructive',
3802 * Returns the URL to use in the form's action attribute.
3803 * This is used by EditPage subclasses when simply customizing the action
3804 * variable in the constructor is not enough. This can be used when the
3805 * EditPage lives inside of a Special page rather than a custom page action.
3807 * @param Title $title Title object for which is being edited (where we go to for &action= links)
3810 protected function getActionURL( Title
$title ) {
3811 return $title->getLocalURL( [ 'action' => $this->action
] );
3815 * Check if a page was deleted while the user was editing it, before submit.
3816 * Note that we rely on the logging table, which hasn't been always there,
3817 * but that doesn't matter, because this only applies to brand new
3821 protected function wasDeletedSinceLastEdit() {
3822 if ( $this->deletedSinceEdit
!== null ) {
3823 return $this->deletedSinceEdit
;
3826 $this->deletedSinceEdit
= false;
3828 if ( !$this->mTitle
->exists() && $this->mTitle
->isDeletedQuick() ) {
3829 $this->lastDelete
= $this->getLastDelete();
3830 if ( $this->lastDelete
) {
3831 $deleteTime = wfTimestamp( TS_MW
, $this->lastDelete
->log_timestamp
);
3832 if ( $deleteTime > $this->starttime
) {
3833 $this->deletedSinceEdit
= true;
3838 return $this->deletedSinceEdit
;
3842 * Get the last log record of this page being deleted, if ever. This is
3843 * used to detect whether a delete occurred during editing.
3844 * @return bool|stdClass
3846 protected function getLastDelete() {
3847 $dbr = wfGetDB( DB_REPLICA
);
3848 $commentQuery = CommentStore
::getStore()->getJoin( 'log_comment' );
3849 $actorQuery = ActorMigration
::newMigration()->getJoin( 'log_user' );
3850 $data = $dbr->selectRow(
3851 array_merge( [ 'logging' ], $commentQuery['tables'], $actorQuery['tables'], [ 'user' ] ),
3861 ] +
$commentQuery['fields'] +
$actorQuery['fields'],
3863 'log_namespace' => $this->mTitle
->getNamespace(),
3864 'log_title' => $this->mTitle
->getDBkey(),
3865 'log_type' => 'delete',
3866 'log_action' => 'delete',
3869 [ 'LIMIT' => 1, 'ORDER BY' => 'log_timestamp DESC' ],
3871 'user' => [ 'JOIN', 'user_id=' . $actorQuery['fields']['log_user'] ],
3872 ] +
$commentQuery['joins'] +
$actorQuery['joins']
3874 // Quick paranoid permission checks...
3875 if ( is_object( $data ) ) {
3876 if ( $data->log_deleted
& LogPage
::DELETED_USER
) {
3877 $data->user_name
= $this->context
->msg( 'rev-deleted-user' )->escaped();
3880 if ( $data->log_deleted
& LogPage
::DELETED_COMMENT
) {
3881 $data->log_comment_text
= $this->context
->msg( 'rev-deleted-comment' )->escaped();
3882 $data->log_comment_data
= null;
3890 * Get the rendered text for previewing.
3891 * @throws MWException
3894 public function getPreviewText() {
3895 $out = $this->context
->getOutput();
3896 $config = $this->context
->getConfig();
3898 if ( $config->get( 'RawHtml' ) && !$this->mTokenOk
) {
3899 // Could be an offsite preview attempt. This is very unsafe if
3900 // HTML is enabled, as it could be an attack.
3902 if ( $this->textbox1
!== '' ) {
3903 // Do not put big scary notice, if previewing the empty
3904 // string, which happens when you initially edit
3905 // a category page, due to automatic preview-on-open.
3906 $parsedNote = Html
::rawElement( 'div', [ 'class' => 'previewnote' ],
3907 $out->parseAsInterface(
3908 $this->context
->msg( 'session_fail_preview_html' )->plain()
3911 $this->incrementEditFailureStats( 'session_loss' );
3918 $content = $this->toEditContent( $this->textbox1
);
3922 'AlternateEditPreview',
3923 [ $this, &$content, &$previewHTML, &$this->mParserOutput
] )
3925 return $previewHTML;
3928 # provide a anchor link to the editform
3929 $continueEditing = '<span class="mw-continue-editing">' .
3930 '[[#' . self
::EDITFORM_ID
. '|' .
3931 $this->context
->getLanguage()->getArrow() . ' ' .
3932 $this->context
->msg( 'continue-editing' )->text() . ']]</span>';
3933 if ( $this->mTriedSave
&& !$this->mTokenOk
) {
3934 if ( $this->mTokenOkExceptSuffix
) {
3935 $note = $this->context
->msg( 'token_suffix_mismatch' )->plain();
3936 $this->incrementEditFailureStats( 'bad_token' );
3938 $note = $this->context
->msg( 'session_fail_preview' )->plain();
3939 $this->incrementEditFailureStats( 'session_loss' );
3941 } elseif ( $this->incompleteForm
) {
3942 $note = $this->context
->msg( 'edit_form_incomplete' )->plain();
3943 if ( $this->mTriedSave
) {
3944 $this->incrementEditFailureStats( 'incomplete_form' );
3947 $note = $this->context
->msg( 'previewnote' )->plain() . ' ' . $continueEditing;
3950 # don't parse non-wikitext pages, show message about preview
3951 if ( $this->mTitle
->isUserConfigPage() ||
$this->mTitle
->isSiteConfigPage() ) {
3952 if ( $this->mTitle
->isUserConfigPage() ) {
3954 } elseif ( $this->mTitle
->isSiteConfigPage() ) {
3960 if ( $content->getModel() == CONTENT_MODEL_CSS
) {
3962 if ( $level === 'user' && !$config->get( 'AllowUserCss' ) ) {
3965 } elseif ( $content->getModel() == CONTENT_MODEL_JSON
) {
3967 if ( $level === 'user' /* No comparable 'AllowUserJson' */ ) {
3970 } elseif ( $content->getModel() == CONTENT_MODEL_JAVASCRIPT
) {
3972 if ( $level === 'user' && !$config->get( 'AllowUserJs' ) ) {
3979 # Used messages to make sure grep find them:
3980 # Messages: usercsspreview, userjsonpreview, userjspreview,
3981 # sitecsspreview, sitejsonpreview, sitejspreview
3982 if ( $level && $format ) {
3983 $note = "<div id='mw-{$level}{$format}preview'>" .
3984 $this->context
->msg( "{$level}{$format}preview" )->plain() .
3985 ' ' . $continueEditing . "</div>";
3989 # If we're adding a comment, we need to show the
3990 # summary as the headline
3991 if ( $this->section
=== "new" && $this->summary
!== "" ) {
3992 $content = $content->addSectionHeader( $this->summary
);
3995 $hook_args = [ $this, &$content ];
3996 Hooks
::run( 'EditPageGetPreviewContent', $hook_args );
3998 $parserResult = $this->doPreviewParse( $content );
3999 $parserOutput = $parserResult['parserOutput'];
4000 $previewHTML = $parserResult['html'];
4001 $this->mParserOutput
= $parserOutput;
4002 $out->addParserOutputMetadata( $parserOutput );
4003 if ( $out->userCanPreview() ) {
4004 $out->addContentOverride( $this->getTitle(), $content );
4007 if ( count( $parserOutput->getWarnings() ) ) {
4008 $note .= "\n\n" . implode( "\n\n", $parserOutput->getWarnings() );
4011 } catch ( MWContentSerializationException
$ex ) {
4012 $m = $this->context
->msg(
4013 'content-failed-to-parse',
4014 $this->contentModel
,
4015 $this->contentFormat
,
4018 $note .= "\n\n" . $m->plain(); # gets parsed down below
4022 if ( $this->isConflict
) {
4023 $conflict = Html
::rawElement(
4024 'h2', [ 'id' => 'mw-previewconflict' ],
4025 $this->context
->msg( 'previewconflict' )->escaped()
4028 $conflict = '<hr />';
4031 $previewhead = Html
::rawElement(
4032 'div', [ 'class' => 'previewnote' ],
4034 'h2', [ 'id' => 'mw-previewheader' ],
4035 $this->context
->msg( 'preview' )->escaped()
4037 $out->parseAsInterface( $note ) . $conflict
4040 $pageViewLang = $this->mTitle
->getPageViewLanguage();
4041 $attribs = [ 'lang' => $pageViewLang->getHtmlCode(), 'dir' => $pageViewLang->getDir(),
4042 'class' => 'mw-content-' . $pageViewLang->getDir() ];
4043 $previewHTML = Html
::rawElement( 'div', $attribs, $previewHTML );
4045 return $previewhead . $previewHTML . $this->previewTextAfterContent
;
4048 private function incrementEditFailureStats( $failureType ) {
4049 $stats = MediaWikiServices
::getInstance()->getStatsdDataFactory();
4050 $stats->increment( 'edit.failures.' . $failureType );
4054 * Get parser options for a preview
4055 * @return ParserOptions
4057 protected function getPreviewParserOptions() {
4058 $parserOptions = $this->page
->makeParserOptions( $this->context
);
4059 $parserOptions->setIsPreview( true );
4060 $parserOptions->setIsSectionPreview( !is_null( $this->section
) && $this->section
!== '' );
4061 $parserOptions->enableLimitReport();
4063 // XXX: we could call $parserOptions->setCurrentRevisionCallback here to force the
4064 // current revision to be null during PST, until setupFakeRevision is called on
4065 // the ParserOptions. Currently, we rely on Parser::getRevisionObject() to ignore
4066 // existing revisions in preview mode.
4068 return $parserOptions;
4072 * Parse the page for a preview. Subclasses may override this class, in order
4073 * to parse with different options, or to otherwise modify the preview HTML.
4075 * @param Content $content The page content
4076 * @return array with keys:
4077 * - parserOutput: The ParserOutput object
4078 * - html: The HTML to be displayed
4080 protected function doPreviewParse( Content
$content ) {
4081 $user = $this->context
->getUser();
4082 $parserOptions = $this->getPreviewParserOptions();
4084 // NOTE: preSaveTransform doesn't have a fake revision to operate on.
4085 // Parser::getRevisionObject() will return null in preview mode,
4086 // causing the context user to be used for {{subst:REVISIONUSER}}.
4087 // XXX: Alternatively, we could also call setupFakeRevision() a second time:
4088 // once before PST with $content, and then after PST with $pstContent.
4089 $pstContent = $content->preSaveTransform( $this->mTitle
, $user, $parserOptions );
4090 $scopedCallback = $parserOptions->setupFakeRevision( $this->mTitle
, $pstContent, $user );
4091 $parserOutput = $pstContent->getParserOutput( $this->mTitle
, null, $parserOptions );
4092 ScopedCallback
::consume( $scopedCallback );
4094 'parserOutput' => $parserOutput,
4095 'html' => $parserOutput->getText( [
4096 'enableSectionEditLinks' => false
4104 public function getTemplates() {
4105 if ( $this->preview ||
$this->section
!= '' ) {
4107 if ( !isset( $this->mParserOutput
) ) {
4110 foreach ( $this->mParserOutput
->getTemplates() as $ns => $template ) {
4111 foreach ( array_keys( $template ) as $dbk ) {
4112 $templates[] = Title
::makeTitle( $ns, $dbk );
4117 return $this->mTitle
->getTemplateLinksFrom();
4122 * Allow extensions to provide a toolbar.
4124 * @param Title|null $title Title object for the page being edited (optional)
4125 * @return string|null
4127 public static function getEditToolbar( $title = null ) {
4128 $startingToolbar = '<div id="toolbar"></div>';
4129 $toolbar = $startingToolbar;
4131 if ( !Hooks
::run( 'EditPageBeforeEditToolbar', [ &$toolbar ] ) ) {
4134 // Don't add a pointless `<div>` to the page unless a hook caller populated it
4135 return ( $toolbar === $startingToolbar ) ?
null : $toolbar;
4139 * Return an array of checkbox definitions.
4141 * Array keys correspond to the `<input>` 'name' attribute to use for each checkbox.
4143 * Array values are associative arrays with the following keys:
4144 * - 'label-message' (required): message for label text
4145 * - 'id' (required): 'id' attribute for the `<input>`
4146 * - 'default' (required): default checkedness (true or false)
4147 * - 'title-message' (optional): used to generate 'title' attribute for the `<label>`
4148 * - 'tooltip' (optional): used to generate 'title' and 'accesskey' attributes
4149 * from messages like 'tooltip-foo', 'accesskey-foo'
4150 * - 'label-id' (optional): 'id' attribute for the `<label>`
4151 * - 'legacy-name' (optional): short name for backwards-compatibility
4152 * @param array $checked Array of checkbox name (matching the 'legacy-name') => bool,
4153 * where bool indicates the checked status of the checkbox
4156 public function getCheckboxesDefinition( $checked ) {
4159 $user = $this->context
->getUser();
4160 // don't show the minor edit checkbox if it's a new page or section
4161 if ( !$this->isNew
&& $user->isAllowed( 'minoredit' ) ) {
4162 $checkboxes['wpMinoredit'] = [
4163 'id' => 'wpMinoredit',
4164 'label-message' => 'minoredit',
4165 // Uses messages: tooltip-minoredit, accesskey-minoredit
4166 'tooltip' => 'minoredit',
4167 'label-id' => 'mw-editpage-minoredit',
4168 'legacy-name' => 'minor',
4169 'default' => $checked['minor'],
4173 if ( $user->isLoggedIn() ) {
4174 $checkboxes['wpWatchthis'] = [
4175 'id' => 'wpWatchthis',
4176 'label-message' => 'watchthis',
4177 // Uses messages: tooltip-watch, accesskey-watch
4178 'tooltip' => 'watch',
4179 'label-id' => 'mw-editpage-watch',
4180 'legacy-name' => 'watch',
4181 'default' => $checked['watch'],
4186 Hooks
::run( 'EditPageGetCheckboxesDefinition', [ $editPage, &$checkboxes ] );
4192 * Returns an array of checkboxes for the edit form, including 'minor' and 'watch' checkboxes and
4193 * any other added by extensions.
4195 * @param int &$tabindex Current tabindex
4196 * @param array $checked Array of checkbox => bool, where bool indicates the checked
4197 * status of the checkbox
4199 * @return array Associative array of string keys to OOUI\FieldLayout instances
4201 public function getCheckboxesWidget( &$tabindex, $checked ) {
4203 $checkboxesDef = $this->getCheckboxesDefinition( $checked );
4205 foreach ( $checkboxesDef as $name => $options ) {
4206 $legacyName = $options['legacy-name'] ??
$name;
4210 if ( isset( $options['tooltip'] ) ) {
4211 $accesskey = $this->context
->msg( "accesskey-{$options['tooltip']}" )->text();
4212 $title = Linker
::titleAttrib( $options['tooltip'] );
4214 if ( isset( $options['title-message'] ) ) {
4215 $title = $this->context
->msg( $options['title-message'] )->text();
4218 $checkboxes[ $legacyName ] = new OOUI\
FieldLayout(
4219 new OOUI\
CheckboxInputWidget( [
4220 'tabIndex' => ++
$tabindex,
4221 'accessKey' => $accesskey,
4222 'id' => $options['id'] . 'Widget',
4223 'inputId' => $options['id'],
4225 'selected' => $options['default'],
4226 'infusable' => true,
4229 'align' => 'inline',
4230 'label' => new OOUI\
HtmlSnippet( $this->context
->msg( $options['label-message'] )->parse() ),
4232 'id' => $options['label-id'] ??
null,
4241 * Get the message key of the label for the button to save the page
4246 protected function getSubmitButtonLabel() {
4248 $this->context
->getConfig()->get( 'EditSubmitButtonLabelPublish' );
4250 // Can't use $this->isNew as that's also true if we're adding a new section to an extant page
4251 $newPage = !$this->mTitle
->exists();
4253 if ( $labelAsPublish ) {
4254 $buttonLabelKey = $newPage ?
'publishpage' : 'publishchanges';
4256 $buttonLabelKey = $newPage ?
'savearticle' : 'savechanges';
4259 return $buttonLabelKey;
4263 * Returns an array of html code of the following buttons:
4264 * save, diff and preview
4266 * @param int &$tabindex Current tabindex
4270 public function getEditButtons( &$tabindex ) {
4274 $this->context
->getConfig()->get( 'EditSubmitButtonLabelPublish' );
4276 $buttonLabel = $this->context
->msg( $this->getSubmitButtonLabel() )->text();
4277 $buttonTooltip = $labelAsPublish ?
'publish' : 'save';
4279 $buttons['save'] = new OOUI\
ButtonInputWidget( [
4281 'tabIndex' => ++
$tabindex,
4282 'id' => 'wpSaveWidget',
4283 'inputId' => 'wpSave',
4284 // Support: IE 6 βΒ Use <input>, otherwise it can't distinguish which button was clicked
4285 'useInputTag' => true,
4286 'flags' => [ 'progressive', 'primary' ],
4287 'label' => $buttonLabel,
4288 'infusable' => true,
4290 // Messages used: tooltip-save, tooltip-publish
4291 'title' => Linker
::titleAttrib( $buttonTooltip ),
4292 // Messages used: accesskey-save, accesskey-publish
4293 'accessKey' => Linker
::accesskey( $buttonTooltip ),
4296 $buttons['preview'] = new OOUI\
ButtonInputWidget( [
4297 'name' => 'wpPreview',
4298 'tabIndex' => ++
$tabindex,
4299 'id' => 'wpPreviewWidget',
4300 'inputId' => 'wpPreview',
4301 // Support: IE 6 βΒ Use <input>, otherwise it can't distinguish which button was clicked
4302 'useInputTag' => true,
4303 'label' => $this->context
->msg( 'showpreview' )->text(),
4304 'infusable' => true,
4306 // Message used: tooltip-preview
4307 'title' => Linker
::titleAttrib( 'preview' ),
4308 // Message used: accesskey-preview
4309 'accessKey' => Linker
::accesskey( 'preview' ),
4312 $buttons['diff'] = new OOUI\
ButtonInputWidget( [
4314 'tabIndex' => ++
$tabindex,
4315 'id' => 'wpDiffWidget',
4316 'inputId' => 'wpDiff',
4317 // Support: IE 6 βΒ Use <input>, otherwise it can't distinguish which button was clicked
4318 'useInputTag' => true,
4319 'label' => $this->context
->msg( 'showdiff' )->text(),
4320 'infusable' => true,
4322 // Message used: tooltip-diff
4323 'title' => Linker
::titleAttrib( 'diff' ),
4324 // Message used: accesskey-diff
4325 'accessKey' => Linker
::accesskey( 'diff' ),
4328 // Avoid PHP 7.1 warning of passing $this by reference
4330 Hooks
::run( 'EditPageBeforeEditButtons', [ &$editPage, &$buttons, &$tabindex ] );
4336 * Creates a basic error page which informs the user that
4337 * they have attempted to edit a nonexistent section.
4339 public function noSuchSectionPage() {
4340 $out = $this->context
->getOutput();
4341 $out->prepareErrorPage( $this->context
->msg( 'nosuchsectiontitle' ) );
4343 $res = $this->context
->msg( 'nosuchsectiontext', $this->section
)->parseAsBlock();
4345 // Avoid PHP 7.1 warning of passing $this by reference
4347 Hooks
::run( 'EditPageNoSuchSection', [ &$editPage, &$res ] );
4348 $out->addHTML( $res );
4350 $out->returnToMain( false, $this->mTitle
);
4354 * Show "your edit contains spam" page with your diff and text
4356 * @param string|array|bool $match Text (or array of texts) which triggered one or more filters
4358 public function spamPageWithContent( $match = false ) {
4359 $this->textbox2
= $this->textbox1
;
4361 if ( is_array( $match ) ) {
4362 $match = $this->context
->getLanguage()->listToText( $match );
4364 $out = $this->context
->getOutput();
4365 $out->prepareErrorPage( $this->context
->msg( 'spamprotectiontitle' ) );
4367 $out->addHTML( '<div id="spamprotected">' );
4368 $out->addWikiMsg( 'spamprotectiontext' );
4370 $out->addWikiMsg( 'spamprotectionmatch', wfEscapeWikiText( $match ) );
4372 $out->addHTML( '</div>' );
4374 $out->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
4377 $out->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
4378 $this->showTextbox2();
4380 $out->addReturnTo( $this->getContextTitle(), [ 'action' => 'edit' ] );
4384 * Filter an input field through a Unicode de-armoring process if it
4385 * came from an old browser with known broken Unicode editing issues.
4387 * @deprecated since 1.30, does nothing
4389 * @param WebRequest $request
4390 * @param string $field
4393 protected function safeUnicodeInput( $request, $field ) {
4394 return rtrim( $request->getText( $field ) );
4398 * Filter an output field through a Unicode armoring process if it is
4399 * going to an old browser with known broken Unicode editing issues.
4401 * @deprecated since 1.30, does nothing
4403 * @param string $text
4406 protected function safeUnicodeOutput( $text ) {
4413 protected function addEditNotices() {
4414 $out = $this->context
->getOutput();
4415 $editNotices = $this->mTitle
->getEditNotices( $this->oldid
);
4416 if ( count( $editNotices ) ) {
4417 $out->addHTML( implode( "\n", $editNotices ) );
4419 $msg = $this->context
->msg( 'editnotice-notext' );
4420 if ( !$msg->isDisabled() ) {
4422 '<div class="mw-editnotice-notext">'
4423 . $msg->parseAsBlock()
4433 protected function addTalkPageText() {
4434 if ( $this->mTitle
->isTalkPage() ) {
4435 $this->context
->getOutput()->addWikiMsg( 'talkpagetext' );
4442 protected function addLongPageWarningHeader() {
4443 if ( $this->contentLength
=== false ) {
4444 $this->contentLength
= strlen( $this->textbox1
);
4447 $out = $this->context
->getOutput();
4448 $lang = $this->context
->getLanguage();
4449 $maxArticleSize = $this->context
->getConfig()->get( 'MaxArticleSize' );
4450 if ( $this->tooBig ||
$this->contentLength
> $maxArticleSize * 1024 ) {
4451 $out->wrapWikiMsg( "<div class='error' id='mw-edit-longpageerror'>\n$1\n</div>",
4454 $lang->formatNum( round( $this->contentLength
/ 1024, 3 ) ),
4455 $lang->formatNum( $maxArticleSize )
4459 if ( !$this->context
->msg( 'longpage-hint' )->isDisabled() ) {
4460 $out->wrapWikiMsg( "<div id='mw-edit-longpage-hint'>\n$1\n</div>",
4463 $lang->formatSize( strlen( $this->textbox1
) ),
4464 strlen( $this->textbox1
)
4474 protected function addPageProtectionWarningHeaders() {
4475 $out = $this->context
->getOutput();
4476 if ( $this->mTitle
->isProtected( 'edit' ) &&
4477 MWNamespace
::getRestrictionLevels( $this->mTitle
->getNamespace() ) !== [ '' ]
4479 # Is the title semi-protected?
4480 if ( $this->mTitle
->isSemiProtected() ) {
4481 $noticeMsg = 'semiprotectedpagewarning';
4483 # Then it must be protected based on static groups (regular)
4484 $noticeMsg = 'protectedpagewarning';
4486 LogEventsList
::showLogExtract( $out, 'protect', $this->mTitle
, '',
4487 [ 'lim' => 1, 'msgKey' => [ $noticeMsg ] ] );
4489 if ( $this->mTitle
->isCascadeProtected() ) {
4490 # Is this page under cascading protection from some source pages?
4491 /** @var Title[] $cascadeSources */
4492 list( $cascadeSources, /* $restrictions */ ) = $this->mTitle
->getCascadeProtectionSources();
4493 $notice = "<div class='mw-cascadeprotectedwarning'>\n$1\n";
4494 $cascadeSourcesCount = count( $cascadeSources );
4495 if ( $cascadeSourcesCount > 0 ) {
4496 # Explain, and list the titles responsible
4497 foreach ( $cascadeSources as $page ) {
4498 $notice .= '* [[:' . $page->getPrefixedText() . "]]\n";
4501 $notice .= '</div>';
4502 $out->wrapWikiMsg( $notice, [ 'cascadeprotectedwarning', $cascadeSourcesCount ] );
4504 if ( !$this->mTitle
->exists() && $this->mTitle
->getRestrictions( 'create' ) ) {
4505 LogEventsList
::showLogExtract( $out, 'protect', $this->mTitle
, '',
4507 'showIfEmpty' => false,
4508 'msgKey' => [ 'titleprotectedwarning' ],
4509 'wrap' => "<div class=\"mw-titleprotectedwarning\">\n$1</div>" ] );
4514 * @param OutputPage $out
4517 protected function addExplainConflictHeader( OutputPage
$out ) {
4519 $this->getEditConflictHelper()->getExplainHeader()
4524 * @param string $name
4525 * @param mixed[] $customAttribs
4530 protected function buildTextboxAttribs( $name, array $customAttribs, User
$user ) {
4531 return ( new TextboxBuilder() )->buildTextboxAttribs(
4532 $name, $customAttribs, $user, $this->mTitle
4537 * @param string $wikitext
4541 protected function addNewLineAtEnd( $wikitext ) {
4542 return ( new TextboxBuilder() )->addNewLineAtEnd( $wikitext );
4546 * Turns section name wikitext into anchors for use in HTTP redirects. Various
4547 * versions of Microsoft browsers misinterpret fragment encoding of Location: headers
4548 * resulting in mojibake in address bar. Redirect them to legacy section IDs,
4549 * if possible. All the other browsers get HTML5 if the wiki is configured for it, to
4550 * spread the new style links more efficiently.
4552 * @param string $text
4555 private function guessSectionName( $text ) {
4558 // Detect Microsoft browsers
4559 $userAgent = $this->context
->getRequest()->getHeader( 'User-Agent' );
4560 if ( $userAgent && preg_match( '/MSIE|Edge/', $userAgent ) ) {
4561 // ...and redirect them to legacy encoding, if available
4562 return $wgParser->guessLegacySectionNameFromWikiText( $text );
4564 // Meanwhile, real browsers get real anchors
4565 return $wgParser->guessSectionNameFromWikiText( $text );
4569 * Set a factory function to create an EditConflictHelper
4571 * @param callable $factory Factory function
4574 public function setEditConflictHelperFactory( callable
$factory ) {
4575 $this->editConflictHelperFactory
= $factory;
4576 $this->editConflictHelper
= null;
4580 * @return TextConflictHelper
4582 private function getEditConflictHelper() {
4583 if ( !$this->editConflictHelper
) {
4584 $this->editConflictHelper
= call_user_func(
4585 $this->editConflictHelperFactory
,
4586 $this->getSubmitButtonLabel()
4590 return $this->editConflictHelper
;
4594 * @param string $submitButtonLabel
4595 * @return TextConflictHelper
4597 private function newTextConflictHelper( $submitButtonLabel ) {
4598 return new TextConflictHelper(
4600 $this->getContext()->getOutput(),
4601 MediaWikiServices
::getInstance()->getStatsdDataFactory(),