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';
239 public $isConflict = false;
241 /** @var bool New page or new section */
242 public $isNew = false;
245 public $deletedSinceEdit;
253 /** @var bool|stdClass */
257 public $mTokenOk = false;
260 public $mTokenOkExceptSuffix = false;
263 public $mTriedSave = false;
266 public $incompleteForm = false;
269 public $tooBig = false;
272 public $missingComment = false;
275 public $missingSummary = false;
278 public $allowBlankSummary = false;
281 protected $blankArticle = false;
284 protected $allowBlankArticle = false;
287 protected $selfRedirect = false;
290 protected $allowSelfRedirect = false;
293 public $autoSumm = '';
296 public $hookError = '';
298 /** @var ParserOutput */
299 public $mParserOutput;
301 /** @var bool Has a summary been preset using GET parameter &summary= ? */
302 public $hasPresetSummary = false;
304 /** @var Revision|bool|null */
305 public $mBaseRevision = false;
308 public $mShowSummaryField = true;
313 public $save = false;
316 public $preview = false;
319 public $diff = false;
322 public $minoredit = false;
325 public $watchthis = false;
328 public $recreate = false;
331 public $textbox1 = '';
334 public $textbox2 = '';
337 public $summary = '';
340 public $nosummary = false;
343 public $edittime = '';
346 private $editRevId = null;
349 public $section = '';
352 public $sectiontitle = '';
355 public $starttime = '';
361 public $parentRevId = 0;
364 public $editintro = '';
367 public $scrolltop = null;
373 public $contentModel;
375 /** @var null|string */
376 public $contentFormat = null;
378 /** @var null|array */
379 private $changeTags = null;
381 # Placeholders for text injection by hooks (must be HTML)
382 # extensions should take care to _append_ to the present value
384 /** @var string Before even the preview */
385 public $editFormPageTop = '';
386 public $editFormTextTop = '';
387 public $editFormTextBeforeContent = '';
388 public $editFormTextAfterWarn = '';
389 public $editFormTextAfterTools = '';
390 public $editFormTextBottom = '';
391 public $editFormTextAfterContent = '';
392 public $previewTextAfterContent = '';
393 public $mPreloadContent = null;
395 /* $didSave should be set to true whenever an article was successfully altered. */
396 public $didSave = false;
397 public $undidRev = 0;
399 public $suppressIntro = false;
405 protected $contentLength = false;
408 * @var bool Set in ApiEditPage, based on ContentHandler::allowsDirectApiEditing
410 private $enableApiEditOverride = false;
413 * @var IContextSource
418 * @var bool Whether an old revision is edited
420 private $isOldRev = false;
423 * @var string|null What the user submitted in the 'wpUnicodeCheck' field
425 private $unicodeCheck;
428 * Factory function to create an edit conflict helper
432 private $editConflictHelperFactory;
435 * @var TextConflictHelper|null
437 private $editConflictHelper;
440 * @param Article $article
442 public function __construct( Article
$article ) {
443 $this->mArticle
= $article;
444 $this->page
= $article->getPage(); // model object
445 $this->mTitle
= $article->getTitle();
446 $this->context
= $article->getContext();
448 $this->contentModel
= $this->mTitle
->getContentModel();
450 $handler = ContentHandler
::getForModelID( $this->contentModel
);
451 $this->contentFormat
= $handler->getDefaultFormat();
452 $this->editConflictHelperFactory
= [ $this, 'newTextConflictHelper' ];
458 public function getArticle() {
459 return $this->mArticle
;
464 * @return IContextSource
466 public function getContext() {
467 return $this->context
;
474 public function getTitle() {
475 return $this->mTitle
;
479 * Set the context Title object
481 * @param Title|null $title Title object or null
483 public function setContextTitle( $title ) {
484 $this->mContextTitle
= $title;
488 * Get the context title object.
489 * If not set, $wgTitle will be returned. This behavior might change in
490 * the future to return $this->mTitle instead.
494 public function getContextTitle() {
495 if ( is_null( $this->mContextTitle
) ) {
498 __METHOD__
. ' called by ' . wfGetAllCallers( 5 ) . ' with no title set.'
503 return $this->mContextTitle
;
508 * Check if the edit page is using OOUI controls
509 * @return bool Always true
510 * @deprecated since 1.30
512 public function isOouiEnabled() {
513 wfDeprecated( __METHOD__
, '1.30' );
518 * Returns if the given content model is editable.
520 * @param string $modelId The ID of the content model to test. Use CONTENT_MODEL_XXX constants.
522 * @throws MWException If $modelId has no known handler
524 public function isSupportedContentModel( $modelId ) {
525 return $this->enableApiEditOverride
=== true ||
526 ContentHandler
::getForModelID( $modelId )->supportsDirectEditing();
530 * Allow editing of content that supports API direct editing, but not general
531 * direct editing. Set to false by default.
533 * @param bool $enableOverride
535 public function setApiEditOverride( $enableOverride ) {
536 $this->enableApiEditOverride
= $enableOverride;
540 * @deprecated since 1.29, call edit directly
542 public function submit() {
543 wfDeprecated( __METHOD__
, '1.29' );
548 * This is the function that gets called for "action=edit". It
549 * sets up various member variables, then passes execution to
550 * another function, usually showEditForm()
552 * The edit form is self-submitting, so that when things like
553 * preview and edit conflicts occur, we get the same form back
554 * with the extra stuff added. Only when the final submission
555 * is made and all is well do we actually save and redirect to
556 * the newly-edited page.
558 public function edit() {
559 // Allow extensions to modify/prevent this form or submission
560 if ( !Hooks
::run( 'AlternateEdit', [ $this ] ) ) {
564 wfDebug( __METHOD__
. ": enter\n" );
566 $request = $this->context
->getRequest();
567 // If they used redlink=1 and the page exists, redirect to the main article
568 if ( $request->getBool( 'redlink' ) && $this->mTitle
->exists() ) {
569 $this->context
->getOutput()->redirect( $this->mTitle
->getFullURL() );
573 $this->importFormData( $request );
574 $this->firsttime
= false;
576 if ( wfReadOnly() && $this->save
) {
579 $this->preview
= true;
583 $this->formtype
= 'save';
584 } elseif ( $this->preview
) {
585 $this->formtype
= 'preview';
586 } elseif ( $this->diff
) {
587 $this->formtype
= 'diff';
588 } else { # First time through
589 $this->firsttime
= true;
590 if ( $this->previewOnOpen() ) {
591 $this->formtype
= 'preview';
593 $this->formtype
= 'initial';
597 $permErrors = $this->getEditPermissionErrors( $this->save ?
'secure' : 'full' );
599 wfDebug( __METHOD__
. ": User can't edit\n" );
600 // Auto-block user's IP if the account was "hard" blocked
601 if ( !wfReadOnly() ) {
602 DeferredUpdates
::addCallableUpdate( function () {
603 $this->context
->getUser()->spreadAnyEditBlock();
606 $this->displayPermissionsError( $permErrors );
611 $revision = $this->mArticle
->getRevisionFetched();
612 // Disallow editing revisions with content models different from the current one
613 // Undo edits being an exception in order to allow reverting content model changes.
615 && $revision->getContentModel() !== $this->contentModel
618 if ( $this->undidRev
) {
619 $undidRevObj = Revision
::newFromId( $this->undidRev
);
620 $prevRev = $undidRevObj ?
$undidRevObj->getPrevious() : null;
622 if ( !$this->undidRev
624 ||
$prevRev->getContentModel() !== $this->contentModel
626 $this->displayViewSourcePage(
627 $this->getContentObject(),
629 'contentmodelediterror',
630 $revision->getContentModel(),
638 $this->isConflict
= false;
640 # Show applicable editing introductions
641 if ( $this->formtype
== 'initial' ||
$this->firsttime
) {
645 # Attempt submission here. This will check for edit conflicts,
646 # and redundantly check for locked database, blocked IPs, etc.
647 # that edit() already checked just in case someone tries to sneak
648 # in the back door with a hand-edited submission URL.
650 if ( 'save' == $this->formtype
) {
651 $resultDetails = null;
652 $status = $this->attemptSave( $resultDetails );
653 if ( !$this->handleStatus( $status, $resultDetails ) ) {
658 # First time through: get contents, set time for conflict
660 if ( 'initial' == $this->formtype ||
$this->firsttime
) {
661 if ( $this->initialiseForm() === false ) {
662 $this->noSuchSectionPage();
666 if ( !$this->mTitle
->getArticleID() ) {
667 Hooks
::run( 'EditFormPreloadText', [ &$this->textbox1
, &$this->mTitle
] );
669 Hooks
::run( 'EditFormInitialText', [ $this ] );
674 $this->showEditForm();
678 * @param string $rigor Same format as Title::getUserPermissionErrors()
681 protected function getEditPermissionErrors( $rigor = 'secure' ) {
682 $user = $this->context
->getUser();
683 $permErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $user, $rigor );
684 # Can this title be created?
685 if ( !$this->mTitle
->exists() ) {
686 $permErrors = array_merge(
689 $this->mTitle
->getUserPermissionsErrors( 'create', $user, $rigor ),
694 # Ignore some permissions errors when a user is just previewing/viewing diffs
696 foreach ( $permErrors as $error ) {
697 if ( ( $this->preview ||
$this->diff
)
699 $error[0] == 'blockedtext' ||
700 $error[0] == 'autoblockedtext' ||
701 $error[0] == 'systemblockedtext'
707 $permErrors = wfArrayDiff2( $permErrors, $remove );
713 * Display a permissions error page, like OutputPage::showPermissionsErrorPage(),
714 * but with the following differences:
715 * - If redlink=1, the user will be redirected to the page
716 * - If there is content to display or the error occurs while either saving,
717 * previewing or showing the difference, it will be a
718 * "View source for ..." page displaying the source code after the error message.
721 * @param array $permErrors Array of permissions errors, as returned by
722 * Title::getUserPermissionsErrors().
723 * @throws PermissionsError
725 protected function displayPermissionsError( array $permErrors ) {
726 $out = $this->context
->getOutput();
727 if ( $this->context
->getRequest()->getBool( 'redlink' ) ) {
728 // The edit page was reached via a red link.
729 // Redirect to the article page and let them click the edit tab if
730 // they really want a permission error.
731 $out->redirect( $this->mTitle
->getFullURL() );
735 $content = $this->getContentObject();
737 # Use the normal message if there's nothing to display
738 if ( $this->firsttime
&& ( !$content ||
$content->isEmpty() ) ) {
739 $action = $this->mTitle
->exists() ?
'edit' :
740 ( $this->mTitle
->isTalkPage() ?
'createtalk' : 'createpage' );
741 throw new PermissionsError( $action, $permErrors );
744 $this->displayViewSourcePage(
746 $out->formatPermissionsErrorMessage( $permErrors, 'edit' )
751 * Display a read-only View Source page
752 * @param Content $content
753 * @param string $errorMessage additional wikitext error message to display
755 protected function displayViewSourcePage( Content
$content, $errorMessage = '' ) {
756 $out = $this->context
->getOutput();
757 Hooks
::run( 'EditPage::showReadOnlyForm:initial', [ $this, &$out ] );
759 $out->setRobotPolicy( 'noindex,nofollow' );
760 $out->setPageTitle( $this->context
->msg(
762 $this->getContextTitle()->getPrefixedText()
764 $out->addBacklinkSubtitle( $this->getContextTitle() );
765 $out->addHTML( $this->editFormPageTop
);
766 $out->addHTML( $this->editFormTextTop
);
768 if ( $errorMessage !== '' ) {
769 $out->addWikiText( $errorMessage );
770 $out->addHTML( "<hr />\n" );
773 # If the user made changes, preserve them when showing the markup
774 # (This happens when a user is blocked during edit, for instance)
775 if ( !$this->firsttime
) {
776 $text = $this->textbox1
;
777 $out->addWikiMsg( 'viewyourtext' );
780 $text = $this->toEditText( $content );
781 } catch ( MWException
$e ) {
782 # Serialize using the default format if the content model is not supported
783 # (e.g. for an old revision with a different model)
784 $text = $content->serialize();
786 $out->addWikiMsg( 'viewsourcetext' );
789 $out->addHTML( $this->editFormTextBeforeContent
);
790 $this->showTextbox( $text, 'wpTextbox1', [ 'readonly' ] );
791 $out->addHTML( $this->editFormTextAfterContent
);
793 $out->addHTML( $this->makeTemplatesOnThisPageList( $this->getTemplates() ) );
795 $out->addModules( 'mediawiki.action.edit.collapsibleFooter' );
797 $out->addHTML( $this->editFormTextBottom
);
798 if ( $this->mTitle
->exists() ) {
799 $out->returnToMain( null, $this->mTitle
);
804 * Should we show a preview when the edit form is first shown?
808 protected function previewOnOpen() {
809 $config = $this->context
->getConfig();
810 $previewOnOpenNamespaces = $config->get( 'PreviewOnOpenNamespaces' );
811 $request = $this->context
->getRequest();
812 if ( $config->get( 'RawHtml' ) ) {
813 // If raw HTML is enabled, disable preview on open
814 // since it has to be posted with a token for
818 if ( $request->getVal( 'preview' ) == 'yes' ) {
819 // Explicit override from request
821 } elseif ( $request->getVal( 'preview' ) == 'no' ) {
822 // Explicit override from request
824 } elseif ( $this->section
== 'new' ) {
825 // Nothing *to* preview for new sections
827 } elseif ( ( $request->getVal( 'preload' ) !== null ||
$this->mTitle
->exists() )
828 && $this->context
->getUser()->getOption( 'previewonfirst' )
830 // Standard preference behavior
832 } elseif ( !$this->mTitle
->exists()
833 && isset( $previewOnOpenNamespaces[$this->mTitle
->getNamespace()] )
834 && $previewOnOpenNamespaces[$this->mTitle
->getNamespace()]
836 // Categories are special
844 * Checks whether the user entered a skin name in uppercase,
845 * e.g. "User:Example/Monobook.css" instead of "monobook.css"
849 protected function isWrongCaseUserConfigPage() {
850 if ( $this->mTitle
->isUserConfigPage() ) {
851 $name = $this->mTitle
->getSkinFromConfigSubpage();
852 $skins = array_merge(
853 array_keys( Skin
::getSkinNames() ),
856 return !in_array( $name, $skins )
857 && in_array( strtolower( $name ), $skins );
864 * Returns whether section editing is supported for the current page.
865 * Subclasses may override this to replace the default behavior, which is
866 * to check ContentHandler::supportsSections.
868 * @return bool True if this edit page supports sections, false otherwise.
870 protected function isSectionEditSupported() {
871 $contentHandler = ContentHandler
::getForTitle( $this->mTitle
);
872 return $contentHandler->supportsSections();
876 * This function collects the form data and uses it to populate various member variables.
877 * @param WebRequest &$request
878 * @throws ErrorPageError
880 public function importFormData( &$request ) {
881 # Section edit can come from either the form or a link
882 $this->section
= $request->getVal( 'wpSection', $request->getVal( 'section' ) );
884 if ( $this->section
!== null && $this->section
!== '' && !$this->isSectionEditSupported() ) {
885 throw new ErrorPageError( 'sectioneditnotsupported-title', 'sectioneditnotsupported-text' );
888 $this->isNew
= !$this->mTitle
->exists() ||
$this->section
== 'new';
890 if ( $request->wasPosted() ) {
891 # These fields need to be checked for encoding.
892 # Also remove trailing whitespace, but don't remove _initial_
893 # whitespace from the text boxes. This may be significant formatting.
894 $this->textbox1
= rtrim( $request->getText( 'wpTextbox1' ) );
895 if ( !$request->getCheck( 'wpTextbox2' ) ) {
896 // Skip this if wpTextbox2 has input, it indicates that we came
897 // from a conflict page with raw page text, not a custom form
898 // modified by subclasses
899 $textbox1 = $this->importContentFormData( $request );
900 if ( $textbox1 !== null ) {
901 $this->textbox1
= $textbox1;
905 $this->unicodeCheck
= $request->getText( 'wpUnicodeCheck' );
907 $this->summary
= $request->getText( 'wpSummary' );
909 # If the summary consists of a heading, e.g. '==Foobar==', extract the title from the
910 # header syntax, e.g. 'Foobar'. This is mainly an issue when we are using wpSummary for
912 $this->summary
= preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->summary
);
914 # Treat sectiontitle the same way as summary.
915 # Note that wpSectionTitle is not yet a part of the actual edit form, as wpSummary is
916 # currently doing double duty as both edit summary and section title. Right now this
917 # is just to allow API edits to work around this limitation, but this should be
918 # incorporated into the actual edit form when EditPage is rewritten (Bugs 18654, 26312).
919 $this->sectiontitle
= $request->getText( 'wpSectionTitle' );
920 $this->sectiontitle
= preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->sectiontitle
);
922 $this->edittime
= $request->getVal( 'wpEdittime' );
923 $this->editRevId
= $request->getIntOrNull( 'editRevId' );
924 $this->starttime
= $request->getVal( 'wpStarttime' );
926 $undidRev = $request->getInt( 'wpUndidRevision' );
928 $this->undidRev
= $undidRev;
931 $this->scrolltop
= $request->getIntOrNull( 'wpScrolltop' );
933 if ( $this->textbox1
=== '' && $request->getVal( 'wpTextbox1' ) === null ) {
934 // wpTextbox1 field is missing, possibly due to being "too big"
935 // according to some filter rules such as Suhosin's setting for
936 // suhosin.request.max_value_length (d'oh)
937 $this->incompleteForm
= true;
939 // If we receive the last parameter of the request, we can fairly
940 // claim the POST request has not been truncated.
942 // TODO: softened the check for cutover. Once we determine
943 // that it is safe, we should complete the transition by
944 // removing the "edittime" clause.
945 $this->incompleteForm
= ( !$request->getVal( 'wpUltimateParam' )
946 && is_null( $this->edittime
) );
948 if ( $this->incompleteForm
) {
949 # If the form is incomplete, force to preview.
950 wfDebug( __METHOD__
. ": Form data appears to be incomplete\n" );
951 wfDebug( "POST DATA: " . var_export( $_POST, true ) . "\n" );
952 $this->preview
= true;
954 $this->preview
= $request->getCheck( 'wpPreview' );
955 $this->diff
= $request->getCheck( 'wpDiff' );
957 // Remember whether a save was requested, so we can indicate
958 // if we forced preview due to session failure.
959 $this->mTriedSave
= !$this->preview
;
961 if ( $this->tokenOk( $request ) ) {
962 # Some browsers will not report any submit button
963 # if the user hits enter in the comment box.
964 # The unmarked state will be assumed to be a save,
965 # if the form seems otherwise complete.
966 wfDebug( __METHOD__
. ": Passed token check.\n" );
967 } elseif ( $this->diff
) {
968 # Failed token check, but only requested "Show Changes".
969 wfDebug( __METHOD__
. ": Failed token check; Show Changes requested.\n" );
971 # Page might be a hack attempt posted from
972 # an external site. Preview instead of saving.
973 wfDebug( __METHOD__
. ": Failed token check; forcing preview\n" );
974 $this->preview
= true;
977 $this->save
= !$this->preview
&& !$this->diff
;
978 if ( !preg_match( '/^\d{14}$/', $this->edittime
) ) {
979 $this->edittime
= null;
982 if ( !preg_match( '/^\d{14}$/', $this->starttime
) ) {
983 $this->starttime
= null;
986 $this->recreate
= $request->getCheck( 'wpRecreate' );
988 $this->minoredit
= $request->getCheck( 'wpMinoredit' );
989 $this->watchthis
= $request->getCheck( 'wpWatchthis' );
991 $user = $this->context
->getUser();
992 # Don't force edit summaries when a user is editing their own user or talk page
993 if ( ( $this->mTitle
->mNamespace
== NS_USER ||
$this->mTitle
->mNamespace
== NS_USER_TALK
)
994 && $this->mTitle
->getText() == $user->getName()
996 $this->allowBlankSummary
= true;
998 $this->allowBlankSummary
= $request->getBool( 'wpIgnoreBlankSummary' )
999 ||
!$user->getOption( 'forceeditsummary' );
1002 $this->autoSumm
= $request->getText( 'wpAutoSummary' );
1004 $this->allowBlankArticle
= $request->getBool( 'wpIgnoreBlankArticle' );
1005 $this->allowSelfRedirect
= $request->getBool( 'wpIgnoreSelfRedirect' );
1007 $changeTags = $request->getVal( 'wpChangeTags' );
1008 if ( is_null( $changeTags ) ||
$changeTags === '' ) {
1009 $this->changeTags
= [];
1011 $this->changeTags
= array_filter( array_map( 'trim', explode( ',',
1015 # Not a posted form? Start with nothing.
1016 wfDebug( __METHOD__
. ": Not a posted form.\n" );
1017 $this->textbox1
= '';
1018 $this->summary
= '';
1019 $this->sectiontitle
= '';
1020 $this->edittime
= '';
1021 $this->editRevId
= null;
1022 $this->starttime
= wfTimestampNow();
1023 $this->edit
= false;
1024 $this->preview
= false;
1025 $this->save
= false;
1026 $this->diff
= false;
1027 $this->minoredit
= false;
1028 // Watch may be overridden by request parameters
1029 $this->watchthis
= $request->getBool( 'watchthis', false );
1030 $this->recreate
= false;
1032 // When creating a new section, we can preload a section title by passing it as the
1033 // preloadtitle parameter in the URL (T15100)
1034 if ( $this->section
== 'new' && $request->getVal( 'preloadtitle' ) ) {
1035 $this->sectiontitle
= $request->getVal( 'preloadtitle' );
1036 // Once wpSummary isn't being use for setting section titles, we should delete this.
1037 $this->summary
= $request->getVal( 'preloadtitle' );
1038 } elseif ( $this->section
!= 'new' && $request->getVal( 'summary' ) ) {
1039 $this->summary
= $request->getText( 'summary' );
1040 if ( $this->summary
!== '' ) {
1041 $this->hasPresetSummary
= true;
1045 if ( $request->getVal( 'minor' ) ) {
1046 $this->minoredit
= true;
1050 $this->oldid
= $request->getInt( 'oldid' );
1051 $this->parentRevId
= $request->getInt( 'parentRevId' );
1053 $this->bot
= $request->getBool( 'bot', true );
1054 $this->nosummary
= $request->getBool( 'nosummary' );
1056 // May be overridden by revision.
1057 $this->contentModel
= $request->getText( 'model', $this->contentModel
);
1058 // May be overridden by revision.
1059 $this->contentFormat
= $request->getText( 'format', $this->contentFormat
);
1062 $handler = ContentHandler
::getForModelID( $this->contentModel
);
1063 } catch ( MWUnknownContentModelException
$e ) {
1064 throw new ErrorPageError(
1065 'editpage-invalidcontentmodel-title',
1066 'editpage-invalidcontentmodel-text',
1067 [ wfEscapeWikiText( $this->contentModel
) ]
1071 if ( !$handler->isSupportedFormat( $this->contentFormat
) ) {
1072 throw new ErrorPageError(
1073 'editpage-notsupportedcontentformat-title',
1074 'editpage-notsupportedcontentformat-text',
1076 wfEscapeWikiText( $this->contentFormat
),
1077 wfEscapeWikiText( ContentHandler
::getLocalizedName( $this->contentModel
) )
1083 * @todo Check if the desired model is allowed in this namespace, and if
1084 * a transition from the page's current model to the new model is
1088 $this->editintro
= $request->getText( 'editintro',
1089 // Custom edit intro for new sections
1090 $this->section
=== 'new' ?
'MediaWiki:addsection-editintro' : '' );
1092 // Allow extensions to modify form data
1093 Hooks
::run( 'EditPage::importFormData', [ $this, $request ] );
1097 * Subpage overridable method for extracting the page content data from the
1098 * posted form to be placed in $this->textbox1, if using customized input
1099 * this method should be overridden and return the page text that will be used
1100 * for saving, preview parsing and so on...
1102 * @param WebRequest &$request
1103 * @return string|null
1105 protected function importContentFormData( &$request ) {
1106 return; // Don't do anything, EditPage already extracted wpTextbox1
1110 * Initialise form fields in the object
1111 * Called on the first invocation, e.g. when a user clicks an edit link
1112 * @return bool If the requested section is valid
1114 public function initialiseForm() {
1115 $this->edittime
= $this->page
->getTimestamp();
1116 $this->editRevId
= $this->page
->getLatest();
1118 $content = $this->getContentObject( false ); # TODO: track content object?!
1119 if ( $content === false ) {
1122 $this->textbox1
= $this->toEditText( $content );
1124 $user = $this->context
->getUser();
1125 // activate checkboxes if user wants them to be always active
1126 # Sort out the "watch" checkbox
1127 if ( $user->getOption( 'watchdefault' ) ) {
1129 $this->watchthis
= true;
1130 } elseif ( $user->getOption( 'watchcreations' ) && !$this->mTitle
->exists() ) {
1132 $this->watchthis
= true;
1133 } elseif ( $user->isWatched( $this->mTitle
) ) {
1135 $this->watchthis
= true;
1137 if ( $user->getOption( 'minordefault' ) && !$this->isNew
) {
1138 $this->minoredit
= true;
1140 if ( $this->textbox1
=== false ) {
1147 * @param Content|null $def_content The default value to return
1149 * @return Content|null Content on success, $def_content for invalid sections
1153 protected function getContentObject( $def_content = null ) {
1158 $user = $this->context
->getUser();
1159 $request = $this->context
->getRequest();
1160 // For message page not locally set, use the i18n message.
1161 // For other non-existent articles, use preload text if any.
1162 if ( !$this->mTitle
->exists() ||
$this->section
== 'new' ) {
1163 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
&& $this->section
!= 'new' ) {
1164 # If this is a system message, get the default text.
1165 $msg = $this->mTitle
->getDefaultMessageText();
1167 $content = $this->toEditContent( $msg );
1169 if ( $content === false ) {
1170 # If requested, preload some text.
1171 $preload = $request->getVal( 'preload',
1172 // Custom preload text for new sections
1173 $this->section
=== 'new' ?
'MediaWiki:addsection-preload' : '' );
1174 $params = $request->getArray( 'preloadparams', [] );
1176 $content = $this->getPreloadedContent( $preload, $params );
1178 // For existing pages, get text based on "undo" or section parameters.
1180 if ( $this->section
!= '' ) {
1181 // Get section edit text (returns $def_text for invalid sections)
1182 $orig = $this->getOriginalContent( $user );
1183 $content = $orig ?
$orig->getSection( $this->section
) : null;
1186 $content = $def_content;
1189 $undoafter = $request->getInt( 'undoafter' );
1190 $undo = $request->getInt( 'undo' );
1192 if ( $undo > 0 && $undoafter > 0 ) {
1193 $undorev = Revision
::newFromId( $undo );
1194 $oldrev = Revision
::newFromId( $undoafter );
1196 # Sanity check, make sure it's the right page,
1197 # the revisions exist and they were not deleted.
1198 # Otherwise, $content will be left as-is.
1199 if ( !is_null( $undorev ) && !is_null( $oldrev ) &&
1200 !$undorev->isDeleted( Revision
::DELETED_TEXT
) &&
1201 !$oldrev->isDeleted( Revision
::DELETED_TEXT
)
1203 $content = $this->page
->getUndoContent( $undorev, $oldrev );
1205 if ( $content === false ) {
1206 # Warn the user that something went wrong
1207 $undoMsg = 'failure';
1209 $oldContent = $this->page
->getContent( Revision
::RAW
);
1210 $popts = ParserOptions
::newFromUserAndLang( $user, $wgContLang );
1211 $newContent = $content->preSaveTransform( $this->mTitle
, $user, $popts );
1212 if ( $newContent->getModel() !== $oldContent->getModel() ) {
1213 // The undo may change content
1214 // model if its reverting the top
1215 // edit. This can result in
1216 // mismatched content model/format.
1217 $this->contentModel
= $newContent->getModel();
1218 $this->contentFormat
= $oldrev->getContentFormat();
1221 if ( $newContent->equals( $oldContent ) ) {
1222 # Tell the user that the undo results in no change,
1223 # i.e. the revisions were already undone.
1224 $undoMsg = 'nochange';
1227 # Inform the user of our success and set an automatic edit summary
1228 $undoMsg = 'success';
1230 # If we just undid one rev, use an autosummary
1231 $firstrev = $oldrev->getNext();
1232 if ( $firstrev && $firstrev->getId() == $undo ) {
1233 $userText = $undorev->getUserText();
1234 if ( $userText === '' ) {
1235 $undoSummary = $this->context
->msg(
1236 'undo-summary-username-hidden',
1238 )->inContentLanguage()->text();
1240 $undoSummary = $this->context
->msg(
1244 )->inContentLanguage()->text();
1246 if ( $this->summary
=== '' ) {
1247 $this->summary
= $undoSummary;
1249 $this->summary
= $undoSummary . $this->context
->msg( 'colon-separator' )
1250 ->inContentLanguage()->text() . $this->summary
;
1252 $this->undidRev
= $undo;
1254 $this->formtype
= 'diff';
1258 // Failed basic sanity checks.
1259 // Older revisions may have been removed since the link
1260 // was created, or we may simply have got bogus input.
1264 $out = $this->context
->getOutput();
1265 // Messages: undo-success, undo-failure, undo-norev, undo-nochange
1266 $class = ( $undoMsg == 'success' ?
'' : 'error ' ) . "mw-undo-{$undoMsg}";
1267 $this->editFormPageTop
.= $out->parse( "<div class=\"{$class}\">" .
1268 $this->context
->msg( 'undo-' . $undoMsg )->plain() . '</div>', true, /* interface */true );
1271 if ( $content === false ) {
1272 $content = $this->getOriginalContent( $user );
1281 * Get the content of the wanted revision, without section extraction.
1283 * The result of this function can be used to compare user's input with
1284 * section replaced in its context (using WikiPage::replaceSectionAtRev())
1285 * to the original text of the edit.
1287 * This differs from Article::getContent() that when a missing revision is
1288 * encountered the result will be null and not the
1289 * 'missing-revision' message.
1292 * @param User $user The user to get the revision for
1293 * @return Content|null
1295 private function getOriginalContent( User
$user ) {
1296 if ( $this->section
== 'new' ) {
1297 return $this->getCurrentContent();
1299 $revision = $this->mArticle
->getRevisionFetched();
1300 if ( $revision === null ) {
1301 $handler = ContentHandler
::getForModelID( $this->contentModel
);
1302 return $handler->makeEmptyContent();
1304 $content = $revision->getContent( Revision
::FOR_THIS_USER
, $user );
1309 * Get the edit's parent revision ID
1311 * The "parent" revision is the ancestor that should be recorded in this
1312 * page's revision history. It is either the revision ID of the in-memory
1313 * article content, or in the case of a 3-way merge in order to rebase
1314 * across a recoverable edit conflict, the ID of the newer revision to
1315 * which we have rebased this page.
1318 * @return int Revision ID
1320 public function getParentRevId() {
1321 if ( $this->parentRevId
) {
1322 return $this->parentRevId
;
1324 return $this->mArticle
->getRevIdFetched();
1329 * Get the current content of the page. This is basically similar to
1330 * WikiPage::getContent( Revision::RAW ) except that when the page doesn't exist an empty
1331 * content object is returned instead of null.
1336 protected function getCurrentContent() {
1337 $rev = $this->page
->getRevision();
1338 $content = $rev ?
$rev->getContent( Revision
::RAW
) : null;
1340 if ( $content === false ||
$content === null ) {
1341 $handler = ContentHandler
::getForModelID( $this->contentModel
);
1342 return $handler->makeEmptyContent();
1343 } elseif ( !$this->undidRev
) {
1344 // Content models should always be the same since we error
1345 // out if they are different before this point (in ->edit()).
1346 // The exception being, during an undo, the current revision might
1347 // differ from the prior revision.
1348 $logger = LoggerFactory
::getInstance( 'editpage' );
1349 if ( $this->contentModel
!== $rev->getContentModel() ) {
1350 $logger->warning( "Overriding content model from current edit {prev} to {new}", [
1351 'prev' => $this->contentModel
,
1352 'new' => $rev->getContentModel(),
1353 'title' => $this->getTitle()->getPrefixedDBkey(),
1354 'method' => __METHOD__
1356 $this->contentModel
= $rev->getContentModel();
1359 // Given that the content models should match, the current selected
1360 // format should be supported.
1361 if ( !$content->isSupportedFormat( $this->contentFormat
) ) {
1362 $logger->warning( "Current revision content format unsupported. Overriding {prev} to {new}", [
1364 'prev' => $this->contentFormat
,
1365 'new' => $rev->getContentFormat(),
1366 'title' => $this->getTitle()->getPrefixedDBkey(),
1367 'method' => __METHOD__
1369 $this->contentFormat
= $rev->getContentFormat();
1376 * Use this method before edit() to preload some content into the edit box
1378 * @param Content $content
1382 public function setPreloadedContent( Content
$content ) {
1383 $this->mPreloadContent
= $content;
1387 * Get the contents to be preloaded into the box, either set by
1388 * an earlier setPreloadText() or by loading the given page.
1390 * @param string $preload Representing the title to preload from.
1391 * @param array $params Parameters to use (interface-message style) in the preloaded text
1397 protected function getPreloadedContent( $preload, $params = [] ) {
1398 if ( !empty( $this->mPreloadContent
) ) {
1399 return $this->mPreloadContent
;
1402 $handler = ContentHandler
::getForModelID( $this->contentModel
);
1404 if ( $preload === '' ) {
1405 return $handler->makeEmptyContent();
1408 $user = $this->context
->getUser();
1409 $title = Title
::newFromText( $preload );
1410 # Check for existence to avoid getting MediaWiki:Noarticletext
1411 if ( $title === null ||
!$title->exists() ||
!$title->userCan( 'read', $user ) ) {
1412 // TODO: somehow show a warning to the user!
1413 return $handler->makeEmptyContent();
1416 $page = WikiPage
::factory( $title );
1417 if ( $page->isRedirect() ) {
1418 $title = $page->getRedirectTarget();
1420 if ( $title === null ||
!$title->exists() ||
!$title->userCan( 'read', $user ) ) {
1421 // TODO: somehow show a warning to the user!
1422 return $handler->makeEmptyContent();
1424 $page = WikiPage
::factory( $title );
1427 $parserOptions = ParserOptions
::newFromUser( $user );
1428 $content = $page->getContent( Revision
::RAW
);
1431 // TODO: somehow show a warning to the user!
1432 return $handler->makeEmptyContent();
1435 if ( $content->getModel() !== $handler->getModelID() ) {
1436 $converted = $content->convert( $handler->getModelID() );
1438 if ( !$converted ) {
1439 // TODO: somehow show a warning to the user!
1440 wfDebug( "Attempt to preload incompatible content: " .
1441 "can't convert " . $content->getModel() .
1442 " to " . $handler->getModelID() );
1444 return $handler->makeEmptyContent();
1447 $content = $converted;
1450 return $content->preloadTransform( $title, $parserOptions, $params );
1454 * Make sure the form isn't faking a user's credentials.
1456 * @param WebRequest &$request
1460 public function tokenOk( &$request ) {
1461 $token = $request->getVal( 'wpEditToken' );
1462 $user = $this->context
->getUser();
1463 $this->mTokenOk
= $user->matchEditToken( $token );
1464 $this->mTokenOkExceptSuffix
= $user->matchEditTokenNoSuffix( $token );
1465 return $this->mTokenOk
;
1469 * Sets post-edit cookie indicating the user just saved a particular revision.
1471 * This uses a temporary cookie for each revision ID so separate saves will never
1472 * interfere with each other.
1474 * Article::view deletes the cookie on server-side after the redirect and
1475 * converts the value to the global JavaScript variable wgPostEdit.
1477 * If the variable were set on the server, it would be cached, which is unwanted
1478 * since the post-edit state should only apply to the load right after the save.
1480 * @param int $statusValue The status value (to check for new article status)
1482 protected function setPostEditCookie( $statusValue ) {
1483 $revisionId = $this->page
->getLatest();
1484 $postEditKey = self
::POST_EDIT_COOKIE_KEY_PREFIX
. $revisionId;
1487 if ( $statusValue == self
::AS_SUCCESS_NEW_ARTICLE
) {
1489 } elseif ( $this->oldid
) {
1493 $response = $this->context
->getRequest()->response();
1494 $response->setCookie( $postEditKey, $val, time() + self
::POST_EDIT_COOKIE_DURATION
);
1498 * Attempt submission
1499 * @param array|bool &$resultDetails See docs for $result in internalAttemptSave
1500 * @throws UserBlockedError|ReadOnlyError|ThrottledError|PermissionsError
1501 * @return Status The resulting status object.
1503 public function attemptSave( &$resultDetails = false ) {
1504 # Allow bots to exempt some edits from bot flagging
1505 $bot = $this->context
->getUser()->isAllowed( 'bot' ) && $this->bot
;
1506 $status = $this->internalAttemptSave( $resultDetails, $bot );
1508 Hooks
::run( 'EditPage::attemptSave:after', [ $this, $status, $resultDetails ] );
1514 * Log when a page was successfully saved after the edit conflict view
1516 private function incrementResolvedConflicts() {
1517 if ( $this->context
->getRequest()->getText( 'mode' ) !== 'conflict' ) {
1521 $this->getEditConflictHelper()->incrementResolvedStats();
1525 * Handle status, such as after attempt save
1527 * @param Status $status
1528 * @param array|bool $resultDetails
1530 * @throws ErrorPageError
1531 * @return bool False, if output is done, true if rest of the form should be displayed
1533 private function handleStatus( Status
$status, $resultDetails ) {
1535 * @todo FIXME: once the interface for internalAttemptSave() is made
1536 * nicer, this should use the message in $status
1538 if ( $status->value
== self
::AS_SUCCESS_UPDATE
1539 ||
$status->value
== self
::AS_SUCCESS_NEW_ARTICLE
1541 $this->incrementResolvedConflicts();
1543 $this->didSave
= true;
1544 if ( !$resultDetails['nullEdit'] ) {
1545 $this->setPostEditCookie( $status->value
);
1549 $out = $this->context
->getOutput();
1551 // "wpExtraQueryRedirect" is a hidden input to modify
1552 // after save URL and is not used by actual edit form
1553 $request = $this->context
->getRequest();
1554 $extraQueryRedirect = $request->getVal( 'wpExtraQueryRedirect' );
1556 switch ( $status->value
) {
1557 case self
::AS_HOOK_ERROR_EXPECTED
:
1558 case self
::AS_CONTENT_TOO_BIG
:
1559 case self
::AS_ARTICLE_WAS_DELETED
:
1560 case self
::AS_CONFLICT_DETECTED
:
1561 case self
::AS_SUMMARY_NEEDED
:
1562 case self
::AS_TEXTBOX_EMPTY
:
1563 case self
::AS_MAX_ARTICLE_SIZE_EXCEEDED
:
1565 case self
::AS_BLANK_ARTICLE
:
1566 case self
::AS_SELF_REDIRECT
:
1569 case self
::AS_HOOK_ERROR
:
1572 case self
::AS_CANNOT_USE_CUSTOM_MODEL
:
1573 case self
::AS_PARSE_ERROR
:
1574 case self
::AS_UNICODE_NOT_SUPPORTED
:
1575 $out->addWikiText( '<div class="error">' . "\n" . $status->getWikiText() . '</div>' );
1578 case self
::AS_SUCCESS_NEW_ARTICLE
:
1579 $query = $resultDetails['redirect'] ?
'redirect=no' : '';
1580 if ( $extraQueryRedirect ) {
1581 if ( $query === '' ) {
1582 $query = $extraQueryRedirect;
1584 $query = $query . '&' . $extraQueryRedirect;
1587 $anchor = isset( $resultDetails['sectionanchor'] ) ?
$resultDetails['sectionanchor'] : '';
1588 $out->redirect( $this->mTitle
->getFullURL( $query ) . $anchor );
1591 case self
::AS_SUCCESS_UPDATE
:
1593 $sectionanchor = $resultDetails['sectionanchor'];
1595 // Give extensions a chance to modify URL query on update
1597 'ArticleUpdateBeforeRedirect',
1598 [ $this->mArticle
, &$sectionanchor, &$extraQuery ]
1601 if ( $resultDetails['redirect'] ) {
1602 if ( $extraQuery == '' ) {
1603 $extraQuery = 'redirect=no';
1605 $extraQuery = 'redirect=no&' . $extraQuery;
1608 if ( $extraQueryRedirect ) {
1609 if ( $extraQuery === '' ) {
1610 $extraQuery = $extraQueryRedirect;
1612 $extraQuery = $extraQuery . '&' . $extraQueryRedirect;
1616 $out->redirect( $this->mTitle
->getFullURL( $extraQuery ) . $sectionanchor );
1619 case self
::AS_SPAM_ERROR
:
1620 $this->spamPageWithContent( $resultDetails['spam'] );
1623 case self
::AS_BLOCKED_PAGE_FOR_USER
:
1624 throw new UserBlockedError( $this->context
->getUser()->getBlock() );
1626 case self
::AS_IMAGE_REDIRECT_ANON
:
1627 case self
::AS_IMAGE_REDIRECT_LOGGED
:
1628 throw new PermissionsError( 'upload' );
1630 case self
::AS_READ_ONLY_PAGE_ANON
:
1631 case self
::AS_READ_ONLY_PAGE_LOGGED
:
1632 throw new PermissionsError( 'edit' );
1634 case self
::AS_READ_ONLY_PAGE
:
1635 throw new ReadOnlyError
;
1637 case self
::AS_RATE_LIMITED
:
1638 throw new ThrottledError();
1640 case self
::AS_NO_CREATE_PERMISSION
:
1641 $permission = $this->mTitle
->isTalkPage() ?
'createtalk' : 'createpage';
1642 throw new PermissionsError( $permission );
1644 case self
::AS_NO_CHANGE_CONTENT_MODEL
:
1645 throw new PermissionsError( 'editcontentmodel' );
1648 // We don't recognize $status->value. The only way that can happen
1649 // is if an extension hook aborted from inside ArticleSave.
1650 // Render the status object into $this->hookError
1651 // FIXME this sucks, we should just use the Status object throughout
1652 $this->hookError
= '<div class="error">' ."\n" . $status->getWikiText() .
1659 * Run hooks that can filter edits just before they get saved.
1661 * @param Content $content The Content to filter.
1662 * @param Status $status For reporting the outcome to the caller
1663 * @param User $user The user performing the edit
1667 protected function runPostMergeFilters( Content
$content, Status
$status, User
$user ) {
1668 // Run old style post-section-merge edit filter
1669 if ( $this->hookError
!= '' ) {
1670 # ...or the hook could be expecting us to produce an error
1671 $status->fatal( 'hookaborted' );
1672 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1676 // Run new style post-section-merge edit filter
1677 if ( !Hooks
::run( 'EditFilterMergedContent',
1678 [ $this->context
, $content, $status, $this->summary
,
1679 $user, $this->minoredit
] )
1681 # Error messages etc. could be handled within the hook...
1682 if ( $status->isGood() ) {
1683 $status->fatal( 'hookaborted' );
1684 // Not setting $this->hookError here is a hack to allow the hook
1685 // to cause a return to the edit page without $this->hookError
1686 // being set. This is used by ConfirmEdit to display a captcha
1687 // without any error message cruft.
1689 $this->hookError
= $this->formatStatusErrors( $status );
1691 // Use the existing $status->value if the hook set it
1692 if ( !$status->value
) {
1693 $status->value
= self
::AS_HOOK_ERROR
;
1696 } elseif ( !$status->isOK() ) {
1697 # ...or the hook could be expecting us to produce an error
1698 // FIXME this sucks, we should just use the Status object throughout
1699 $this->hookError
= $this->formatStatusErrors( $status );
1700 $status->fatal( 'hookaborted' );
1701 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1709 * Wrap status errors in an errorbox for increased visibility
1711 * @param Status $status
1712 * @return string Wikitext
1714 private function formatStatusErrors( Status
$status ) {
1715 $errmsg = $status->getWikiText(
1718 $this->context
->getLanguage()
1721 <div class="errorbox">
1729 * Return the summary to be used for a new section.
1731 * @param string $sectionanchor Set to the section anchor text
1734 private function newSectionSummary( &$sectionanchor = null ) {
1737 if ( $this->sectiontitle
!== '' ) {
1738 $sectionanchor = $this->guessSectionName( $this->sectiontitle
);
1739 // If no edit summary was specified, create one automatically from the section
1740 // title and have it link to the new section. Otherwise, respect the summary as
1742 if ( $this->summary
=== '' ) {
1743 $cleanSectionTitle = $wgParser->stripSectionName( $this->sectiontitle
);
1744 return $this->context
->msg( 'newsectionsummary' )
1745 ->rawParams( $cleanSectionTitle )->inContentLanguage()->text();
1747 } elseif ( $this->summary
!== '' ) {
1748 $sectionanchor = $this->guessSectionName( $this->summary
);
1749 # This is a new section, so create a link to the new section
1750 # in the revision summary.
1751 $cleanSummary = $wgParser->stripSectionName( $this->summary
);
1752 return $this->context
->msg( 'newsectionsummary' )
1753 ->rawParams( $cleanSummary )->inContentLanguage()->text();
1755 return $this->summary
;
1759 * Attempt submission (no UI)
1761 * @param array &$result Array to add statuses to, currently with the
1763 * - spam (string): Spam string from content if any spam is detected by
1765 * - sectionanchor (string): Section anchor for a section save.
1766 * - nullEdit (bool): Set if doEditContent is OK. True if null edit,
1768 * - redirect (bool): Set if doEditContent is OK. True if resulting
1769 * revision is a redirect.
1770 * @param bool $bot True if edit is being made under the bot right.
1772 * @return Status Status object, possibly with a message, but always with
1773 * one of the AS_* constants in $status->value,
1775 * @todo FIXME: This interface is TERRIBLE, but hard to get rid of due to
1776 * various error display idiosyncrasies. There are also lots of cases
1777 * where error metadata is set in the object and retrieved later instead
1778 * of being returned, e.g. AS_CONTENT_TOO_BIG and
1779 * AS_BLOCKED_PAGE_FOR_USER. All that stuff needs to be cleaned up some
1782 public function internalAttemptSave( &$result, $bot = false ) {
1783 $status = Status
::newGood();
1784 $user = $this->context
->getUser();
1786 if ( !Hooks
::run( 'EditPage::attemptSave', [ $this ] ) ) {
1787 wfDebug( "Hook 'EditPage::attemptSave' aborted article saving\n" );
1788 $status->fatal( 'hookaborted' );
1789 $status->value
= self
::AS_HOOK_ERROR
;
1793 if ( $this->unicodeCheck
!== self
::UNICODE_CHECK
) {
1794 $status->fatal( 'unicode-support-fail' );
1795 $status->value
= self
::AS_UNICODE_NOT_SUPPORTED
;
1799 $request = $this->context
->getRequest();
1800 $spam = $request->getText( 'wpAntispam' );
1801 if ( $spam !== '' ) {
1806 $this->mTitle
->getPrefixedText() .
1807 '" submitted bogus field "' .
1811 $status->fatal( 'spamprotectionmatch', false );
1812 $status->value
= self
::AS_SPAM_ERROR
;
1817 # Construct Content object
1818 $textbox_content = $this->toEditContent( $this->textbox1
);
1819 } catch ( MWContentSerializationException
$ex ) {
1821 'content-failed-to-parse',
1822 $this->contentModel
,
1823 $this->contentFormat
,
1826 $status->value
= self
::AS_PARSE_ERROR
;
1830 # Check image redirect
1831 if ( $this->mTitle
->getNamespace() == NS_FILE
&&
1832 $textbox_content->isRedirect() &&
1833 !$user->isAllowed( 'upload' )
1835 $code = $user->isAnon() ? self
::AS_IMAGE_REDIRECT_ANON
: self
::AS_IMAGE_REDIRECT_LOGGED
;
1836 $status->setResult( false, $code );
1842 $match = self
::matchSummarySpamRegex( $this->summary
);
1843 if ( $match === false && $this->section
== 'new' ) {
1844 # $wgSpamRegex is enforced on this new heading/summary because, unlike
1845 # regular summaries, it is added to the actual wikitext.
1846 if ( $this->sectiontitle
!== '' ) {
1847 # This branch is taken when the API is used with the 'sectiontitle' parameter.
1848 $match = self
::matchSpamRegex( $this->sectiontitle
);
1850 # This branch is taken when the "Add Topic" user interface is used, or the API
1851 # is used with the 'summary' parameter.
1852 $match = self
::matchSpamRegex( $this->summary
);
1855 if ( $match === false ) {
1856 $match = self
::matchSpamRegex( $this->textbox1
);
1858 if ( $match !== false ) {
1859 $result['spam'] = $match;
1860 $ip = $request->getIP();
1861 $pdbk = $this->mTitle
->getPrefixedDBkey();
1862 $match = str_replace( "\n", '', $match );
1863 wfDebugLog( 'SpamRegex', "$ip spam regex hit [[$pdbk]]: \"$match\"" );
1864 $status->fatal( 'spamprotectionmatch', $match );
1865 $status->value
= self
::AS_SPAM_ERROR
;
1870 [ $this, $this->textbox1
, $this->section
, &$this->hookError
, $this->summary
] )
1872 # Error messages etc. could be handled within the hook...
1873 $status->fatal( 'hookaborted' );
1874 $status->value
= self
::AS_HOOK_ERROR
;
1876 } elseif ( $this->hookError
!= '' ) {
1877 # ...or the hook could be expecting us to produce an error
1878 $status->fatal( 'hookaborted' );
1879 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1883 if ( $user->isBlockedFrom( $this->mTitle
, false ) ) {
1884 // Auto-block user's IP if the account was "hard" blocked
1885 if ( !wfReadOnly() ) {
1886 $user->spreadAnyEditBlock();
1888 # Check block state against master, thus 'false'.
1889 $status->setResult( false, self
::AS_BLOCKED_PAGE_FOR_USER
);
1893 $this->contentLength
= strlen( $this->textbox1
);
1894 $config = $this->context
->getConfig();
1895 $maxArticleSize = $config->get( 'MaxArticleSize' );
1896 if ( $this->contentLength
> $maxArticleSize * 1024 ) {
1897 // Error will be displayed by showEditForm()
1898 $this->tooBig
= true;
1899 $status->setResult( false, self
::AS_CONTENT_TOO_BIG
);
1903 if ( !$user->isAllowed( 'edit' ) ) {
1904 if ( $user->isAnon() ) {
1905 $status->setResult( false, self
::AS_READ_ONLY_PAGE_ANON
);
1908 $status->fatal( 'readonlytext' );
1909 $status->value
= self
::AS_READ_ONLY_PAGE_LOGGED
;
1914 $changingContentModel = false;
1915 if ( $this->contentModel
!== $this->mTitle
->getContentModel() ) {
1916 if ( !$config->get( 'ContentHandlerUseDB' ) ) {
1917 $status->fatal( 'editpage-cannot-use-custom-model' );
1918 $status->value
= self
::AS_CANNOT_USE_CUSTOM_MODEL
;
1920 } elseif ( !$user->isAllowed( 'editcontentmodel' ) ) {
1921 $status->setResult( false, self
::AS_NO_CHANGE_CONTENT_MODEL
);
1924 // Make sure the user can edit the page under the new content model too
1925 $titleWithNewContentModel = clone $this->mTitle
;
1926 $titleWithNewContentModel->setContentModel( $this->contentModel
);
1927 if ( !$titleWithNewContentModel->userCan( 'editcontentmodel', $user )
1928 ||
!$titleWithNewContentModel->userCan( 'edit', $user )
1930 $status->setResult( false, self
::AS_NO_CHANGE_CONTENT_MODEL
);
1934 $changingContentModel = true;
1935 $oldContentModel = $this->mTitle
->getContentModel();
1938 if ( $this->changeTags
) {
1939 $changeTagsStatus = ChangeTags
::canAddTagsAccompanyingChange(
1940 $this->changeTags
, $user );
1941 if ( !$changeTagsStatus->isOK() ) {
1942 $changeTagsStatus->value
= self
::AS_CHANGE_TAG_ERROR
;
1943 return $changeTagsStatus;
1947 if ( wfReadOnly() ) {
1948 $status->fatal( 'readonlytext' );
1949 $status->value
= self
::AS_READ_ONLY_PAGE
;
1952 if ( $user->pingLimiter() ||
$user->pingLimiter( 'linkpurge', 0 )
1953 ||
( $changingContentModel && $user->pingLimiter( 'editcontentmodel' ) )
1955 $status->fatal( 'actionthrottledtext' );
1956 $status->value
= self
::AS_RATE_LIMITED
;
1960 # If the article has been deleted while editing, don't save it without
1962 if ( $this->wasDeletedSinceLastEdit() && !$this->recreate
) {
1963 $status->setResult( false, self
::AS_ARTICLE_WAS_DELETED
);
1967 # Load the page data from the master. If anything changes in the meantime,
1968 # we detect it by using page_latest like a token in a 1 try compare-and-swap.
1969 $this->page
->loadPageData( 'fromdbmaster' );
1970 $new = !$this->page
->exists();
1973 // Late check for create permission, just in case *PARANOIA*
1974 if ( !$this->mTitle
->userCan( 'create', $user ) ) {
1975 $status->fatal( 'nocreatetext' );
1976 $status->value
= self
::AS_NO_CREATE_PERMISSION
;
1977 wfDebug( __METHOD__
. ": no create permission\n" );
1981 // Don't save a new page if it's blank or if it's a MediaWiki:
1982 // message with content equivalent to default (allow empty pages
1983 // in this case to disable messages, see T52124)
1984 $defaultMessageText = $this->mTitle
->getDefaultMessageText();
1985 if ( $this->mTitle
->getNamespace() === NS_MEDIAWIKI
&& $defaultMessageText !== false ) {
1986 $defaultText = $defaultMessageText;
1991 if ( !$this->allowBlankArticle
&& $this->textbox1
=== $defaultText ) {
1992 $this->blankArticle
= true;
1993 $status->fatal( 'blankarticle' );
1994 $status->setResult( false, self
::AS_BLANK_ARTICLE
);
1998 if ( !$this->runPostMergeFilters( $textbox_content, $status, $user ) ) {
2002 $content = $textbox_content;
2004 $result['sectionanchor'] = '';
2005 if ( $this->section
== 'new' ) {
2006 if ( $this->sectiontitle
!== '' ) {
2007 // Insert the section title above the content.
2008 $content = $content->addSectionHeader( $this->sectiontitle
);
2009 } elseif ( $this->summary
!== '' ) {
2010 // Insert the section title above the content.
2011 $content = $content->addSectionHeader( $this->summary
);
2013 $this->summary
= $this->newSectionSummary( $result['sectionanchor'] );
2016 $status->value
= self
::AS_SUCCESS_NEW_ARTICLE
;
2020 # Article exists. Check for edit conflict.
2022 $this->page
->clear(); # Force reload of dates, etc.
2023 $timestamp = $this->page
->getTimestamp();
2024 $latest = $this->page
->getLatest();
2026 wfDebug( "timestamp: {$timestamp}, edittime: {$this->edittime}\n" );
2028 // Check editRevId if set, which handles same-second timestamp collisions
2029 if ( $timestamp != $this->edittime
2030 ||
( $this->editRevId
!== null && $this->editRevId
!= $latest )
2032 $this->isConflict
= true;
2033 if ( $this->section
== 'new' ) {
2034 if ( $this->page
->getUserText() == $user->getName() &&
2035 $this->page
->getComment() == $this->newSectionSummary()
2037 // Probably a duplicate submission of a new comment.
2038 // This can happen when CDN resends a request after
2039 // a timeout but the first one actually went through.
2041 . ": duplicate new section submission; trigger edit conflict!\n" );
2043 // New comment; suppress conflict.
2044 $this->isConflict
= false;
2045 wfDebug( __METHOD__
. ": conflict suppressed; new section\n" );
2047 } elseif ( $this->section
== ''
2048 && Revision
::userWasLastToEdit(
2049 DB_MASTER
, $this->mTitle
->getArticleID(),
2050 $user->getId(), $this->edittime
2053 # Suppress edit conflict with self, except for section edits where merging is required.
2054 wfDebug( __METHOD__
. ": Suppressing edit conflict, same user.\n" );
2055 $this->isConflict
= false;
2059 // If sectiontitle is set, use it, otherwise use the summary as the section title.
2060 if ( $this->sectiontitle
!== '' ) {
2061 $sectionTitle = $this->sectiontitle
;
2063 $sectionTitle = $this->summary
;
2068 if ( $this->isConflict
) {
2070 . ": conflict! getting section '{$this->section}' for time '{$this->edittime}'"
2071 . " (id '{$this->editRevId}') (article time '{$timestamp}')\n" );
2072 // @TODO: replaceSectionAtRev() with base ID (not prior current) for ?oldid=X case
2073 // ...or disable section editing for non-current revisions (not exposed anyway).
2074 if ( $this->editRevId
!== null ) {
2075 $content = $this->page
->replaceSectionAtRev(
2082 $content = $this->page
->replaceSectionContent(
2090 wfDebug( __METHOD__
. ": getting section '{$this->section}'\n" );
2091 $content = $this->page
->replaceSectionContent(
2098 if ( is_null( $content ) ) {
2099 wfDebug( __METHOD__
. ": activating conflict; section replace failed.\n" );
2100 $this->isConflict
= true;
2101 $content = $textbox_content; // do not try to merge here!
2102 } elseif ( $this->isConflict
) {
2104 if ( $this->mergeChangesIntoContent( $content ) ) {
2105 // Successful merge! Maybe we should tell the user the good news?
2106 $this->isConflict
= false;
2107 wfDebug( __METHOD__
. ": Suppressing edit conflict, successful merge.\n" );
2109 $this->section
= '';
2110 $this->textbox1
= ContentHandler
::getContentText( $content );
2111 wfDebug( __METHOD__
. ": Keeping edit conflict, failed merge.\n" );
2115 if ( $this->isConflict
) {
2116 $status->setResult( false, self
::AS_CONFLICT_DETECTED
);
2120 if ( !$this->runPostMergeFilters( $content, $status, $user ) ) {
2124 if ( $this->section
== 'new' ) {
2125 // Handle the user preference to force summaries here
2126 if ( !$this->allowBlankSummary
&& trim( $this->summary
) == '' ) {
2127 $this->missingSummary
= true;
2128 $status->fatal( 'missingsummary' ); // or 'missingcommentheader' if $section == 'new'. Blegh
2129 $status->value
= self
::AS_SUMMARY_NEEDED
;
2133 // Do not allow the user to post an empty comment
2134 if ( $this->textbox1
== '' ) {
2135 $this->missingComment
= true;
2136 $status->fatal( 'missingcommenttext' );
2137 $status->value
= self
::AS_TEXTBOX_EMPTY
;
2140 } elseif ( !$this->allowBlankSummary
2141 && !$content->equals( $this->getOriginalContent( $user ) )
2142 && !$content->isRedirect()
2143 && md5( $this->summary
) == $this->autoSumm
2145 $this->missingSummary
= true;
2146 $status->fatal( 'missingsummary' );
2147 $status->value
= self
::AS_SUMMARY_NEEDED
;
2152 $sectionanchor = '';
2153 if ( $this->section
== 'new' ) {
2154 $this->summary
= $this->newSectionSummary( $sectionanchor );
2155 } elseif ( $this->section
!= '' ) {
2156 # Try to get a section anchor from the section source, redirect
2157 # to edited section if header found.
2158 # XXX: Might be better to integrate this into Article::replaceSectionAtRev
2159 # for duplicate heading checking and maybe parsing.
2160 $hasmatch = preg_match( "/^ *([=]{1,6})(.*?)(\\1) *\\n/i", $this->textbox1
, $matches );
2161 # We can't deal with anchors, includes, html etc in the header for now,
2162 # headline would need to be parsed to improve this.
2163 if ( $hasmatch && strlen( $matches[2] ) > 0 ) {
2164 $sectionanchor = $this->guessSectionName( $matches[2] );
2167 $result['sectionanchor'] = $sectionanchor;
2169 // Save errors may fall down to the edit form, but we've now
2170 // merged the section into full text. Clear the section field
2171 // so that later submission of conflict forms won't try to
2172 // replace that into a duplicated mess.
2173 $this->textbox1
= $this->toEditText( $content );
2174 $this->section
= '';
2176 $status->value
= self
::AS_SUCCESS_UPDATE
;
2179 if ( !$this->allowSelfRedirect
2180 && $content->isRedirect()
2181 && $content->getRedirectTarget()->equals( $this->getTitle() )
2183 // If the page already redirects to itself, don't warn.
2184 $currentTarget = $this->getCurrentContent()->getRedirectTarget();
2185 if ( !$currentTarget ||
!$currentTarget->equals( $this->getTitle() ) ) {
2186 $this->selfRedirect
= true;
2187 $status->fatal( 'selfredirect' );
2188 $status->value
= self
::AS_SELF_REDIRECT
;
2193 // Check for length errors again now that the section is merged in
2194 $this->contentLength
= strlen( $this->toEditText( $content ) );
2195 if ( $this->contentLength
> $maxArticleSize * 1024 ) {
2196 $this->tooBig
= true;
2197 $status->setResult( false, self
::AS_MAX_ARTICLE_SIZE_EXCEEDED
);
2201 $flags = EDIT_AUTOSUMMARY |
2202 ( $new ? EDIT_NEW
: EDIT_UPDATE
) |
2203 ( ( $this->minoredit
&& !$this->isNew
) ? EDIT_MINOR
: 0 ) |
2204 ( $bot ? EDIT_FORCE_BOT
: 0 );
2206 $doEditStatus = $this->page
->doEditContent(
2212 $content->getDefaultFormat(),
2217 if ( !$doEditStatus->isOK() ) {
2218 // Failure from doEdit()
2219 // Show the edit conflict page for certain recognized errors from doEdit(),
2220 // but don't show it for errors from extension hooks
2221 $errors = $doEditStatus->getErrorsArray();
2222 if ( in_array( $errors[0][0],
2223 [ 'edit-gone-missing', 'edit-conflict', 'edit-already-exists' ] )
2225 $this->isConflict
= true;
2226 // Destroys data doEdit() put in $status->value but who cares
2227 $doEditStatus->value
= self
::AS_END
;
2229 return $doEditStatus;
2232 $result['nullEdit'] = $doEditStatus->hasMessage( 'edit-no-change' );
2233 if ( $result['nullEdit'] ) {
2234 // We don't know if it was a null edit until now, so increment here
2235 $user->pingLimiter( 'linkpurge' );
2237 $result['redirect'] = $content->isRedirect();
2239 $this->updateWatchlist();
2241 // If the content model changed, add a log entry
2242 if ( $changingContentModel ) {
2243 $this->addContentModelChangeLogEntry(
2245 $new ?
false : $oldContentModel,
2246 $this->contentModel
,
2256 * @param string|false $oldModel false if the page is being newly created
2257 * @param string $newModel
2258 * @param string $reason
2260 protected function addContentModelChangeLogEntry( User
$user, $oldModel, $newModel, $reason ) {
2261 $new = $oldModel === false;
2262 $log = new ManualLogEntry( 'contentmodel', $new ?
'new' : 'change' );
2263 $log->setPerformer( $user );
2264 $log->setTarget( $this->mTitle
);
2265 $log->setComment( $reason );
2266 $log->setParameters( [
2267 '4::oldmodel' => $oldModel,
2268 '5::newmodel' => $newModel
2270 $logid = $log->insert();
2271 $log->publish( $logid );
2275 * Register the change of watch status
2277 protected function updateWatchlist() {
2278 $user = $this->context
->getUser();
2279 if ( !$user->isLoggedIn() ) {
2283 $title = $this->mTitle
;
2284 $watch = $this->watchthis
;
2285 // Do this in its own transaction to reduce contention...
2286 DeferredUpdates
::addCallableUpdate( function () use ( $user, $title, $watch ) {
2287 if ( $watch == $user->isWatched( $title, User
::IGNORE_USER_RIGHTS
) ) {
2288 return; // nothing to change
2290 WatchAction
::doWatchOrUnwatch( $watch, $title, $user );
2295 * Attempts to do 3-way merge of edit content with a base revision
2296 * and current content, in case of edit conflict, in whichever way appropriate
2297 * for the content type.
2301 * @param Content $editContent
2305 private function mergeChangesIntoContent( &$editContent ) {
2306 $db = wfGetDB( DB_MASTER
);
2308 // This is the revision the editor started from
2309 $baseRevision = $this->getBaseRevision();
2310 $baseContent = $baseRevision ?
$baseRevision->getContent() : null;
2312 if ( is_null( $baseContent ) ) {
2316 // The current state, we want to merge updates into it
2317 $currentRevision = Revision
::loadFromTitle( $db, $this->mTitle
);
2318 $currentContent = $currentRevision ?
$currentRevision->getContent() : null;
2320 if ( is_null( $currentContent ) ) {
2324 $handler = ContentHandler
::getForModelID( $baseContent->getModel() );
2326 $result = $handler->merge3( $baseContent, $editContent, $currentContent );
2329 $editContent = $result;
2330 // Update parentRevId to what we just merged.
2331 $this->parentRevId
= $currentRevision->getId();
2339 * @note: this method is very poorly named. If the user opened the form with ?oldid=X,
2340 * one might think of X as the "base revision", which is NOT what this returns.
2341 * @return Revision|null Current version when the edit was started
2343 public function getBaseRevision() {
2344 if ( !$this->mBaseRevision
) {
2345 $db = wfGetDB( DB_MASTER
);
2346 $this->mBaseRevision
= $this->editRevId
2347 ? Revision
::newFromId( $this->editRevId
, Revision
::READ_LATEST
)
2348 : Revision
::loadFromTimestamp( $db, $this->mTitle
, $this->edittime
);
2350 return $this->mBaseRevision
;
2354 * Check given input text against $wgSpamRegex, and return the text of the first match.
2356 * @param string $text
2358 * @return string|bool Matching string or false
2360 public static function matchSpamRegex( $text ) {
2361 global $wgSpamRegex;
2362 // For back compatibility, $wgSpamRegex may be a single string or an array of regexes.
2363 $regexes = (array)$wgSpamRegex;
2364 return self
::matchSpamRegexInternal( $text, $regexes );
2368 * Check given input text against $wgSummarySpamRegex, and return the text of the first match.
2370 * @param string $text
2372 * @return string|bool Matching string or false
2374 public static function matchSummarySpamRegex( $text ) {
2375 global $wgSummarySpamRegex;
2376 $regexes = (array)$wgSummarySpamRegex;
2377 return self
::matchSpamRegexInternal( $text, $regexes );
2381 * @param string $text
2382 * @param array $regexes
2383 * @return bool|string
2385 protected static function matchSpamRegexInternal( $text, $regexes ) {
2386 foreach ( $regexes as $regex ) {
2388 if ( preg_match( $regex, $text, $matches ) ) {
2395 public function setHeaders() {
2396 $out = $this->context
->getOutput();
2398 $out->addModules( 'mediawiki.action.edit' );
2399 $out->addModuleStyles( 'mediawiki.action.edit.styles' );
2400 $out->addModuleStyles( 'mediawiki.editfont.styles' );
2402 $user = $this->context
->getUser();
2403 if ( $user->getOption( 'showtoolbar' ) ) {
2404 // The addition of default buttons is handled by getEditToolbar() which
2405 // has its own dependency on this module. The call here ensures the module
2406 // is loaded in time (it has position "top") for other modules to register
2407 // buttons (e.g. extensions, gadgets, user scripts).
2408 $out->addModules( 'mediawiki.toolbar' );
2411 if ( $user->getOption( 'uselivepreview' ) ) {
2412 $out->addModules( 'mediawiki.action.edit.preview' );
2415 if ( $user->getOption( 'useeditwarning' ) ) {
2416 $out->addModules( 'mediawiki.action.edit.editWarning' );
2419 # Enabled article-related sidebar, toplinks, etc.
2420 $out->setArticleRelated( true );
2422 $contextTitle = $this->getContextTitle();
2423 if ( $this->isConflict
) {
2424 $msg = 'editconflict';
2425 } elseif ( $contextTitle->exists() && $this->section
!= '' ) {
2426 $msg = $this->section
== 'new' ?
'editingcomment' : 'editingsection';
2428 $msg = $contextTitle->exists()
2429 ||
( $contextTitle->getNamespace() == NS_MEDIAWIKI
2430 && $contextTitle->getDefaultMessageText() !== false
2436 # Use the title defined by DISPLAYTITLE magic word when present
2437 # NOTE: getDisplayTitle() returns HTML while getPrefixedText() returns plain text.
2438 # setPageTitle() treats the input as wikitext, which should be safe in either case.
2439 $displayTitle = isset( $this->mParserOutput
) ?
$this->mParserOutput
->getDisplayTitle() : false;
2440 if ( $displayTitle === false ) {
2441 $displayTitle = $contextTitle->getPrefixedText();
2443 $out->setPageTitle( $this->context
->msg( $msg, $displayTitle ) );
2445 $config = $this->context
->getConfig();
2447 # Transmit the name of the message to JavaScript for live preview
2448 # Keep Resources.php/mediawiki.action.edit.preview in sync with the possible keys
2449 $out->addJsConfigVars( [
2450 'wgEditMessage' => $msg,
2451 'wgAjaxEditStash' => $config->get( 'AjaxEditStash' ),
2454 // Add whether to use 'save' or 'publish' messages to JavaScript for post-edit, other
2456 $out->addJsConfigVars(
2457 'wgEditSubmitButtonLabelPublish',
2458 $config->get( 'EditSubmitButtonLabelPublish' )
2463 * Show all applicable editing introductions
2465 protected function showIntro() {
2466 if ( $this->suppressIntro
) {
2470 $out = $this->context
->getOutput();
2471 $namespace = $this->mTitle
->getNamespace();
2473 if ( $namespace == NS_MEDIAWIKI
) {
2474 # Show a warning if editing an interface message
2475 $out->wrapWikiMsg( "<div class='mw-editinginterface'>\n$1\n</div>", 'editinginterface' );
2476 # If this is a default message (but not css, json, or js),
2477 # show a hint that it is translatable on translatewiki.net
2479 !$this->mTitle
->hasContentModel( CONTENT_MODEL_CSS
)
2480 && !$this->mTitle
->hasContentModel( CONTENT_MODEL_JSON
)
2481 && !$this->mTitle
->hasContentModel( CONTENT_MODEL_JAVASCRIPT
)
2483 $defaultMessageText = $this->mTitle
->getDefaultMessageText();
2484 if ( $defaultMessageText !== false ) {
2485 $out->wrapWikiMsg( "<div class='mw-translateinterface'>\n$1\n</div>",
2486 'translateinterface' );
2489 } elseif ( $namespace == NS_FILE
) {
2490 # Show a hint to shared repo
2491 $file = wfFindFile( $this->mTitle
);
2492 if ( $file && !$file->isLocal() ) {
2493 $descUrl = $file->getDescriptionUrl();
2494 # there must be a description url to show a hint to shared repo
2496 if ( !$this->mTitle
->exists() ) {
2497 $out->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-create\">\n$1\n</div>", [
2498 'sharedupload-desc-create', $file->getRepo()->getDisplayName(), $descUrl
2501 $out->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-edit\">\n$1\n</div>", [
2502 'sharedupload-desc-edit', $file->getRepo()->getDisplayName(), $descUrl
2509 # Show a warning message when someone creates/edits a user (talk) page but the user does not exist
2510 # Show log extract when the user is currently blocked
2511 if ( $namespace == NS_USER ||
$namespace == NS_USER_TALK
) {
2512 $username = explode( '/', $this->mTitle
->getText(), 2 )[0];
2513 $user = User
::newFromName( $username, false /* allow IP users */ );
2514 $ip = User
::isIP( $username );
2515 $block = Block
::newFromTarget( $user, $user );
2516 if ( !( $user && $user->isLoggedIn() ) && !$ip ) { # User does not exist
2517 $out->wrapWikiMsg( "<div class=\"mw-userpage-userdoesnotexist error\">\n$1\n</div>",
2518 [ 'userpage-userdoesnotexist', wfEscapeWikiText( $username ) ] );
2519 } elseif ( !is_null( $block ) && $block->getType() != Block
::TYPE_AUTO
) {
2520 # Show log extract if the user is currently blocked
2521 LogEventsList
::showLogExtract(
2524 MWNamespace
::getCanonicalName( NS_USER
) . ':' . $block->getTarget(),
2528 'showIfEmpty' => false,
2530 'blocked-notice-logextract',
2531 $user->getName() # Support GENDER in notice
2537 # Try to add a custom edit intro, or use the standard one if this is not possible.
2538 if ( !$this->showCustomIntro() && !$this->mTitle
->exists() ) {
2539 $helpLink = wfExpandUrl( Skin
::makeInternalOrExternalUrl(
2540 $this->context
->msg( 'helppage' )->inContentLanguage()->text()
2542 if ( $this->context
->getUser()->isLoggedIn() ) {
2544 // Suppress the external link icon, consider the help url an internal one
2545 "<div class=\"mw-newarticletext plainlinks\">\n$1\n</div>",
2553 // Suppress the external link icon, consider the help url an internal one
2554 "<div class=\"mw-newarticletextanon plainlinks\">\n$1\n</div>",
2556 'newarticletextanon',
2562 # Give a notice if the user is editing a deleted/moved page...
2563 if ( !$this->mTitle
->exists() ) {
2564 $dbr = wfGetDB( DB_REPLICA
);
2566 LogEventsList
::showLogExtract( $out, [ 'delete', 'move' ], $this->mTitle
,
2570 'conds' => [ 'log_action != ' . $dbr->addQuotes( 'revision' ) ],
2571 'showIfEmpty' => false,
2572 'msgKey' => [ 'recreate-moveddeleted-warn' ]
2579 * Attempt to show a custom editing introduction, if supplied
2583 protected function showCustomIntro() {
2584 if ( $this->editintro
) {
2585 $title = Title
::newFromText( $this->editintro
);
2586 if ( $title instanceof Title
&& $title->exists() && $title->userCan( 'read' ) ) {
2587 // Added using template syntax, to take <noinclude>'s into account.
2588 $this->context
->getOutput()->addWikiTextTitleTidy(
2589 '<div class="mw-editintro">{{:' . $title->getFullText() . '}}</div>',
2599 * Gets an editable textual representation of $content.
2600 * The textual representation can be turned by into a Content object by the
2601 * toEditContent() method.
2603 * If $content is null or false or a string, $content is returned unchanged.
2605 * If the given Content object is not of a type that can be edited using
2606 * the text base EditPage, an exception will be raised. Set
2607 * $this->allowNonTextContent to true to allow editing of non-textual
2610 * @param Content|null|bool|string $content
2611 * @return string The editable text form of the content.
2613 * @throws MWException If $content is not an instance of TextContent and
2614 * $this->allowNonTextContent is not true.
2616 protected function toEditText( $content ) {
2617 if ( $content === null ||
$content === false ||
is_string( $content ) ) {
2621 if ( !$this->isSupportedContentModel( $content->getModel() ) ) {
2622 throw new MWException( 'This content model is not supported: ' . $content->getModel() );
2625 return $content->serialize( $this->contentFormat
);
2629 * Turns the given text into a Content object by unserializing it.
2631 * If the resulting Content object is not of a type that can be edited using
2632 * the text base EditPage, an exception will be raised. Set
2633 * $this->allowNonTextContent to true to allow editing of non-textual
2636 * @param string|null|bool $text Text to unserialize
2637 * @return Content|bool|null The content object created from $text. If $text was false
2638 * or null, false resp. null will be returned instead.
2640 * @throws MWException If unserializing the text results in a Content
2641 * object that is not an instance of TextContent and
2642 * $this->allowNonTextContent is not true.
2644 protected function toEditContent( $text ) {
2645 if ( $text === false ||
$text === null ) {
2649 $content = ContentHandler
::makeContent( $text, $this->getTitle(),
2650 $this->contentModel
, $this->contentFormat
);
2652 if ( !$this->isSupportedContentModel( $content->getModel() ) ) {
2653 throw new MWException( 'This content model is not supported: ' . $content->getModel() );
2660 * Send the edit form and related headers to OutputPage
2661 * @param callable|null $formCallback That takes an OutputPage parameter; will be called
2662 * during form output near the top, for captchas and the like.
2664 * The $formCallback parameter is deprecated since MediaWiki 1.25. Please
2665 * use the EditPage::showEditForm:fields hook instead.
2667 public function showEditForm( $formCallback = null ) {
2668 # need to parse the preview early so that we know which templates are used,
2669 # otherwise users with "show preview after edit box" will get a blank list
2670 # we parse this near the beginning so that setHeaders can do the title
2671 # setting work instead of leaving it in getPreviewText
2672 $previewOutput = '';
2673 if ( $this->formtype
== 'preview' ) {
2674 $previewOutput = $this->getPreviewText();
2677 $out = $this->context
->getOutput();
2679 // Avoid PHP 7.1 warning of passing $this by reference
2681 Hooks
::run( 'EditPage::showEditForm:initial', [ &$editPage, &$out ] );
2683 $this->setHeaders();
2685 $this->addTalkPageText();
2686 $this->addEditNotices();
2688 if ( !$this->isConflict
&&
2689 $this->section
!= '' &&
2690 !$this->isSectionEditSupported() ) {
2691 // We use $this->section to much before this and getVal('wgSection') directly in other places
2692 // at this point we can't reset $this->section to '' to fallback to non-section editing.
2693 // Someone is welcome to try refactoring though
2694 $out->showErrorPage( 'sectioneditnotsupported-title', 'sectioneditnotsupported-text' );
2698 $this->showHeader();
2700 $out->addHTML( $this->editFormPageTop
);
2702 $user = $this->context
->getUser();
2703 if ( $user->getOption( 'previewontop' ) ) {
2704 $this->displayPreviewArea( $previewOutput, true );
2707 $out->addHTML( $this->editFormTextTop
);
2709 $showToolbar = true;
2710 if ( $this->wasDeletedSinceLastEdit() ) {
2711 if ( $this->formtype
== 'save' ) {
2712 // Hide the toolbar and edit area, user can click preview to get it back
2713 // Add an confirmation checkbox and explanation.
2714 $showToolbar = false;
2716 $out->wrapWikiMsg( "<div class='error mw-deleted-while-editing'>\n$1\n</div>",
2717 'deletedwhileediting' );
2721 // @todo add EditForm plugin interface and use it here!
2722 // search for textarea1 and textarea2, and allow EditForm to override all uses.
2723 $out->addHTML( Html
::openElement(
2726 'class' => 'mw-editform',
2727 'id' => self
::EDITFORM_ID
,
2728 'name' => self
::EDITFORM_ID
,
2730 'action' => $this->getActionURL( $this->getContextTitle() ),
2731 'enctype' => 'multipart/form-data'
2735 if ( is_callable( $formCallback ) ) {
2736 wfWarn( 'The $formCallback parameter to ' . __METHOD__
. 'is deprecated' );
2737 call_user_func_array( $formCallback, [ &$out ] );
2740 // Add a check for Unicode support
2741 $out->addHTML( Html
::hidden( 'wpUnicodeCheck', self
::UNICODE_CHECK
) );
2743 // Add an empty field to trip up spambots
2745 Xml
::openElement( 'div', [ 'id' => 'antispam-container', 'style' => 'display: none;' ] )
2748 [ 'for' => 'wpAntispam' ],
2749 $this->context
->msg( 'simpleantispam-label' )->parse()
2755 'name' => 'wpAntispam',
2756 'id' => 'wpAntispam',
2760 . Xml
::closeElement( 'div' )
2763 // Avoid PHP 7.1 warning of passing $this by reference
2765 Hooks
::run( 'EditPage::showEditForm:fields', [ &$editPage, &$out ] );
2767 // Put these up at the top to ensure they aren't lost on early form submission
2768 $this->showFormBeforeText();
2770 if ( $this->wasDeletedSinceLastEdit() && 'save' == $this->formtype
) {
2771 $username = $this->lastDelete
->user_name
;
2772 $comment = CommentStore
::getStore()
2773 ->getComment( 'log_comment', $this->lastDelete
)->text
;
2775 // It is better to not parse the comment at all than to have templates expanded in the middle
2776 // TODO: can the checkLabel be moved outside of the div so that wrapWikiMsg could be used?
2777 $key = $comment === ''
2778 ?
'confirmrecreate-noreason'
2779 : 'confirmrecreate';
2781 '<div class="mw-confirm-recreate">' .
2782 $this->context
->msg( $key, $username, "<nowiki>$comment</nowiki>" )->parse() .
2783 Xml
::checkLabel( $this->context
->msg( 'recreate' )->text(), 'wpRecreate', 'wpRecreate', false,
2784 [ 'title' => Linker
::titleAttrib( 'recreate' ), 'tabindex' => 1, 'id' => 'wpRecreate' ]
2790 # When the summary is hidden, also hide them on preview/show changes
2791 if ( $this->nosummary
) {
2792 $out->addHTML( Html
::hidden( 'nosummary', true ) );
2795 # If a blank edit summary was previously provided, and the appropriate
2796 # user preference is active, pass a hidden tag as wpIgnoreBlankSummary. This will stop the
2797 # user being bounced back more than once in the event that a summary
2800 # For a bit more sophisticated detection of blank summaries, hash the
2801 # automatic one and pass that in the hidden field wpAutoSummary.
2802 if ( $this->missingSummary ||
( $this->section
== 'new' && $this->nosummary
) ) {
2803 $out->addHTML( Html
::hidden( 'wpIgnoreBlankSummary', true ) );
2806 if ( $this->undidRev
) {
2807 $out->addHTML( Html
::hidden( 'wpUndidRevision', $this->undidRev
) );
2810 if ( $this->selfRedirect
) {
2811 $out->addHTML( Html
::hidden( 'wpIgnoreSelfRedirect', true ) );
2814 if ( $this->hasPresetSummary
) {
2815 // If a summary has been preset using &summary= we don't want to prompt for
2816 // a different summary. Only prompt for a summary if the summary is blanked.
2818 $this->autoSumm
= md5( '' );
2821 $autosumm = $this->autoSumm ?
$this->autoSumm
: md5( $this->summary
);
2822 $out->addHTML( Html
::hidden( 'wpAutoSummary', $autosumm ) );
2824 $out->addHTML( Html
::hidden( 'oldid', $this->oldid
) );
2825 $out->addHTML( Html
::hidden( 'parentRevId', $this->getParentRevId() ) );
2827 $out->addHTML( Html
::hidden( 'format', $this->contentFormat
) );
2828 $out->addHTML( Html
::hidden( 'model', $this->contentModel
) );
2832 if ( $this->section
== 'new' ) {
2833 $this->showSummaryInput( true, $this->summary
);
2834 $out->addHTML( $this->getSummaryPreview( true, $this->summary
) );
2837 $out->addHTML( $this->editFormTextBeforeContent
);
2838 if ( $this->isConflict
) {
2839 // In an edit conflict, we turn textbox2 into the user's text,
2840 // and textbox1 into the stored version
2841 $this->textbox2
= $this->textbox1
;
2843 $content = $this->getCurrentContent();
2844 $this->textbox1
= $this->toEditText( $content );
2846 $editConflictHelper = $this->getEditConflictHelper();
2847 $editConflictHelper->setTextboxes( $this->textbox2
, $this->textbox1
);
2848 $editConflictHelper->setContentModel( $this->contentModel
);
2849 $editConflictHelper->setContentFormat( $this->contentFormat
);
2850 $out->addHTML( $editConflictHelper->getEditFormHtmlBeforeContent() );
2853 if ( !$this->mTitle
->isUserConfigPage() && $showToolbar && $user->getOption( 'showtoolbar' ) ) {
2854 $out->addHTML( self
::getEditToolbar( $this->mTitle
) );
2857 if ( $this->blankArticle
) {
2858 $out->addHTML( Html
::hidden( 'wpIgnoreBlankArticle', true ) );
2861 if ( $this->isConflict
) {
2862 // In an edit conflict bypass the overridable content form method
2863 // and fallback to the raw wpTextbox1 since editconflicts can't be
2864 // resolved between page source edits and custom ui edits using the
2866 $conflictTextBoxAttribs = [];
2867 if ( $this->wasDeletedSinceLastEdit() ) {
2868 $conflictTextBoxAttribs['style'] = 'display:none;';
2869 } elseif ( $this->isOldRev
) {
2870 $conflictTextBoxAttribs['class'] = 'mw-textarea-oldrev';
2873 $out->addHTML( $editConflictHelper->getEditConflictMainTextBox( $conflictTextBoxAttribs ) );
2874 $out->addHTML( $editConflictHelper->getEditFormHtmlAfterContent() );
2876 $this->showContentForm();
2879 $out->addHTML( $this->editFormTextAfterContent
);
2881 $this->showStandardInputs();
2883 $this->showFormAfterText();
2885 $this->showTosSummary();
2887 $this->showEditTools();
2889 $out->addHTML( $this->editFormTextAfterTools
. "\n" );
2891 $out->addHTML( $this->makeTemplatesOnThisPageList( $this->getTemplates() ) );
2893 $out->addHTML( Html
::rawElement( 'div', [ 'class' => 'hiddencats' ],
2894 Linker
::formatHiddenCategories( $this->page
->getHiddenCategories() ) ) );
2896 $out->addHTML( Html
::rawElement( 'div', [ 'class' => 'limitreport' ],
2897 self
::getPreviewLimitReport( $this->mParserOutput
) ) );
2899 $out->addModules( 'mediawiki.action.edit.collapsibleFooter' );
2901 if ( $this->isConflict
) {
2903 $this->showConflict();
2904 } catch ( MWContentSerializationException
$ex ) {
2905 // this can't really happen, but be nice if it does.
2906 $msg = $this->context
->msg(
2907 'content-failed-to-parse',
2908 $this->contentModel
,
2909 $this->contentFormat
,
2912 $out->addWikiText( '<div class="error">' . $msg->text() . '</div>' );
2916 // Set a hidden field so JS knows what edit form mode we are in
2917 if ( $this->isConflict
) {
2919 } elseif ( $this->preview
) {
2921 } elseif ( $this->diff
) {
2926 $out->addHTML( Html
::hidden( 'mode', $mode, [ 'id' => 'mw-edit-mode' ] ) );
2928 // Marker for detecting truncated form data. This must be the last
2929 // parameter sent in order to be of use, so do not move me.
2930 $out->addHTML( Html
::hidden( 'wpUltimateParam', true ) );
2931 $out->addHTML( $this->editFormTextBottom
. "\n</form>\n" );
2933 if ( !$user->getOption( 'previewontop' ) ) {
2934 $this->displayPreviewArea( $previewOutput, false );
2939 * Wrapper around TemplatesOnThisPageFormatter to make
2940 * a "templates on this page" list.
2942 * @param Title[] $templates
2943 * @return string HTML
2945 public function makeTemplatesOnThisPageList( array $templates ) {
2946 $templateListFormatter = new TemplatesOnThisPageFormatter(
2947 $this->context
, MediaWikiServices
::getInstance()->getLinkRenderer()
2950 // preview if preview, else section if section, else false
2952 if ( $this->preview
) {
2954 } elseif ( $this->section
!= '' ) {
2958 return Html
::rawElement( 'div', [ 'class' => 'templatesUsed' ],
2959 $templateListFormatter->format( $templates, $type )
2964 * Extract the section title from current section text, if any.
2966 * @param string $text
2967 * @return string|bool String or false
2969 public static function extractSectionTitle( $text ) {
2970 preg_match( "/^(=+)(.+)\\1\\s*(\n|$)/i", $text, $matches );
2971 if ( !empty( $matches[2] ) ) {
2973 return $wgParser->stripSectionName( trim( $matches[2] ) );
2979 protected function showHeader() {
2980 $out = $this->context
->getOutput();
2981 $user = $this->context
->getUser();
2982 if ( $this->isConflict
) {
2983 $this->addExplainConflictHeader( $out );
2984 $this->editRevId
= $this->page
->getLatest();
2986 if ( $this->section
!= '' && $this->section
!= 'new' ) {
2987 if ( !$this->summary
&& !$this->preview
&& !$this->diff
) {
2988 $sectionTitle = self
::extractSectionTitle( $this->textbox1
); // FIXME: use Content object
2989 if ( $sectionTitle !== false ) {
2990 $this->summary
= "/* $sectionTitle */ ";
2995 $buttonLabel = $this->context
->msg( $this->getSubmitButtonLabel() )->text();
2997 if ( $this->missingComment
) {
2998 $out->wrapWikiMsg( "<div id='mw-missingcommenttext'>\n$1\n</div>", 'missingcommenttext' );
3001 if ( $this->missingSummary
&& $this->section
!= 'new' ) {
3003 "<div id='mw-missingsummary'>\n$1\n</div>",
3004 [ 'missingsummary', $buttonLabel ]
3008 if ( $this->missingSummary
&& $this->section
== 'new' ) {
3010 "<div id='mw-missingcommentheader'>\n$1\n</div>",
3011 [ 'missingcommentheader', $buttonLabel ]
3015 if ( $this->blankArticle
) {
3017 "<div id='mw-blankarticle'>\n$1\n</div>",
3018 [ 'blankarticle', $buttonLabel ]
3022 if ( $this->selfRedirect
) {
3024 "<div id='mw-selfredirect'>\n$1\n</div>",
3025 [ 'selfredirect', $buttonLabel ]
3029 if ( $this->hookError
!== '' ) {
3030 $out->addWikiText( $this->hookError
);
3033 if ( $this->section
!= 'new' ) {
3034 $revision = $this->mArticle
->getRevisionFetched();
3036 // Let sysop know that this will make private content public if saved
3038 if ( !$revision->userCan( Revision
::DELETED_TEXT
, $user ) ) {
3040 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
3041 'rev-deleted-text-permission'
3043 } elseif ( $revision->isDeleted( Revision
::DELETED_TEXT
) ) {
3045 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
3046 'rev-deleted-text-view'
3050 if ( !$revision->isCurrent() ) {
3051 $this->mArticle
->setOldSubtitle( $revision->getId() );
3052 $out->addWikiMsg( 'editingold' );
3053 $this->isOldRev
= true;
3055 } elseif ( $this->mTitle
->exists() ) {
3056 // Something went wrong
3058 $out->wrapWikiMsg( "<div class='errorbox'>\n$1\n</div>\n",
3059 [ 'missing-revision', $this->oldid
] );
3064 if ( wfReadOnly() ) {
3066 "<div id=\"mw-read-only-warning\">\n$1\n</div>",
3067 [ 'readonlywarning', wfReadOnlyReason() ]
3069 } elseif ( $user->isAnon() ) {
3070 if ( $this->formtype
!= 'preview' ) {
3072 "<div id='mw-anon-edit-warning' class='warningbox'>\n$1\n</div>",
3073 [ 'anoneditwarning',
3075 SpecialPage
::getTitleFor( 'Userlogin' )->getFullURL( [
3076 'returnto' => $this->getTitle()->getPrefixedDBkey()
3079 SpecialPage
::getTitleFor( 'CreateAccount' )->getFullURL( [
3080 'returnto' => $this->getTitle()->getPrefixedDBkey()
3085 $out->wrapWikiMsg( "<div id=\"mw-anon-preview-warning\" class=\"warningbox\">\n$1</div>",
3086 'anonpreviewwarning'
3090 if ( $this->mTitle
->isUserConfigPage() ) {
3091 # Check the skin exists
3092 if ( $this->isWrongCaseUserConfigPage() ) {
3094 "<div class='error' id='mw-userinvalidconfigtitle'>\n$1\n</div>",
3095 [ 'userinvalidconfigtitle', $this->mTitle
->getSkinFromConfigSubpage() ]
3098 if ( $this->getTitle()->isSubpageOf( $user->getUserPage() ) ) {
3099 $isUserCssConfig = $this->mTitle
->isUserCssConfigPage();
3100 $isUserJsonConfig = $this->mTitle
->isUserJsonConfigPage();
3101 $isUserJsConfig = $this->mTitle
->isUserJsConfigPage();
3103 $warning = $isUserCssConfig
3105 : ( $isUserJsonConfig ?
'userjsonispublic' : 'userjsispublic' );
3107 $out->wrapWikiMsg( '<div class="mw-userconfigpublic">$1</div>', $warning );
3109 if ( $this->formtype
!== 'preview' ) {
3110 $config = $this->context
->getConfig();
3111 if ( $isUserCssConfig && $config->get( 'AllowUserCss' ) ) {
3113 "<div id='mw-usercssyoucanpreview'>\n$1\n</div>",
3114 [ 'usercssyoucanpreview' ]
3116 } elseif ( $isUserJsonConfig /* No comparable 'AllowUserJson' */ ) {
3118 "<div id='mw-userjsonyoucanpreview'>\n$1\n</div>",
3119 [ 'userjsonyoucanpreview' ]
3121 } elseif ( $isUserJsConfig && $config->get( 'AllowUserJs' ) ) {
3123 "<div id='mw-userjsyoucanpreview'>\n$1\n</div>",
3124 [ 'userjsyoucanpreview' ]
3132 $this->addPageProtectionWarningHeaders();
3134 $this->addLongPageWarningHeader();
3136 # Add header copyright warning
3137 $this->showHeaderCopyrightWarning();
3141 * Helper function for summary input functions, which returns the neccessary
3142 * attributes for the input.
3144 * @param array|null $inputAttrs Array of attrs to use on the input
3147 private function getSummaryInputAttributes( array $inputAttrs = null ) {
3148 $conf = $this->context
->getConfig();
3149 $oldCommentSchema = $conf->get( 'CommentTableSchemaMigrationStage' ) === MIGRATION_OLD
;
3150 // HTML maxlength uses "UTF-16 code units", which means that characters outside BMP
3151 // (e.g. emojis) count for two each. This limit is overridden in JS to instead count
3152 // Unicode codepoints (or 255 UTF-8 bytes for old schema).
3153 return ( is_array( $inputAttrs ) ?
$inputAttrs : [] ) +
[
3154 'id' => 'wpSummary',
3155 'name' => 'wpSummary',
3156 'maxlength' => $oldCommentSchema ?
200 : CommentStore
::COMMENT_CHARACTER_LIMIT
,
3159 'spellcheck' => 'true',
3164 * Builds a standard summary input with a label.
3166 * @param string $summary The value of the summary input
3167 * @param string $labelText The html to place inside the label
3168 * @param array $inputAttrs Array of attrs to use on the input
3170 * @return OOUI\FieldLayout OOUI FieldLayout with Label and Input
3172 function getSummaryInputWidget( $summary = "", $labelText = null, $inputAttrs = null ) {
3173 $inputAttrs = OOUI\Element
::configFromHtmlAttributes(
3174 $this->getSummaryInputAttributes( $inputAttrs )
3177 'title' => Linker
::titleAttrib( 'summary' ),
3178 'accessKey' => Linker
::accesskey( 'summary' ),
3181 // For compatibility with old scripts and extensions, we want the legacy 'id' on the `<input>`
3182 $inputAttrs['inputId'] = $inputAttrs['id'];
3183 $inputAttrs['id'] = 'wpSummaryWidget';
3185 return new OOUI\
FieldLayout(
3186 new OOUI\
TextInputWidget( [
3187 'value' => $summary,
3188 'infusable' => true,
3191 'label' => new OOUI\
HtmlSnippet( $labelText ),
3193 'id' => 'wpSummaryLabel',
3194 'classes' => [ $this->missingSummary ?
'mw-summarymissed' : 'mw-summary' ],
3200 * @param bool $isSubjectPreview True if this is the section subject/title
3201 * up top, or false if this is the comment summary
3202 * down below the textarea
3203 * @param string $summary The text of the summary to display
3205 protected function showSummaryInput( $isSubjectPreview, $summary = "" ) {
3206 # Add a class if 'missingsummary' is triggered to allow styling of the summary line
3207 $summaryClass = $this->missingSummary ?
'mw-summarymissed' : 'mw-summary';
3208 if ( $isSubjectPreview ) {
3209 if ( $this->nosummary
) {
3213 if ( !$this->mShowSummaryField
) {
3218 $labelText = $this->context
->msg( $isSubjectPreview ?
'subject' : 'summary' )->parse();
3219 $this->context
->getOutput()->addHTML( $this->getSummaryInputWidget(
3222 [ 'class' => $summaryClass ]
3227 * @param bool $isSubjectPreview True if this is the section subject/title
3228 * up top, or false if this is the comment summary
3229 * down below the textarea
3230 * @param string $summary The text of the summary to display
3233 protected function getSummaryPreview( $isSubjectPreview, $summary = "" ) {
3234 // avoid spaces in preview, gets always trimmed on save
3235 $summary = trim( $summary );
3236 if ( !$summary ||
( !$this->preview
&& !$this->diff
) ) {
3242 if ( $isSubjectPreview ) {
3243 $summary = $this->context
->msg( 'newsectionsummary' )
3244 ->rawParams( $wgParser->stripSectionName( $summary ) )
3245 ->inContentLanguage()->text();
3248 $message = $isSubjectPreview ?
'subject-preview' : 'summary-preview';
3250 $summary = $this->context
->msg( $message )->parse()
3251 . Linker
::commentBlock( $summary, $this->mTitle
, $isSubjectPreview );
3252 return Xml
::tags( 'div', [ 'class' => 'mw-summary-preview' ], $summary );
3255 protected function showFormBeforeText() {
3256 $out = $this->context
->getOutput();
3257 $out->addHTML( Html
::hidden( 'wpSection', $this->section
) );
3258 $out->addHTML( Html
::hidden( 'wpStarttime', $this->starttime
) );
3259 $out->addHTML( Html
::hidden( 'wpEdittime', $this->edittime
) );
3260 $out->addHTML( Html
::hidden( 'editRevId', $this->editRevId
) );
3261 $out->addHTML( Html
::hidden( 'wpScrolltop', $this->scrolltop
, [ 'id' => 'wpScrolltop' ] ) );
3264 protected function showFormAfterText() {
3266 * To make it harder for someone to slip a user a page
3267 * which submits an edit form to the wiki without their
3268 * knowledge, a random token is associated with the login
3269 * session. If it's not passed back with the submission,
3270 * we won't save the page, or render user JavaScript and
3273 * For anon editors, who may not have a session, we just
3274 * include the constant suffix to prevent editing from
3275 * broken text-mangling proxies.
3277 $this->context
->getOutput()->addHTML(
3279 Html
::hidden( "wpEditToken", $this->context
->getUser()->getEditToken() ) .
3285 * Subpage overridable method for printing the form for page content editing
3286 * By default this simply outputs wpTextbox1
3287 * Subclasses can override this to provide a custom UI for editing;
3288 * be it a form, or simply wpTextbox1 with a modified content that will be
3289 * reverse modified when extracted from the post data.
3290 * Note that this is basically the inverse for importContentFormData
3292 protected function showContentForm() {
3293 $this->showTextbox1();
3297 * Method to output wpTextbox1
3298 * The $textoverride method can be used by subclasses overriding showContentForm
3299 * to pass back to this method.
3301 * @param array $customAttribs Array of html attributes to use in the textarea
3302 * @param string $textoverride Optional text to override $this->textarea1 with
3304 protected function showTextbox1( $customAttribs = null, $textoverride = null ) {
3305 if ( $this->wasDeletedSinceLastEdit() && $this->formtype
== 'save' ) {
3306 $attribs = [ 'style' => 'display:none;' ];
3308 $builder = new TextboxBuilder();
3309 $classes = $builder->getTextboxProtectionCSSClasses( $this->getTitle() );
3311 # Is an old revision being edited?
3312 if ( $this->isOldRev
) {
3313 $classes[] = 'mw-textarea-oldrev';
3316 $attribs = [ 'tabindex' => 1 ];
3318 if ( is_array( $customAttribs ) ) {
3319 $attribs +
= $customAttribs;
3322 $attribs = $builder->mergeClassesIntoAttributes( $classes, $attribs );
3326 $textoverride !== null ?
$textoverride : $this->textbox1
,
3332 protected function showTextbox2() {
3333 $this->showTextbox( $this->textbox2
, 'wpTextbox2', [ 'tabindex' => 6, 'readonly' ] );
3336 protected function showTextbox( $text, $name, $customAttribs = [] ) {
3337 $builder = new TextboxBuilder();
3338 $attribs = $builder->buildTextboxAttribs(
3341 $this->context
->getUser(),
3345 $this->context
->getOutput()->addHTML(
3346 Html
::textarea( $name, $builder->addNewLineAtEnd( $text ), $attribs )
3350 protected function displayPreviewArea( $previewOutput, $isOnTop = false ) {
3353 $classes[] = 'ontop';
3356 $attribs = [ 'id' => 'wikiPreview', 'class' => implode( ' ', $classes ) ];
3358 if ( $this->formtype
!= 'preview' ) {
3359 $attribs['style'] = 'display: none;';
3362 $out = $this->context
->getOutput();
3363 $out->addHTML( Xml
::openElement( 'div', $attribs ) );
3365 if ( $this->formtype
== 'preview' ) {
3366 $this->showPreview( $previewOutput );
3368 // Empty content container for LivePreview
3369 $pageViewLang = $this->mTitle
->getPageViewLanguage();
3370 $attribs = [ 'lang' => $pageViewLang->getHtmlCode(), 'dir' => $pageViewLang->getDir(),
3371 'class' => 'mw-content-' . $pageViewLang->getDir() ];
3372 $out->addHTML( Html
::rawElement( 'div', $attribs ) );
3375 $out->addHTML( '</div>' );
3377 if ( $this->formtype
== 'diff' ) {
3380 } catch ( MWContentSerializationException
$ex ) {
3381 $msg = $this->context
->msg(
3382 'content-failed-to-parse',
3383 $this->contentModel
,
3384 $this->contentFormat
,
3387 $out->addWikiText( '<div class="error">' . $msg->text() . '</div>' );
3393 * Append preview output to OutputPage.
3394 * Includes category rendering if this is a category page.
3396 * @param string $text The HTML to be output for the preview.
3398 protected function showPreview( $text ) {
3399 if ( $this->mArticle
instanceof CategoryPage
) {
3400 $this->mArticle
->openShowCategory();
3402 # This hook seems slightly odd here, but makes things more
3403 # consistent for extensions.
3404 $out = $this->context
->getOutput();
3405 Hooks
::run( 'OutputPageBeforeHTML', [ &$out, &$text ] );
3406 $out->addHTML( $text );
3407 if ( $this->mArticle
instanceof CategoryPage
) {
3408 $this->mArticle
->closeShowCategory();
3413 * Get a diff between the current contents of the edit box and the
3414 * version of the page we're editing from.
3416 * If this is a section edit, we'll replace the section as for final
3417 * save and then make a comparison.
3419 public function showDiff() {
3422 $oldtitlemsg = 'currentrev';
3423 # if message does not exist, show diff against the preloaded default
3424 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
&& !$this->mTitle
->exists() ) {
3425 $oldtext = $this->mTitle
->getDefaultMessageText();
3426 if ( $oldtext !== false ) {
3427 $oldtitlemsg = 'defaultmessagetext';
3428 $oldContent = $this->toEditContent( $oldtext );
3433 $oldContent = $this->getCurrentContent();
3436 $textboxContent = $this->toEditContent( $this->textbox1
);
3437 if ( $this->editRevId
!== null ) {
3438 $newContent = $this->page
->replaceSectionAtRev(
3439 $this->section
, $textboxContent, $this->summary
, $this->editRevId
3442 $newContent = $this->page
->replaceSectionContent(
3443 $this->section
, $textboxContent, $this->summary
, $this->edittime
3447 if ( $newContent ) {
3448 Hooks
::run( 'EditPageGetDiffContent', [ $this, &$newContent ] );
3450 $user = $this->context
->getUser();
3451 $popts = ParserOptions
::newFromUserAndLang( $user, $wgContLang );
3452 $newContent = $newContent->preSaveTransform( $this->mTitle
, $user, $popts );
3455 if ( ( $oldContent && !$oldContent->isEmpty() ) ||
( $newContent && !$newContent->isEmpty() ) ) {
3456 $oldtitle = $this->context
->msg( $oldtitlemsg )->parse();
3457 $newtitle = $this->context
->msg( 'yourtext' )->parse();
3459 if ( !$oldContent ) {
3460 $oldContent = $newContent->getContentHandler()->makeEmptyContent();
3463 if ( !$newContent ) {
3464 $newContent = $oldContent->getContentHandler()->makeEmptyContent();
3467 $de = $oldContent->getContentHandler()->createDifferenceEngine( $this->context
);
3468 $de->setContent( $oldContent, $newContent );
3470 $difftext = $de->getDiff( $oldtitle, $newtitle );
3471 $de->showDiffStyle();
3476 $this->context
->getOutput()->addHTML( '<div id="wikiDiff">' . $difftext . '</div>' );
3480 * Show the header copyright warning.
3482 protected function showHeaderCopyrightWarning() {
3483 $msg = 'editpage-head-copy-warn';
3484 if ( !$this->context
->msg( $msg )->isDisabled() ) {
3485 $this->context
->getOutput()->wrapWikiMsg( "<div class='editpage-head-copywarn'>\n$1\n</div>",
3486 'editpage-head-copy-warn' );
3491 * Give a chance for site and per-namespace customizations of
3492 * terms of service summary link that might exist separately
3493 * from the copyright notice.
3495 * This will display between the save button and the edit tools,
3496 * so should remain short!
3498 protected function showTosSummary() {
3499 $msg = 'editpage-tos-summary';
3500 Hooks
::run( 'EditPageTosSummary', [ $this->mTitle
, &$msg ] );
3501 if ( !$this->context
->msg( $msg )->isDisabled() ) {
3502 $out = $this->context
->getOutput();
3503 $out->addHTML( '<div class="mw-tos-summary">' );
3504 $out->addWikiMsg( $msg );
3505 $out->addHTML( '</div>' );
3510 * Inserts optional text shown below edit and upload forms. Can be used to offer special
3511 * characters not present on most keyboards for copying/pasting.
3513 protected function showEditTools() {
3514 $this->context
->getOutput()->addHTML( '<div class="mw-editTools">' .
3515 $this->context
->msg( 'edittools' )->inContentLanguage()->parse() .
3520 * Get the copyright warning
3522 * Renamed to getCopyrightWarning(), old name kept around for backwards compatibility
3525 protected function getCopywarn() {
3526 return self
::getCopyrightWarning( $this->mTitle
);
3530 * Get the copyright warning, by default returns wikitext
3532 * @param Title $title
3533 * @param string $format Output format, valid values are any function of a Message object
3534 * @param Language|string|null $langcode Language code or Language object.
3537 public static function getCopyrightWarning( $title, $format = 'plain', $langcode = null ) {
3538 global $wgRightsText;
3539 if ( $wgRightsText ) {
3540 $copywarnMsg = [ 'copyrightwarning',
3541 '[[' . wfMessage( 'copyrightpage' )->inContentLanguage()->text() . ']]',
3544 $copywarnMsg = [ 'copyrightwarning2',
3545 '[[' . wfMessage( 'copyrightpage' )->inContentLanguage()->text() . ']]' ];
3547 // Allow for site and per-namespace customization of contribution/copyright notice.
3548 Hooks
::run( 'EditPageCopyrightWarning', [ $title, &$copywarnMsg ] );
3550 $msg = call_user_func_array( 'wfMessage', $copywarnMsg )->title( $title );
3552 $msg->inLanguage( $langcode );
3554 return "<div id=\"editpage-copywarn\">\n" .
3555 $msg->$format() . "\n</div>";
3559 * Get the Limit report for page previews
3562 * @param ParserOutput $output ParserOutput object from the parse
3563 * @return string HTML
3565 public static function getPreviewLimitReport( $output ) {
3568 if ( !$output ||
!$output->getLimitReportData() ) {
3572 $limitReport = Html
::rawElement( 'div', [ 'class' => 'mw-limitReportExplanation' ],
3573 wfMessage( 'limitreport-title' )->parseAsBlock()
3576 // Show/hide animation doesn't work correctly on a table, so wrap it in a div.
3577 $limitReport .= Html
::openElement( 'div', [ 'class' => 'preview-limit-report-wrapper' ] );
3579 $limitReport .= Html
::openElement( 'table', [
3580 'class' => 'preview-limit-report wikitable'
3582 Html
::openElement( 'tbody' );
3584 foreach ( $output->getLimitReportData() as $key => $value ) {
3585 if ( Hooks
::run( 'ParserLimitReportFormat',
3586 [ $key, &$value, &$limitReport, true, true ]
3588 $keyMsg = wfMessage( $key );
3589 $valueMsg = wfMessage( [ "$key-value-html", "$key-value" ] );
3590 if ( !$valueMsg->exists() ) {
3591 $valueMsg = new RawMessage( '$1' );
3593 if ( !$keyMsg->isDisabled() && !$valueMsg->isDisabled() ) {
3594 $limitReport .= Html
::openElement( 'tr' ) .
3595 Html
::rawElement( 'th', null, $keyMsg->parse() ) .
3596 Html
::rawElement( 'td', null,
3597 $wgLang->formatNum( $valueMsg->params( $value )->parse() )
3599 Html
::closeElement( 'tr' );
3604 $limitReport .= Html
::closeElement( 'tbody' ) .
3605 Html
::closeElement( 'table' ) .
3606 Html
::closeElement( 'div' );
3608 return $limitReport;
3611 protected function showStandardInputs( &$tabindex = 2 ) {
3612 $out = $this->context
->getOutput();
3613 $out->addHTML( "<div class='editOptions'>\n" );
3615 if ( $this->section
!= 'new' ) {
3616 $this->showSummaryInput( false, $this->summary
);
3617 $out->addHTML( $this->getSummaryPreview( false, $this->summary
) );
3620 $checkboxes = $this->getCheckboxesWidget(
3622 [ 'minor' => $this->minoredit
, 'watch' => $this->watchthis
]
3624 $checkboxesHTML = new OOUI\
HorizontalLayout( [ 'items' => $checkboxes ] );
3626 $out->addHTML( "<div class='editCheckboxes'>" . $checkboxesHTML . "</div>\n" );
3628 // Show copyright warning.
3629 $out->addWikiText( $this->getCopywarn() );
3630 $out->addHTML( $this->editFormTextAfterWarn
);
3632 $out->addHTML( "<div class='editButtons'>\n" );
3633 $out->addHTML( implode( "\n", $this->getEditButtons( $tabindex ) ) . "\n" );
3635 $cancel = $this->getCancelLink();
3637 $message = $this->context
->msg( 'edithelppage' )->inContentLanguage()->text();
3638 $edithelpurl = Skin
::makeInternalOrExternalUrl( $message );
3641 $this->context
->msg( 'edithelp' )->text(),
3642 [ 'target' => 'helpwindow', 'href' => $edithelpurl ],
3645 $this->context
->msg( 'word-separator' )->escaped() .
3646 $this->context
->msg( 'newwindow' )->parse();
3648 $out->addHTML( " <span class='cancelLink'>{$cancel}</span>\n" );
3649 $out->addHTML( " <span class='editHelp'>{$edithelp}</span>\n" );
3650 $out->addHTML( "</div><!-- editButtons -->\n" );
3652 Hooks
::run( 'EditPage::showStandardInputs:options', [ $this, $out, &$tabindex ] );
3654 $out->addHTML( "</div><!-- editOptions -->\n" );
3658 * Show an edit conflict. textbox1 is already shown in showEditForm().
3659 * If you want to use another entry point to this function, be careful.
3661 protected function showConflict() {
3662 $out = $this->context
->getOutput();
3663 // Avoid PHP 7.1 warning of passing $this by reference
3665 if ( Hooks
::run( 'EditPageBeforeConflictDiff', [ &$editPage, &$out ] ) ) {
3666 $this->incrementConflictStats();
3668 $this->getEditConflictHelper()->showEditFormTextAfterFooters();
3672 protected function incrementConflictStats() {
3673 $this->getEditConflictHelper()->incrementConflictStats();
3679 public function getCancelLink() {
3681 if ( !$this->isConflict
&& $this->oldid
> 0 ) {
3682 $cancelParams['oldid'] = $this->oldid
;
3683 } elseif ( $this->getContextTitle()->isRedirect() ) {
3684 $cancelParams['redirect'] = 'no';
3687 return new OOUI\
ButtonWidget( [
3688 'id' => 'mw-editform-cancel',
3689 'href' => $this->getContextTitle()->getLinkURL( $cancelParams ),
3690 'label' => new OOUI\
HtmlSnippet( $this->context
->msg( 'cancel' )->parse() ),
3692 'infusable' => true,
3693 'flags' => 'destructive',
3698 * Returns the URL to use in the form's action attribute.
3699 * This is used by EditPage subclasses when simply customizing the action
3700 * variable in the constructor is not enough. This can be used when the
3701 * EditPage lives inside of a Special page rather than a custom page action.
3703 * @param Title $title Title object for which is being edited (where we go to for &action= links)
3706 protected function getActionURL( Title
$title ) {
3707 return $title->getLocalURL( [ 'action' => $this->action
] );
3711 * Check if a page was deleted while the user was editing it, before submit.
3712 * Note that we rely on the logging table, which hasn't been always there,
3713 * but that doesn't matter, because this only applies to brand new
3717 protected function wasDeletedSinceLastEdit() {
3718 if ( $this->deletedSinceEdit
!== null ) {
3719 return $this->deletedSinceEdit
;
3722 $this->deletedSinceEdit
= false;
3724 if ( !$this->mTitle
->exists() && $this->mTitle
->isDeletedQuick() ) {
3725 $this->lastDelete
= $this->getLastDelete();
3726 if ( $this->lastDelete
) {
3727 $deleteTime = wfTimestamp( TS_MW
, $this->lastDelete
->log_timestamp
);
3728 if ( $deleteTime > $this->starttime
) {
3729 $this->deletedSinceEdit
= true;
3734 return $this->deletedSinceEdit
;
3738 * @return bool|stdClass
3740 protected function getLastDelete() {
3741 $dbr = wfGetDB( DB_REPLICA
);
3742 $commentQuery = CommentStore
::getStore()->getJoin( 'log_comment' );
3743 $actorQuery = ActorMigration
::newMigration()->getJoin( 'log_user' );
3744 $data = $dbr->selectRow(
3745 array_merge( [ 'logging' ], $commentQuery['tables'], $actorQuery['tables'], [ 'user' ] ),
3755 ] +
$commentQuery['fields'] +
$actorQuery['fields'],
3757 'log_namespace' => $this->mTitle
->getNamespace(),
3758 'log_title' => $this->mTitle
->getDBkey(),
3759 'log_type' => 'delete',
3760 'log_action' => 'delete',
3763 [ 'LIMIT' => 1, 'ORDER BY' => 'log_timestamp DESC' ],
3765 'user' => [ 'JOIN', 'user_id=' . $actorQuery['fields']['log_user'] ],
3766 ] +
$commentQuery['joins'] +
$actorQuery['joins']
3768 // Quick paranoid permission checks...
3769 if ( is_object( $data ) ) {
3770 if ( $data->log_deleted
& LogPage
::DELETED_USER
) {
3771 $data->user_name
= $this->context
->msg( 'rev-deleted-user' )->escaped();
3774 if ( $data->log_deleted
& LogPage
::DELETED_COMMENT
) {
3775 $data->log_comment_text
= $this->context
->msg( 'rev-deleted-comment' )->escaped();
3776 $data->log_comment_data
= null;
3784 * Get the rendered text for previewing.
3785 * @throws MWException
3788 public function getPreviewText() {
3789 $out = $this->context
->getOutput();
3790 $config = $this->context
->getConfig();
3792 if ( $config->get( 'RawHtml' ) && !$this->mTokenOk
) {
3793 // Could be an offsite preview attempt. This is very unsafe if
3794 // HTML is enabled, as it could be an attack.
3796 if ( $this->textbox1
!== '' ) {
3797 // Do not put big scary notice, if previewing the empty
3798 // string, which happens when you initially edit
3799 // a category page, due to automatic preview-on-open.
3800 $parsedNote = $out->parse( "<div class='previewnote'>" .
3801 $this->context
->msg( 'session_fail_preview_html' )->text() . "</div>",
3802 true, /* interface */true );
3804 $this->incrementEditFailureStats( 'session_loss' );
3811 $content = $this->toEditContent( $this->textbox1
);
3815 'AlternateEditPreview',
3816 [ $this, &$content, &$previewHTML, &$this->mParserOutput
] )
3818 return $previewHTML;
3821 # provide a anchor link to the editform
3822 $continueEditing = '<span class="mw-continue-editing">' .
3823 '[[#' . self
::EDITFORM_ID
. '|' .
3824 $this->context
->getLanguage()->getArrow() . ' ' .
3825 $this->context
->msg( 'continue-editing' )->text() . ']]</span>';
3826 if ( $this->mTriedSave
&& !$this->mTokenOk
) {
3827 if ( $this->mTokenOkExceptSuffix
) {
3828 $note = $this->context
->msg( 'token_suffix_mismatch' )->plain();
3829 $this->incrementEditFailureStats( 'bad_token' );
3831 $note = $this->context
->msg( 'session_fail_preview' )->plain();
3832 $this->incrementEditFailureStats( 'session_loss' );
3834 } elseif ( $this->incompleteForm
) {
3835 $note = $this->context
->msg( 'edit_form_incomplete' )->plain();
3836 if ( $this->mTriedSave
) {
3837 $this->incrementEditFailureStats( 'incomplete_form' );
3840 $note = $this->context
->msg( 'previewnote' )->plain() . ' ' . $continueEditing;
3843 # don't parse non-wikitext pages, show message about preview
3844 if ( $this->mTitle
->isUserConfigPage() ||
$this->mTitle
->isSiteConfigPage() ) {
3845 if ( $this->mTitle
->isUserConfigPage() ) {
3847 } elseif ( $this->mTitle
->isSiteConfigPage() ) {
3853 if ( $content->getModel() == CONTENT_MODEL_CSS
) {
3855 if ( $level === 'user' && !$config->get( 'AllowUserCss' ) ) {
3858 } elseif ( $content->getModel() == CONTENT_MODEL_JSON
) {
3860 if ( $level === 'user' /* No comparable 'AllowUserJson' */ ) {
3863 } elseif ( $content->getModel() == CONTENT_MODEL_JAVASCRIPT
) {
3865 if ( $level === 'user' && !$config->get( 'AllowUserJs' ) ) {
3872 # Used messages to make sure grep find them:
3873 # Messages: usercsspreview, userjsonpreview, userjspreview,
3874 # sitecsspreview, sitejsonpreview, sitejspreview
3875 if ( $level && $format ) {
3876 $note = "<div id='mw-{$level}{$format}preview'>" .
3877 $this->context
->msg( "{$level}{$format}preview" )->text() .
3878 ' ' . $continueEditing . "</div>";
3882 # If we're adding a comment, we need to show the
3883 # summary as the headline
3884 if ( $this->section
=== "new" && $this->summary
!== "" ) {
3885 $content = $content->addSectionHeader( $this->summary
);
3888 $hook_args = [ $this, &$content ];
3889 Hooks
::run( 'EditPageGetPreviewContent', $hook_args );
3891 $parserResult = $this->doPreviewParse( $content );
3892 $parserOutput = $parserResult['parserOutput'];
3893 $previewHTML = $parserResult['html'];
3894 $this->mParserOutput
= $parserOutput;
3895 $out->addParserOutputMetadata( $parserOutput );
3897 if ( count( $parserOutput->getWarnings() ) ) {
3898 $note .= "\n\n" . implode( "\n\n", $parserOutput->getWarnings() );
3901 } catch ( MWContentSerializationException
$ex ) {
3902 $m = $this->context
->msg(
3903 'content-failed-to-parse',
3904 $this->contentModel
,
3905 $this->contentFormat
,
3908 $note .= "\n\n" . $m->parse();
3912 if ( $this->isConflict
) {
3913 $conflict = '<h2 id="mw-previewconflict">'
3914 . $this->context
->msg( 'previewconflict' )->escaped() . "</h2>\n";
3916 $conflict = '<hr />';
3919 $previewhead = "<div class='previewnote'>\n" .
3920 '<h2 id="mw-previewheader">' . $this->context
->msg( 'preview' )->escaped() . "</h2>" .
3921 $out->parse( $note, true, /* interface */true ) . $conflict . "</div>\n";
3923 $pageViewLang = $this->mTitle
->getPageViewLanguage();
3924 $attribs = [ 'lang' => $pageViewLang->getHtmlCode(), 'dir' => $pageViewLang->getDir(),
3925 'class' => 'mw-content-' . $pageViewLang->getDir() ];
3926 $previewHTML = Html
::rawElement( 'div', $attribs, $previewHTML );
3928 return $previewhead . $previewHTML . $this->previewTextAfterContent
;
3931 private function incrementEditFailureStats( $failureType ) {
3932 $stats = MediaWikiServices
::getInstance()->getStatsdDataFactory();
3933 $stats->increment( 'edit.failures.' . $failureType );
3937 * Get parser options for a preview
3938 * @return ParserOptions
3940 protected function getPreviewParserOptions() {
3941 $parserOptions = $this->page
->makeParserOptions( $this->context
);
3942 $parserOptions->setIsPreview( true );
3943 $parserOptions->setIsSectionPreview( !is_null( $this->section
) && $this->section
!== '' );
3944 $parserOptions->enableLimitReport();
3945 return $parserOptions;
3949 * Parse the page for a preview. Subclasses may override this class, in order
3950 * to parse with different options, or to otherwise modify the preview HTML.
3952 * @param Content $content The page content
3953 * @return array with keys:
3954 * - parserOutput: The ParserOutput object
3955 * - html: The HTML to be displayed
3957 protected function doPreviewParse( Content
$content ) {
3958 $user = $this->context
->getUser();
3959 $parserOptions = $this->getPreviewParserOptions();
3960 $pstContent = $content->preSaveTransform( $this->mTitle
, $user, $parserOptions );
3961 $scopedCallback = $parserOptions->setupFakeRevision(
3962 $this->mTitle
, $pstContent, $user );
3963 $parserOutput = $pstContent->getParserOutput( $this->mTitle
, null, $parserOptions );
3964 ScopedCallback
::consume( $scopedCallback );
3966 'parserOutput' => $parserOutput,
3967 'html' => $parserOutput->getText( [
3968 'enableSectionEditLinks' => false
3976 public function getTemplates() {
3977 if ( $this->preview ||
$this->section
!= '' ) {
3979 if ( !isset( $this->mParserOutput
) ) {
3982 foreach ( $this->mParserOutput
->getTemplates() as $ns => $template ) {
3983 foreach ( array_keys( $template ) as $dbk ) {
3984 $templates[] = Title
::makeTitle( $ns, $dbk );
3989 return $this->mTitle
->getTemplateLinksFrom();
3994 * Shows a bulletin board style toolbar for common editing functions.
3995 * It can be disabled in the user preferences.
3997 * @param Title $title Title object for the page being edited (optional)
4000 public static function getEditToolbar( $title = null ) {
4001 global $wgContLang, $wgOut;
4002 global $wgEnableUploads, $wgForeignFileRepos;
4004 $imagesAvailable = $wgEnableUploads ||
count( $wgForeignFileRepos );
4005 $showSignature = true;
4007 $showSignature = MWNamespace
::wantSignatures( $title->getNamespace() );
4011 * $toolarray is an array of arrays each of which includes the
4012 * opening tag, the closing tag, optionally a sample text that is
4013 * inserted between the two when no selection is highlighted
4014 * and. The tip text is shown when the user moves the mouse
4017 * Images are defined in ResourceLoaderEditToolbarModule.
4021 'id' => 'mw-editbutton-bold',
4023 'close' => '\'\'\'',
4024 'sample' => wfMessage( 'bold_sample' )->text(),
4025 'tip' => wfMessage( 'bold_tip' )->text(),
4028 'id' => 'mw-editbutton-italic',
4031 'sample' => wfMessage( 'italic_sample' )->text(),
4032 'tip' => wfMessage( 'italic_tip' )->text(),
4035 'id' => 'mw-editbutton-link',
4038 'sample' => wfMessage( 'link_sample' )->text(),
4039 'tip' => wfMessage( 'link_tip' )->text(),
4042 'id' => 'mw-editbutton-extlink',
4045 'sample' => wfMessage( 'extlink_sample' )->text(),
4046 'tip' => wfMessage( 'extlink_tip' )->text(),
4049 'id' => 'mw-editbutton-headline',
4052 'sample' => wfMessage( 'headline_sample' )->text(),
4053 'tip' => wfMessage( 'headline_tip' )->text(),
4055 $imagesAvailable ?
[
4056 'id' => 'mw-editbutton-image',
4057 'open' => '[[' . $wgContLang->getNsText( NS_FILE
) . ':',
4059 'sample' => wfMessage( 'image_sample' )->text(),
4060 'tip' => wfMessage( 'image_tip' )->text(),
4062 $imagesAvailable ?
[
4063 'id' => 'mw-editbutton-media',
4064 'open' => '[[' . $wgContLang->getNsText( NS_MEDIA
) . ':',
4066 'sample' => wfMessage( 'media_sample' )->text(),
4067 'tip' => wfMessage( 'media_tip' )->text(),
4070 'id' => 'mw-editbutton-nowiki',
4071 'open' => "<nowiki>",
4072 'close' => "</nowiki>",
4073 'sample' => wfMessage( 'nowiki_sample' )->text(),
4074 'tip' => wfMessage( 'nowiki_tip' )->text(),
4077 'id' => 'mw-editbutton-signature',
4078 'open' => wfMessage( 'sig-text', '~~~~' )->inContentLanguage()->text(),
4081 'tip' => wfMessage( 'sig_tip' )->text(),
4084 'id' => 'mw-editbutton-hr',
4085 'open' => "\n----\n",
4088 'tip' => wfMessage( 'hr_tip' )->text(),
4092 $script = 'mw.loader.using("mediawiki.toolbar", function () {';
4093 foreach ( $toolarray as $tool ) {
4099 // Images are defined in ResourceLoaderEditToolbarModule
4101 // Note that we use the tip both for the ALT tag and the TITLE tag of the image.
4102 // Older browsers show a "speedtip" type message only for ALT.
4103 // Ideally these should be different, realistically they
4104 // probably don't need to be.
4112 $script .= Xml
::encodeJsCall(
4113 'mw.toolbar.addButton',
4115 ResourceLoader
::inDebugMode()
4121 $toolbar = '<div id="toolbar"></div>';
4123 if ( Hooks
::run( 'EditPageBeforeEditToolbar', [ &$toolbar ] ) ) {
4124 // Only add the old toolbar cruft to the page payload if the toolbar has not
4125 // been over-written by a hook caller
4126 $wgOut->addScript( ResourceLoader
::makeInlineScript( $script ) );
4133 * Return an array of checkbox definitions.
4135 * Array keys correspond to the `<input>` 'name' attribute to use for each checkbox.
4137 * Array values are associative arrays with the following keys:
4138 * - 'label-message' (required): message for label text
4139 * - 'id' (required): 'id' attribute for the `<input>`
4140 * - 'default' (required): default checkedness (true or false)
4141 * - 'title-message' (optional): used to generate 'title' attribute for the `<label>`
4142 * - 'tooltip' (optional): used to generate 'title' and 'accesskey' attributes
4143 * from messages like 'tooltip-foo', 'accesskey-foo'
4144 * - 'label-id' (optional): 'id' attribute for the `<label>`
4145 * - 'legacy-name' (optional): short name for backwards-compatibility
4146 * @param array $checked Array of checkbox name (matching the 'legacy-name') => bool,
4147 * where bool indicates the checked status of the checkbox
4150 public function getCheckboxesDefinition( $checked ) {
4153 $user = $this->context
->getUser();
4154 // don't show the minor edit checkbox if it's a new page or section
4155 if ( !$this->isNew
&& $user->isAllowed( 'minoredit' ) ) {
4156 $checkboxes['wpMinoredit'] = [
4157 'id' => 'wpMinoredit',
4158 'label-message' => 'minoredit',
4159 // Uses messages: tooltip-minoredit, accesskey-minoredit
4160 'tooltip' => 'minoredit',
4161 'label-id' => 'mw-editpage-minoredit',
4162 'legacy-name' => 'minor',
4163 'default' => $checked['minor'],
4167 if ( $user->isLoggedIn() ) {
4168 $checkboxes['wpWatchthis'] = [
4169 'id' => 'wpWatchthis',
4170 'label-message' => 'watchthis',
4171 // Uses messages: tooltip-watch, accesskey-watch
4172 'tooltip' => 'watch',
4173 'label-id' => 'mw-editpage-watch',
4174 'legacy-name' => 'watch',
4175 'default' => $checked['watch'],
4180 Hooks
::run( 'EditPageGetCheckboxesDefinition', [ $editPage, &$checkboxes ] );
4186 * Returns an array of checkboxes for the edit form, including 'minor' and 'watch' checkboxes and
4187 * any other added by extensions.
4189 * @param int &$tabindex Current tabindex
4190 * @param array $checked Array of checkbox => bool, where bool indicates the checked
4191 * status of the checkbox
4193 * @return array Associative array of string keys to OOUI\FieldLayout instances
4195 public function getCheckboxesWidget( &$tabindex, $checked ) {
4197 $checkboxesDef = $this->getCheckboxesDefinition( $checked );
4199 foreach ( $checkboxesDef as $name => $options ) {
4200 $legacyName = isset( $options['legacy-name'] ) ?
$options['legacy-name'] : $name;
4204 if ( isset( $options['tooltip'] ) ) {
4205 $accesskey = $this->context
->msg( "accesskey-{$options['tooltip']}" )->text();
4206 $title = Linker
::titleAttrib( $options['tooltip'] );
4208 if ( isset( $options['title-message'] ) ) {
4209 $title = $this->context
->msg( $options['title-message'] )->text();
4212 $checkboxes[ $legacyName ] = new OOUI\
FieldLayout(
4213 new OOUI\
CheckboxInputWidget( [
4214 'tabIndex' => ++
$tabindex,
4215 'accessKey' => $accesskey,
4216 'id' => $options['id'] . 'Widget',
4217 'inputId' => $options['id'],
4219 'selected' => $options['default'],
4220 'infusable' => true,
4223 'align' => 'inline',
4224 'label' => new OOUI\
HtmlSnippet( $this->context
->msg( $options['label-message'] )->parse() ),
4226 'id' => isset( $options['label-id'] ) ?
$options['label-id'] : null,
4231 // Backwards-compatibility hack to run the EditPageBeforeEditChecks hook. It's important,
4232 // people have used it for the weirdest things completely unrelated to checkboxes...
4233 // And if we're gonna run it, might as well allow its legacy checkboxes to be shown.
4234 $legacyCheckboxes = [];
4235 if ( !$this->isNew
) {
4236 $legacyCheckboxes['minor'] = '';
4238 $legacyCheckboxes['watch'] = '';
4239 // Copy new-style checkboxes into an old-style structure
4240 foreach ( $checkboxes as $name => $oouiLayout ) {
4241 $legacyCheckboxes[$name] = (string)$oouiLayout;
4243 // Avoid PHP 7.1 warning of passing $this by reference
4245 Hooks
::run( 'EditPageBeforeEditChecks', [ &$ep, &$legacyCheckboxes, &$tabindex ], '1.29' );
4246 // Copy back any additional old-style checkboxes into the new-style structure
4247 foreach ( $legacyCheckboxes as $name => $html ) {
4248 if ( $html && !isset( $checkboxes[$name] ) ) {
4249 $checkboxes[$name] = new OOUI\
Widget( [ 'content' => new OOUI\
HtmlSnippet( $html ) ] );
4257 * Get the message key of the label for the button to save the page
4262 protected function getSubmitButtonLabel() {
4264 $this->context
->getConfig()->get( 'EditSubmitButtonLabelPublish' );
4266 // Can't use $this->isNew as that's also true if we're adding a new section to an extant page
4267 $newPage = !$this->mTitle
->exists();
4269 if ( $labelAsPublish ) {
4270 $buttonLabelKey = $newPage ?
'publishpage' : 'publishchanges';
4272 $buttonLabelKey = $newPage ?
'savearticle' : 'savechanges';
4275 return $buttonLabelKey;
4279 * Returns an array of html code of the following buttons:
4280 * save, diff and preview
4282 * @param int &$tabindex Current tabindex
4286 public function getEditButtons( &$tabindex ) {
4290 $this->context
->getConfig()->get( 'EditSubmitButtonLabelPublish' );
4292 $buttonLabel = $this->context
->msg( $this->getSubmitButtonLabel() )->text();
4293 $buttonTooltip = $labelAsPublish ?
'publish' : 'save';
4295 $buttons['save'] = new OOUI\
ButtonInputWidget( [
4297 'tabIndex' => ++
$tabindex,
4298 'id' => 'wpSaveWidget',
4299 'inputId' => 'wpSave',
4300 // Support: IE 6 βΒ Use <input>, otherwise it can't distinguish which button was clicked
4301 'useInputTag' => true,
4302 'flags' => [ 'progressive', 'primary' ],
4303 'label' => $buttonLabel,
4304 'infusable' => true,
4306 // Messages used: tooltip-save, tooltip-publish
4307 'title' => Linker
::titleAttrib( $buttonTooltip ),
4308 // Messages used: accesskey-save, accesskey-publish
4309 'accessKey' => Linker
::accesskey( $buttonTooltip ),
4312 $buttons['preview'] = new OOUI\
ButtonInputWidget( [
4313 'name' => 'wpPreview',
4314 'tabIndex' => ++
$tabindex,
4315 'id' => 'wpPreviewWidget',
4316 'inputId' => 'wpPreview',
4317 // Support: IE 6 βΒ Use <input>, otherwise it can't distinguish which button was clicked
4318 'useInputTag' => true,
4319 'label' => $this->context
->msg( 'showpreview' )->text(),
4320 'infusable' => true,
4322 // Message used: tooltip-preview
4323 'title' => Linker
::titleAttrib( 'preview' ),
4324 // Message used: accesskey-preview
4325 'accessKey' => Linker
::accesskey( 'preview' ),
4328 $buttons['diff'] = new OOUI\
ButtonInputWidget( [
4330 'tabIndex' => ++
$tabindex,
4331 'id' => 'wpDiffWidget',
4332 'inputId' => 'wpDiff',
4333 // Support: IE 6 βΒ Use <input>, otherwise it can't distinguish which button was clicked
4334 'useInputTag' => true,
4335 'label' => $this->context
->msg( 'showdiff' )->text(),
4336 'infusable' => true,
4338 // Message used: tooltip-diff
4339 'title' => Linker
::titleAttrib( 'diff' ),
4340 // Message used: accesskey-diff
4341 'accessKey' => Linker
::accesskey( 'diff' ),
4344 // Avoid PHP 7.1 warning of passing $this by reference
4346 Hooks
::run( 'EditPageBeforeEditButtons', [ &$editPage, &$buttons, &$tabindex ] );
4352 * Creates a basic error page which informs the user that
4353 * they have attempted to edit a nonexistent section.
4355 public function noSuchSectionPage() {
4356 $out = $this->context
->getOutput();
4357 $out->prepareErrorPage( $this->context
->msg( 'nosuchsectiontitle' ) );
4359 $res = $this->context
->msg( 'nosuchsectiontext', $this->section
)->parseAsBlock();
4361 // Avoid PHP 7.1 warning of passing $this by reference
4363 Hooks
::run( 'EditPageNoSuchSection', [ &$editPage, &$res ] );
4364 $out->addHTML( $res );
4366 $out->returnToMain( false, $this->mTitle
);
4370 * Show "your edit contains spam" page with your diff and text
4372 * @param string|array|bool $match Text (or array of texts) which triggered one or more filters
4374 public function spamPageWithContent( $match = false ) {
4375 $this->textbox2
= $this->textbox1
;
4377 if ( is_array( $match ) ) {
4378 $match = $this->context
->getLanguage()->listToText( $match );
4380 $out = $this->context
->getOutput();
4381 $out->prepareErrorPage( $this->context
->msg( 'spamprotectiontitle' ) );
4383 $out->addHTML( '<div id="spamprotected">' );
4384 $out->addWikiMsg( 'spamprotectiontext' );
4386 $out->addWikiMsg( 'spamprotectionmatch', wfEscapeWikiText( $match ) );
4388 $out->addHTML( '</div>' );
4390 $out->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
4393 $out->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
4394 $this->showTextbox2();
4396 $out->addReturnTo( $this->getContextTitle(), [ 'action' => 'edit' ] );
4400 * Filter an input field through a Unicode de-armoring process if it
4401 * came from an old browser with known broken Unicode editing issues.
4403 * @deprecated since 1.30, does nothing
4405 * @param WebRequest $request
4406 * @param string $field
4409 protected function safeUnicodeInput( $request, $field ) {
4410 return rtrim( $request->getText( $field ) );
4414 * Filter an output field through a Unicode armoring process if it is
4415 * going to an old browser with known broken Unicode editing issues.
4417 * @deprecated since 1.30, does nothing
4419 * @param string $text
4422 protected function safeUnicodeOutput( $text ) {
4429 protected function addEditNotices() {
4430 $out = $this->context
->getOutput();
4431 $editNotices = $this->mTitle
->getEditNotices( $this->oldid
);
4432 if ( count( $editNotices ) ) {
4433 $out->addHTML( implode( "\n", $editNotices ) );
4435 $msg = $this->context
->msg( 'editnotice-notext' );
4436 if ( !$msg->isDisabled() ) {
4438 '<div class="mw-editnotice-notext">'
4439 . $msg->parseAsBlock()
4449 protected function addTalkPageText() {
4450 if ( $this->mTitle
->isTalkPage() ) {
4451 $this->context
->getOutput()->addWikiMsg( 'talkpagetext' );
4458 protected function addLongPageWarningHeader() {
4459 if ( $this->contentLength
=== false ) {
4460 $this->contentLength
= strlen( $this->textbox1
);
4463 $out = $this->context
->getOutput();
4464 $lang = $this->context
->getLanguage();
4465 $maxArticleSize = $this->context
->getConfig()->get( 'MaxArticleSize' );
4466 if ( $this->tooBig ||
$this->contentLength
> $maxArticleSize * 1024 ) {
4467 $out->wrapWikiMsg( "<div class='error' id='mw-edit-longpageerror'>\n$1\n</div>",
4470 $lang->formatNum( round( $this->contentLength
/ 1024, 3 ) ),
4471 $lang->formatNum( $maxArticleSize )
4475 if ( !$this->context
->msg( 'longpage-hint' )->isDisabled() ) {
4476 $out->wrapWikiMsg( "<div id='mw-edit-longpage-hint'>\n$1\n</div>",
4479 $lang->formatSize( strlen( $this->textbox1
) ),
4480 strlen( $this->textbox1
)
4490 protected function addPageProtectionWarningHeaders() {
4491 $out = $this->context
->getOutput();
4492 if ( $this->mTitle
->isProtected( 'edit' ) &&
4493 MWNamespace
::getRestrictionLevels( $this->mTitle
->getNamespace() ) !== [ '' ]
4495 # Is the title semi-protected?
4496 if ( $this->mTitle
->isSemiProtected() ) {
4497 $noticeMsg = 'semiprotectedpagewarning';
4499 # Then it must be protected based on static groups (regular)
4500 $noticeMsg = 'protectedpagewarning';
4502 LogEventsList
::showLogExtract( $out, 'protect', $this->mTitle
, '',
4503 [ 'lim' => 1, 'msgKey' => [ $noticeMsg ] ] );
4505 if ( $this->mTitle
->isCascadeProtected() ) {
4506 # Is this page under cascading protection from some source pages?
4507 /** @var Title[] $cascadeSources */
4508 list( $cascadeSources, /* $restrictions */ ) = $this->mTitle
->getCascadeProtectionSources();
4509 $notice = "<div class='mw-cascadeprotectedwarning'>\n$1\n";
4510 $cascadeSourcesCount = count( $cascadeSources );
4511 if ( $cascadeSourcesCount > 0 ) {
4512 # Explain, and list the titles responsible
4513 foreach ( $cascadeSources as $page ) {
4514 $notice .= '* [[:' . $page->getPrefixedText() . "]]\n";
4517 $notice .= '</div>';
4518 $out->wrapWikiMsg( $notice, [ 'cascadeprotectedwarning', $cascadeSourcesCount ] );
4520 if ( !$this->mTitle
->exists() && $this->mTitle
->getRestrictions( 'create' ) ) {
4521 LogEventsList
::showLogExtract( $out, 'protect', $this->mTitle
, '',
4523 'showIfEmpty' => false,
4524 'msgKey' => [ 'titleprotectedwarning' ],
4525 'wrap' => "<div class=\"mw-titleprotectedwarning\">\n$1</div>" ] );
4530 * @param OutputPage $out
4533 protected function addExplainConflictHeader( OutputPage
$out ) {
4535 $this->getEditConflictHelper()->getExplainHeader()
4540 * @param string $name
4541 * @param mixed[] $customAttribs
4546 protected function buildTextboxAttribs( $name, array $customAttribs, User
$user ) {
4547 return ( new TextboxBuilder() )->buildTextboxAttribs(
4548 $name, $customAttribs, $user, $this->mTitle
4553 * @param string $wikitext
4557 protected function addNewLineAtEnd( $wikitext ) {
4558 return ( new TextboxBuilder() )->addNewLineAtEnd( $wikitext );
4562 * Turns section name wikitext into anchors for use in HTTP redirects. Various
4563 * versions of Microsoft browsers misinterpret fragment encoding of Location: headers
4564 * resulting in mojibake in address bar. Redirect them to legacy section IDs,
4565 * if possible. All the other browsers get HTML5 if the wiki is configured for it, to
4566 * spread the new style links more efficiently.
4568 * @param string $text
4571 private function guessSectionName( $text ) {
4574 // Detect Microsoft browsers
4575 $userAgent = $this->context
->getRequest()->getHeader( 'User-Agent' );
4576 if ( $userAgent && preg_match( '/MSIE|Edge/', $userAgent ) ) {
4577 // ...and redirect them to legacy encoding, if available
4578 return $wgParser->guessLegacySectionNameFromWikiText( $text );
4580 // Meanwhile, real browsers get real anchors
4581 return $wgParser->guessSectionNameFromWikiText( $text );
4585 * Set a factory function to create an EditConflictHelper
4587 * @param callable $factory Factory function
4590 public function setEditConflictHelperFactory( callable
$factory ) {
4591 $this->editConflictHelperFactory
= $factory;
4592 $this->editConflictHelper
= null;
4596 * @return TextConflictHelper
4598 private function getEditConflictHelper() {
4599 if ( !$this->editConflictHelper
) {
4600 $this->editConflictHelper
= call_user_func(
4601 $this->editConflictHelperFactory
,
4602 $this->getSubmitButtonLabel()
4606 return $this->editConflictHelper
;
4610 * @param string $submitButtonLabel
4611 * @return TextConflictHelper
4613 private function newTextConflictHelper( $submitButtonLabel ) {
4614 return new TextConflictHelper(
4616 $this->getContext()->getOutput(),
4617 MediaWikiServices
::getInstance()->getStatsdDataFactory(),