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\Logger\LoggerFactory
;
24 use MediaWiki\MediaWikiServices
;
27 * The edit page/HTML interface (split from Article)
28 * The actual database and text munging is still in Article,
29 * but it should get easier to call those from alternate
32 * EditPage cares about two distinct titles:
33 * $this->mContextTitle is the page that forms submit to, links point to,
34 * redirects go to, etc. $this->mTitle (as well as $mArticle) is the
35 * page in the database that is actually being edited. These are
36 * usually the same, but they are now allowed to be different.
38 * Surgeon General's Warning: prolonged exposure to this class is known to cause
39 * headaches, which may be fatal.
43 * Status: Article successfully updated
45 const AS_SUCCESS_UPDATE
= 200;
48 * Status: Article successfully created
50 const AS_SUCCESS_NEW_ARTICLE
= 201;
53 * Status: Article update aborted by a hook function
55 const AS_HOOK_ERROR
= 210;
58 * Status: A hook function returned an error
60 const AS_HOOK_ERROR_EXPECTED
= 212;
63 * Status: User is blocked from editing this page
65 const AS_BLOCKED_PAGE_FOR_USER
= 215;
68 * Status: Content too big (> $wgMaxArticleSize)
70 const AS_CONTENT_TOO_BIG
= 216;
73 * Status: this anonymous user is not allowed to edit this page
75 const AS_READ_ONLY_PAGE_ANON
= 218;
78 * Status: this logged in user is not allowed to edit this page
80 const AS_READ_ONLY_PAGE_LOGGED
= 219;
83 * Status: wiki is in readonly mode (wfReadOnly() == true)
85 const AS_READ_ONLY_PAGE
= 220;
88 * Status: rate limiter for action 'edit' was tripped
90 const AS_RATE_LIMITED
= 221;
93 * Status: article was deleted while editing and param wpRecreate == false or form
96 const AS_ARTICLE_WAS_DELETED
= 222;
99 * Status: user tried to create this page, but is not allowed to do that
100 * ( Title->userCan('create') == false )
102 const AS_NO_CREATE_PERMISSION
= 223;
105 * Status: user tried to create a blank page and wpIgnoreBlankArticle == false
107 const AS_BLANK_ARTICLE
= 224;
110 * Status: (non-resolvable) edit conflict
112 const AS_CONFLICT_DETECTED
= 225;
115 * Status: no edit summary given and the user has forceeditsummary set and the user is not
116 * editing in his own userspace or talkspace and wpIgnoreBlankSummary == false
118 const AS_SUMMARY_NEEDED
= 226;
121 * Status: user tried to create a new section without content
123 const AS_TEXTBOX_EMPTY
= 228;
126 * Status: article is too big (> $wgMaxArticleSize), after merging in the new section
128 const AS_MAX_ARTICLE_SIZE_EXCEEDED
= 229;
131 * Status: WikiPage::doEdit() was unsuccessful
136 * Status: summary contained spam according to one of the regexes in $wgSummarySpamRegex
138 const AS_SPAM_ERROR
= 232;
141 * Status: anonymous user is not allowed to upload (User::isAllowed('upload') == false)
143 const AS_IMAGE_REDIRECT_ANON
= 233;
146 * Status: logged in user is not allowed to upload (User::isAllowed('upload') == false)
148 const AS_IMAGE_REDIRECT_LOGGED
= 234;
151 * Status: user tried to modify the content model, but is not allowed to do that
152 * ( User::isAllowed('editcontentmodel') == false )
154 const AS_NO_CHANGE_CONTENT_MODEL
= 235;
157 * Status: user tried to create self-redirect (redirect to the same article) and
158 * wpIgnoreSelfRedirect == false
160 const AS_SELF_REDIRECT
= 236;
163 * Status: an error relating to change tagging. Look at the message key for
166 const AS_CHANGE_TAG_ERROR
= 237;
169 * Status: can't parse content
171 const AS_PARSE_ERROR
= 240;
174 * Status: when changing the content model is disallowed due to
175 * $wgContentHandlerUseDB being false
177 const AS_CANNOT_USE_CUSTOM_MODEL
= 241;
180 * HTML id and name for the beginning of the edit form.
182 const EDITFORM_ID
= 'editform';
185 * Prefix of key for cookie used to pass post-edit state.
186 * The revision id edited is added after this
188 const POST_EDIT_COOKIE_KEY_PREFIX
= 'PostEditRevision';
191 * Duration of PostEdit cookie, in seconds.
192 * The cookie will be removed instantly if the JavaScript runs.
194 * Otherwise, though, we don't want the cookies to accumulate.
195 * RFC 2109 ( https://www.ietf.org/rfc/rfc2109.txt ) specifies a possible
196 * limit of only 20 cookies per domain. This still applies at least to some
197 * versions of IE without full updates:
198 * https://blogs.msdn.com/b/ieinternals/archive/2009/08/20/wininet-ie-cookie-internals-faq.aspx
200 * A value of 20 minutes should be enough to take into account slow loads and minor
201 * clock skew while still avoiding cookie accumulation when JavaScript is turned off.
203 const POST_EDIT_COOKIE_DURATION
= 1200;
213 /** @var null|Title */
214 private $mContextTitle = null;
217 public $action = 'submit';
220 public $isConflict = false;
223 public $isCssJsSubpage = false;
226 public $isCssSubpage = false;
229 public $isJsSubpage = false;
232 public $isWrongCaseCssJsPage = false;
234 /** @var bool New page or new section */
235 public $isNew = false;
238 public $deletedSinceEdit;
246 /** @var bool|stdClass */
250 public $mTokenOk = false;
253 public $mTokenOkExceptSuffix = false;
256 public $mTriedSave = false;
259 public $incompleteForm = false;
262 public $tooBig = false;
265 public $missingComment = false;
268 public $missingSummary = false;
271 public $allowBlankSummary = false;
274 protected $blankArticle = false;
277 protected $allowBlankArticle = false;
280 protected $selfRedirect = false;
283 protected $allowSelfRedirect = false;
286 public $autoSumm = '';
289 public $hookError = '';
291 /** @var ParserOutput */
292 public $mParserOutput;
294 /** @var bool Has a summary been preset using GET parameter &summary= ? */
295 public $hasPresetSummary = false;
298 public $mBaseRevision = false;
301 public $mShowSummaryField = true;
306 public $save = false;
309 public $preview = false;
312 public $diff = false;
315 public $minoredit = false;
318 public $watchthis = false;
321 public $recreate = false;
324 public $textbox1 = '';
327 public $textbox2 = '';
330 public $summary = '';
333 public $nosummary = false;
336 public $edittime = '';
339 private $editRevId = null;
342 public $section = '';
345 public $sectiontitle = '';
348 public $starttime = '';
354 public $parentRevId = 0;
357 public $editintro = '';
360 public $scrolltop = null;
365 /** @var null|string */
366 public $contentModel = null;
368 /** @var null|string */
369 public $contentFormat = null;
371 /** @var null|array */
372 private $changeTags = null;
374 # Placeholders for text injection by hooks (must be HTML)
375 # extensions should take care to _append_ to the present value
377 /** @var string Before even the preview */
378 public $editFormPageTop = '';
379 public $editFormTextTop = '';
380 public $editFormTextBeforeContent = '';
381 public $editFormTextAfterWarn = '';
382 public $editFormTextAfterTools = '';
383 public $editFormTextBottom = '';
384 public $editFormTextAfterContent = '';
385 public $previewTextAfterContent = '';
386 public $mPreloadContent = null;
388 /* $didSave should be set to true whenever an article was successfully altered. */
389 public $didSave = false;
390 public $undidRev = 0;
392 public $suppressIntro = false;
398 protected $contentLength = false;
401 * @var bool Set in ApiEditPage, based on ContentHandler::allowsDirectApiEditing
403 private $enableApiEditOverride = false;
406 * @var IContextSource
411 * @param Article $article
413 public function __construct( Article
$article ) {
414 $this->mArticle
= $article;
415 $this->page
= $article->getPage(); // model object
416 $this->mTitle
= $article->getTitle();
417 $this->context
= $article->getContext();
419 $this->contentModel
= $this->mTitle
->getContentModel();
421 $handler = ContentHandler
::getForModelID( $this->contentModel
);
422 $this->contentFormat
= $handler->getDefaultFormat();
428 public function getArticle() {
429 return $this->mArticle
;
434 * @return IContextSource
436 public function getContext() {
437 return $this->context
;
444 public function getTitle() {
445 return $this->mTitle
;
449 * Set the context Title object
451 * @param Title|null $title Title object or null
453 public function setContextTitle( $title ) {
454 $this->mContextTitle
= $title;
458 * Get the context title object.
459 * If not set, $wgTitle will be returned. This behavior might change in
460 * the future to return $this->mTitle instead.
464 public function getContextTitle() {
465 if ( is_null( $this->mContextTitle
) ) {
469 return $this->mContextTitle
;
474 * Returns if the given content model is editable.
476 * @param string $modelId The ID of the content model to test. Use CONTENT_MODEL_XXX constants.
478 * @throws MWException If $modelId has no known handler
480 public function isSupportedContentModel( $modelId ) {
481 return $this->enableApiEditOverride
=== true ||
482 ContentHandler
::getForModelID( $modelId )->supportsDirectEditing();
486 * Allow editing of content that supports API direct editing, but not general
487 * direct editing. Set to false by default.
489 * @param bool $enableOverride
491 public function setApiEditOverride( $enableOverride ) {
492 $this->enableApiEditOverride
= $enableOverride;
500 * This is the function that gets called for "action=edit". It
501 * sets up various member variables, then passes execution to
502 * another function, usually showEditForm()
504 * The edit form is self-submitting, so that when things like
505 * preview and edit conflicts occur, we get the same form back
506 * with the extra stuff added. Only when the final submission
507 * is made and all is well do we actually save and redirect to
508 * the newly-edited page.
511 global $wgOut, $wgRequest, $wgUser;
512 // Allow extensions to modify/prevent this form or submission
513 if ( !Hooks
::run( 'AlternateEdit', [ $this ] ) ) {
517 wfDebug( __METHOD__
. ": enter\n" );
519 // If they used redlink=1 and the page exists, redirect to the main article
520 if ( $wgRequest->getBool( 'redlink' ) && $this->mTitle
->exists() ) {
521 $wgOut->redirect( $this->mTitle
->getFullURL() );
525 $this->importFormData( $wgRequest );
526 $this->firsttime
= false;
528 if ( wfReadOnly() && $this->save
) {
531 $this->preview
= true;
535 $this->formtype
= 'save';
536 } elseif ( $this->preview
) {
537 $this->formtype
= 'preview';
538 } elseif ( $this->diff
) {
539 $this->formtype
= 'diff';
540 } else { # First time through
541 $this->firsttime
= true;
542 if ( $this->previewOnOpen() ) {
543 $this->formtype
= 'preview';
545 $this->formtype
= 'initial';
549 $permErrors = $this->getEditPermissionErrors( $this->save ?
'secure' : 'full' );
551 wfDebug( __METHOD__
. ": User can't edit\n" );
552 // Auto-block user's IP if the account was "hard" blocked
553 if ( !wfReadOnly() ) {
555 DeferredUpdates
::addCallableUpdate( function () use ( $user ) {
556 $user->spreadAnyEditBlock();
559 $this->displayPermissionsError( $permErrors );
564 $revision = $this->mArticle
->getRevisionFetched();
565 // Disallow editing revisions with content models different from the current one
566 // Undo edits being an exception in order to allow reverting content model changes.
568 && $revision->getContentModel() !== $this->contentModel
571 if ( $this->undidRev
) {
572 $undidRevObj = Revision
::newFromId( $this->undidRev
);
573 $prevRev = $undidRevObj ?
$undidRevObj->getPrevious() : null;
575 if ( !$this->undidRev
577 ||
$prevRev->getContentModel() !== $this->contentModel
579 $this->displayViewSourcePage(
580 $this->getContentObject(),
582 'contentmodelediterror',
583 $revision->getContentModel(),
591 $this->isConflict
= false;
592 // css / js subpages of user pages get a special treatment
593 $this->isCssJsSubpage
= $this->mTitle
->isCssJsSubpage();
594 $this->isCssSubpage
= $this->mTitle
->isCssSubpage();
595 $this->isJsSubpage
= $this->mTitle
->isJsSubpage();
596 // @todo FIXME: Silly assignment.
597 $this->isWrongCaseCssJsPage
= $this->isWrongCaseCssJsPage();
599 # Show applicable editing introductions
600 if ( $this->formtype
== 'initial' ||
$this->firsttime
) {
604 # Attempt submission here. This will check for edit conflicts,
605 # and redundantly check for locked database, blocked IPs, etc.
606 # that edit() already checked just in case someone tries to sneak
607 # in the back door with a hand-edited submission URL.
609 if ( 'save' == $this->formtype
) {
610 $resultDetails = null;
611 $status = $this->attemptSave( $resultDetails );
612 if ( !$this->handleStatus( $status, $resultDetails ) ) {
617 # First time through: get contents, set time for conflict
619 if ( 'initial' == $this->formtype ||
$this->firsttime
) {
620 if ( $this->initialiseForm() === false ) {
621 $this->noSuchSectionPage();
625 if ( !$this->mTitle
->getArticleID() ) {
626 Hooks
::run( 'EditFormPreloadText', [ &$this->textbox1
, &$this->mTitle
] );
628 Hooks
::run( 'EditFormInitialText', [ $this ] );
633 $this->showEditForm();
637 * @param string $rigor Same format as Title::getUserPermissionErrors()
640 protected function getEditPermissionErrors( $rigor = 'secure' ) {
643 $permErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $wgUser, $rigor );
644 # Can this title be created?
645 if ( !$this->mTitle
->exists() ) {
646 $permErrors = array_merge(
649 $this->mTitle
->getUserPermissionsErrors( 'create', $wgUser, $rigor ),
654 # Ignore some permissions errors when a user is just previewing/viewing diffs
656 foreach ( $permErrors as $error ) {
657 if ( ( $this->preview ||
$this->diff
)
658 && ( $error[0] == 'blockedtext' ||
$error[0] == 'autoblockedtext' )
663 $permErrors = wfArrayDiff2( $permErrors, $remove );
669 * Display a permissions error page, like OutputPage::showPermissionsErrorPage(),
670 * but with the following differences:
671 * - If redlink=1, the user will be redirected to the page
672 * - If there is content to display or the error occurs while either saving,
673 * previewing or showing the difference, it will be a
674 * "View source for ..." page displaying the source code after the error message.
677 * @param array $permErrors Array of permissions errors, as returned by
678 * Title::getUserPermissionsErrors().
679 * @throws PermissionsError
681 protected function displayPermissionsError( array $permErrors ) {
682 global $wgRequest, $wgOut;
684 if ( $wgRequest->getBool( 'redlink' ) ) {
685 // The edit page was reached via a red link.
686 // Redirect to the article page and let them click the edit tab if
687 // they really want a permission error.
688 $wgOut->redirect( $this->mTitle
->getFullURL() );
692 $content = $this->getContentObject();
694 # Use the normal message if there's nothing to display
695 if ( $this->firsttime
&& ( !$content ||
$content->isEmpty() ) ) {
696 $action = $this->mTitle
->exists() ?
'edit' :
697 ( $this->mTitle
->isTalkPage() ?
'createtalk' : 'createpage' );
698 throw new PermissionsError( $action, $permErrors );
701 $this->displayViewSourcePage(
703 $wgOut->formatPermissionsErrorMessage( $permErrors, 'edit' )
708 * Display a read-only View Source page
709 * @param Content $content content object
710 * @param string $errorMessage additional wikitext error message to display
712 protected function displayViewSourcePage( Content
$content, $errorMessage = '' ) {
715 Hooks
::run( 'EditPage::showReadOnlyForm:initial', [ $this, &$wgOut ] );
717 $wgOut->setRobotPolicy( 'noindex,nofollow' );
718 $wgOut->setPageTitle( wfMessage(
720 $this->getContextTitle()->getPrefixedText()
722 $wgOut->addBacklinkSubtitle( $this->getContextTitle() );
723 $wgOut->addHTML( $this->editFormPageTop
);
724 $wgOut->addHTML( $this->editFormTextTop
);
726 if ( $errorMessage !== '' ) {
727 $wgOut->addWikiText( $errorMessage );
728 $wgOut->addHTML( "<hr />\n" );
731 # If the user made changes, preserve them when showing the markup
732 # (This happens when a user is blocked during edit, for instance)
733 if ( !$this->firsttime
) {
734 $text = $this->textbox1
;
735 $wgOut->addWikiMsg( 'viewyourtext' );
738 $text = $this->toEditText( $content );
739 } catch ( MWException
$e ) {
740 # Serialize using the default format if the content model is not supported
741 # (e.g. for an old revision with a different model)
742 $text = $content->serialize();
744 $wgOut->addWikiMsg( 'viewsourcetext' );
747 $wgOut->addHTML( $this->editFormTextBeforeContent
);
748 $this->showTextbox( $text, 'wpTextbox1', [ 'readonly' ] );
749 $wgOut->addHTML( $this->editFormTextAfterContent
);
751 $wgOut->addHTML( $this->makeTemplatesOnThisPageList( $this->getTemplates() ) );
753 $wgOut->addModules( 'mediawiki.action.edit.collapsibleFooter' );
755 $wgOut->addHTML( $this->editFormTextBottom
);
756 if ( $this->mTitle
->exists() ) {
757 $wgOut->returnToMain( null, $this->mTitle
);
762 * Should we show a preview when the edit form is first shown?
766 protected function previewOnOpen() {
767 global $wgRequest, $wgUser, $wgPreviewOnOpenNamespaces;
768 if ( $wgRequest->getVal( 'preview' ) == 'yes' ) {
769 // Explicit override from request
771 } elseif ( $wgRequest->getVal( 'preview' ) == 'no' ) {
772 // Explicit override from request
774 } elseif ( $this->section
== 'new' ) {
775 // Nothing *to* preview for new sections
777 } elseif ( ( $wgRequest->getVal( 'preload' ) !== null ||
$this->mTitle
->exists() )
778 && $wgUser->getOption( 'previewonfirst' )
780 // Standard preference behavior
782 } elseif ( !$this->mTitle
->exists()
783 && isset( $wgPreviewOnOpenNamespaces[$this->mTitle
->getNamespace()] )
784 && $wgPreviewOnOpenNamespaces[$this->mTitle
->getNamespace()]
786 // Categories are special
794 * Checks whether the user entered a skin name in uppercase,
795 * e.g. "User:Example/Monobook.css" instead of "monobook.css"
799 protected function isWrongCaseCssJsPage() {
800 if ( $this->mTitle
->isCssJsSubpage() ) {
801 $name = $this->mTitle
->getSkinFromCssJsSubpage();
802 $skins = array_merge(
803 array_keys( Skin
::getSkinNames() ),
806 return !in_array( $name, $skins )
807 && in_array( strtolower( $name ), $skins );
814 * Returns whether section editing is supported for the current page.
815 * Subclasses may override this to replace the default behavior, which is
816 * to check ContentHandler::supportsSections.
818 * @return bool True if this edit page supports sections, false otherwise.
820 protected function isSectionEditSupported() {
821 $contentHandler = ContentHandler
::getForTitle( $this->mTitle
);
822 return $contentHandler->supportsSections();
826 * This function collects the form data and uses it to populate various member variables.
827 * @param WebRequest $request
828 * @throws ErrorPageError
830 function importFormData( &$request ) {
831 global $wgContLang, $wgUser;
833 # Section edit can come from either the form or a link
834 $this->section
= $request->getVal( 'wpSection', $request->getVal( 'section' ) );
836 if ( $this->section
!== null && $this->section
!== '' && !$this->isSectionEditSupported() ) {
837 throw new ErrorPageError( 'sectioneditnotsupported-title', 'sectioneditnotsupported-text' );
840 $this->isNew
= !$this->mTitle
->exists() ||
$this->section
== 'new';
842 if ( $request->wasPosted() ) {
843 # These fields need to be checked for encoding.
844 # Also remove trailing whitespace, but don't remove _initial_
845 # whitespace from the text boxes. This may be significant formatting.
846 $this->textbox1
= $this->safeUnicodeInput( $request, 'wpTextbox1' );
847 if ( !$request->getCheck( 'wpTextbox2' ) ) {
848 // Skip this if wpTextbox2 has input, it indicates that we came
849 // from a conflict page with raw page text, not a custom form
850 // modified by subclasses
851 $textbox1 = $this->importContentFormData( $request );
852 if ( $textbox1 !== null ) {
853 $this->textbox1
= $textbox1;
857 # Truncate for whole multibyte characters
858 $this->summary
= $wgContLang->truncate( $request->getText( 'wpSummary' ), 255 );
860 # If the summary consists of a heading, e.g. '==Foobar==', extract the title from the
861 # header syntax, e.g. 'Foobar'. This is mainly an issue when we are using wpSummary for
863 $this->summary
= preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->summary
);
865 # Treat sectiontitle the same way as summary.
866 # Note that wpSectionTitle is not yet a part of the actual edit form, as wpSummary is
867 # currently doing double duty as both edit summary and section title. Right now this
868 # is just to allow API edits to work around this limitation, but this should be
869 # incorporated into the actual edit form when EditPage is rewritten (Bugs 18654, 26312).
870 $this->sectiontitle
= $wgContLang->truncate( $request->getText( 'wpSectionTitle' ), 255 );
871 $this->sectiontitle
= preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->sectiontitle
);
873 $this->edittime
= $request->getVal( 'wpEdittime' );
874 $this->editRevId
= $request->getIntOrNull( 'editRevId' );
875 $this->starttime
= $request->getVal( 'wpStarttime' );
877 $undidRev = $request->getInt( 'wpUndidRevision' );
879 $this->undidRev
= $undidRev;
882 $this->scrolltop
= $request->getIntOrNull( 'wpScrolltop' );
884 if ( $this->textbox1
=== '' && $request->getVal( 'wpTextbox1' ) === null ) {
885 // wpTextbox1 field is missing, possibly due to being "too big"
886 // according to some filter rules such as Suhosin's setting for
887 // suhosin.request.max_value_length (d'oh)
888 $this->incompleteForm
= true;
890 // If we receive the last parameter of the request, we can fairly
891 // claim the POST request has not been truncated.
893 // TODO: softened the check for cutover. Once we determine
894 // that it is safe, we should complete the transition by
895 // removing the "edittime" clause.
896 $this->incompleteForm
= ( !$request->getVal( 'wpUltimateParam' )
897 && is_null( $this->edittime
) );
899 if ( $this->incompleteForm
) {
900 # If the form is incomplete, force to preview.
901 wfDebug( __METHOD__
. ": Form data appears to be incomplete\n" );
902 wfDebug( "POST DATA: " . var_export( $_POST, true ) . "\n" );
903 $this->preview
= true;
905 $this->preview
= $request->getCheck( 'wpPreview' );
906 $this->diff
= $request->getCheck( 'wpDiff' );
908 // Remember whether a save was requested, so we can indicate
909 // if we forced preview due to session failure.
910 $this->mTriedSave
= !$this->preview
;
912 if ( $this->tokenOk( $request ) ) {
913 # Some browsers will not report any submit button
914 # if the user hits enter in the comment box.
915 # The unmarked state will be assumed to be a save,
916 # if the form seems otherwise complete.
917 wfDebug( __METHOD__
. ": Passed token check.\n" );
918 } elseif ( $this->diff
) {
919 # Failed token check, but only requested "Show Changes".
920 wfDebug( __METHOD__
. ": Failed token check; Show Changes requested.\n" );
922 # Page might be a hack attempt posted from
923 # an external site. Preview instead of saving.
924 wfDebug( __METHOD__
. ": Failed token check; forcing preview\n" );
925 $this->preview
= true;
928 $this->save
= !$this->preview
&& !$this->diff
;
929 if ( !preg_match( '/^\d{14}$/', $this->edittime
) ) {
930 $this->edittime
= null;
933 if ( !preg_match( '/^\d{14}$/', $this->starttime
) ) {
934 $this->starttime
= null;
937 $this->recreate
= $request->getCheck( 'wpRecreate' );
939 $this->minoredit
= $request->getCheck( 'wpMinoredit' );
940 $this->watchthis
= $request->getCheck( 'wpWatchthis' );
942 # Don't force edit summaries when a user is editing their own user or talk page
943 if ( ( $this->mTitle
->mNamespace
== NS_USER ||
$this->mTitle
->mNamespace
== NS_USER_TALK
)
944 && $this->mTitle
->getText() == $wgUser->getName()
946 $this->allowBlankSummary
= true;
948 $this->allowBlankSummary
= $request->getBool( 'wpIgnoreBlankSummary' )
949 ||
!$wgUser->getOption( 'forceeditsummary' );
952 $this->autoSumm
= $request->getText( 'wpAutoSummary' );
954 $this->allowBlankArticle
= $request->getBool( 'wpIgnoreBlankArticle' );
955 $this->allowSelfRedirect
= $request->getBool( 'wpIgnoreSelfRedirect' );
957 $changeTags = $request->getVal( 'wpChangeTags' );
958 if ( is_null( $changeTags ) ||
$changeTags === '' ) {
959 $this->changeTags
= [];
961 $this->changeTags
= array_filter( array_map( 'trim', explode( ',',
965 # Not a posted form? Start with nothing.
966 wfDebug( __METHOD__
. ": Not a posted form.\n" );
967 $this->textbox1
= '';
969 $this->sectiontitle
= '';
970 $this->edittime
= '';
971 $this->editRevId
= null;
972 $this->starttime
= wfTimestampNow();
974 $this->preview
= false;
977 $this->minoredit
= false;
978 // Watch may be overridden by request parameters
979 $this->watchthis
= $request->getBool( 'watchthis', false );
980 $this->recreate
= false;
982 // When creating a new section, we can preload a section title by passing it as the
983 // preloadtitle parameter in the URL (Bug 13100)
984 if ( $this->section
== 'new' && $request->getVal( 'preloadtitle' ) ) {
985 $this->sectiontitle
= $request->getVal( 'preloadtitle' );
986 // Once wpSummary isn't being use for setting section titles, we should delete this.
987 $this->summary
= $request->getVal( 'preloadtitle' );
988 } elseif ( $this->section
!= 'new' && $request->getVal( 'summary' ) ) {
989 $this->summary
= $request->getText( 'summary' );
990 if ( $this->summary
!== '' ) {
991 $this->hasPresetSummary
= true;
995 if ( $request->getVal( 'minor' ) ) {
996 $this->minoredit
= true;
1000 $this->oldid
= $request->getInt( 'oldid' );
1001 $this->parentRevId
= $request->getInt( 'parentRevId' );
1003 $this->bot
= $request->getBool( 'bot', true );
1004 $this->nosummary
= $request->getBool( 'nosummary' );
1006 // May be overridden by revision.
1007 $this->contentModel
= $request->getText( 'model', $this->contentModel
);
1008 // May be overridden by revision.
1009 $this->contentFormat
= $request->getText( 'format', $this->contentFormat
);
1012 $handler = ContentHandler
::getForModelID( $this->contentModel
);
1013 } catch ( MWUnknownContentModelException
$e ) {
1014 throw new ErrorPageError(
1015 'editpage-invalidcontentmodel-title',
1016 'editpage-invalidcontentmodel-text',
1017 [ $this->contentModel
]
1021 if ( !$handler->isSupportedFormat( $this->contentFormat
) ) {
1022 throw new ErrorPageError(
1023 'editpage-notsupportedcontentformat-title',
1024 'editpage-notsupportedcontentformat-text',
1025 [ $this->contentFormat
, ContentHandler
::getLocalizedName( $this->contentModel
) ]
1030 * @todo Check if the desired model is allowed in this namespace, and if
1031 * a transition from the page's current model to the new model is
1035 $this->editintro
= $request->getText( 'editintro',
1036 // Custom edit intro for new sections
1037 $this->section
=== 'new' ?
'MediaWiki:addsection-editintro' : '' );
1039 // Allow extensions to modify form data
1040 Hooks
::run( 'EditPage::importFormData', [ $this, $request ] );
1045 * Subpage overridable method for extracting the page content data from the
1046 * posted form to be placed in $this->textbox1, if using customized input
1047 * this method should be overridden and return the page text that will be used
1048 * for saving, preview parsing and so on...
1050 * @param WebRequest $request
1051 * @return string|null
1053 protected function importContentFormData( &$request ) {
1054 return; // Don't do anything, EditPage already extracted wpTextbox1
1058 * Initialise form fields in the object
1059 * Called on the first invocation, e.g. when a user clicks an edit link
1060 * @return bool If the requested section is valid
1062 function initialiseForm() {
1064 $this->edittime
= $this->page
->getTimestamp();
1065 $this->editRevId
= $this->page
->getLatest();
1067 $content = $this->getContentObject( false ); # TODO: track content object?!
1068 if ( $content === false ) {
1071 $this->textbox1
= $this->toEditText( $content );
1073 // activate checkboxes if user wants them to be always active
1074 # Sort out the "watch" checkbox
1075 if ( $wgUser->getOption( 'watchdefault' ) ) {
1077 $this->watchthis
= true;
1078 } elseif ( $wgUser->getOption( 'watchcreations' ) && !$this->mTitle
->exists() ) {
1080 $this->watchthis
= true;
1081 } elseif ( $wgUser->isWatched( $this->mTitle
) ) {
1083 $this->watchthis
= true;
1085 if ( $wgUser->getOption( 'minordefault' ) && !$this->isNew
) {
1086 $this->minoredit
= true;
1088 if ( $this->textbox1
=== false ) {
1095 * @param Content|null $def_content The default value to return
1097 * @return Content|null Content on success, $def_content for invalid sections
1101 protected function getContentObject( $def_content = null ) {
1102 global $wgOut, $wgRequest, $wgUser, $wgContLang;
1106 // For message page not locally set, use the i18n message.
1107 // For other non-existent articles, use preload text if any.
1108 if ( !$this->mTitle
->exists() ||
$this->section
== 'new' ) {
1109 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
&& $this->section
!= 'new' ) {
1110 # If this is a system message, get the default text.
1111 $msg = $this->mTitle
->getDefaultMessageText();
1113 $content = $this->toEditContent( $msg );
1115 if ( $content === false ) {
1116 # If requested, preload some text.
1117 $preload = $wgRequest->getVal( 'preload',
1118 // Custom preload text for new sections
1119 $this->section
=== 'new' ?
'MediaWiki:addsection-preload' : '' );
1120 $params = $wgRequest->getArray( 'preloadparams', [] );
1122 $content = $this->getPreloadedContent( $preload, $params );
1124 // For existing pages, get text based on "undo" or section parameters.
1126 if ( $this->section
!= '' ) {
1127 // Get section edit text (returns $def_text for invalid sections)
1128 $orig = $this->getOriginalContent( $wgUser );
1129 $content = $orig ?
$orig->getSection( $this->section
) : null;
1132 $content = $def_content;
1135 $undoafter = $wgRequest->getInt( 'undoafter' );
1136 $undo = $wgRequest->getInt( 'undo' );
1138 if ( $undo > 0 && $undoafter > 0 ) {
1139 $undorev = Revision
::newFromId( $undo );
1140 $oldrev = Revision
::newFromId( $undoafter );
1142 # Sanity check, make sure it's the right page,
1143 # the revisions exist and they were not deleted.
1144 # Otherwise, $content will be left as-is.
1145 if ( !is_null( $undorev ) && !is_null( $oldrev ) &&
1146 !$undorev->isDeleted( Revision
::DELETED_TEXT
) &&
1147 !$oldrev->isDeleted( Revision
::DELETED_TEXT
)
1149 $content = $this->page
->getUndoContent( $undorev, $oldrev );
1151 if ( $content === false ) {
1152 # Warn the user that something went wrong
1153 $undoMsg = 'failure';
1155 $oldContent = $this->page
->getContent( Revision
::RAW
);
1156 $popts = ParserOptions
::newFromUserAndLang( $wgUser, $wgContLang );
1157 $newContent = $content->preSaveTransform( $this->mTitle
, $wgUser, $popts );
1158 if ( $newContent->getModel() !== $oldContent->getModel() ) {
1159 // The undo may change content
1160 // model if its reverting the top
1161 // edit. This can result in
1162 // mismatched content model/format.
1163 $this->contentModel
= $newContent->getModel();
1164 $this->contentFormat
= $oldrev->getContentFormat();
1167 if ( $newContent->equals( $oldContent ) ) {
1168 # Tell the user that the undo results in no change,
1169 # i.e. the revisions were already undone.
1170 $undoMsg = 'nochange';
1173 # Inform the user of our success and set an automatic edit summary
1174 $undoMsg = 'success';
1176 # If we just undid one rev, use an autosummary
1177 $firstrev = $oldrev->getNext();
1178 if ( $firstrev && $firstrev->getId() == $undo ) {
1179 $userText = $undorev->getUserText();
1180 if ( $userText === '' ) {
1181 $undoSummary = wfMessage(
1182 'undo-summary-username-hidden',
1184 )->inContentLanguage()->text();
1186 $undoSummary = wfMessage(
1190 )->inContentLanguage()->text();
1192 if ( $this->summary
=== '' ) {
1193 $this->summary
= $undoSummary;
1195 $this->summary
= $undoSummary . wfMessage( 'colon-separator' )
1196 ->inContentLanguage()->text() . $this->summary
;
1198 $this->undidRev
= $undo;
1200 $this->formtype
= 'diff';
1204 // Failed basic sanity checks.
1205 // Older revisions may have been removed since the link
1206 // was created, or we may simply have got bogus input.
1210 // Messages: undo-success, undo-failure, undo-norev, undo-nochange
1211 $class = ( $undoMsg == 'success' ?
'' : 'error ' ) . "mw-undo-{$undoMsg}";
1212 $this->editFormPageTop
.= $wgOut->parse( "<div class=\"{$class}\">" .
1213 wfMessage( 'undo-' . $undoMsg )->plain() . '</div>', true, /* interface */true );
1216 if ( $content === false ) {
1217 $content = $this->getOriginalContent( $wgUser );
1226 * Get the content of the wanted revision, without section extraction.
1228 * The result of this function can be used to compare user's input with
1229 * section replaced in its context (using WikiPage::replaceSectionAtRev())
1230 * to the original text of the edit.
1232 * This differs from Article::getContent() that when a missing revision is
1233 * encountered the result will be null and not the
1234 * 'missing-revision' message.
1237 * @param User $user The user to get the revision for
1238 * @return Content|null
1240 private function getOriginalContent( User
$user ) {
1241 if ( $this->section
== 'new' ) {
1242 return $this->getCurrentContent();
1244 $revision = $this->mArticle
->getRevisionFetched();
1245 if ( $revision === null ) {
1246 if ( !$this->contentModel
) {
1247 $this->contentModel
= $this->getTitle()->getContentModel();
1249 $handler = ContentHandler
::getForModelID( $this->contentModel
);
1251 return $handler->makeEmptyContent();
1253 $content = $revision->getContent( Revision
::FOR_THIS_USER
, $user );
1258 * Get the edit's parent revision ID
1260 * The "parent" revision is the ancestor that should be recorded in this
1261 * page's revision history. It is either the revision ID of the in-memory
1262 * article content, or in the case of a 3-way merge in order to rebase
1263 * across a recoverable edit conflict, the ID of the newer revision to
1264 * which we have rebased this page.
1267 * @return int Revision ID
1269 public function getParentRevId() {
1270 if ( $this->parentRevId
) {
1271 return $this->parentRevId
;
1273 return $this->mArticle
->getRevIdFetched();
1278 * Get the current content of the page. This is basically similar to
1279 * WikiPage::getContent( Revision::RAW ) except that when the page doesn't exist an empty
1280 * content object is returned instead of null.
1285 protected function getCurrentContent() {
1286 $rev = $this->page
->getRevision();
1287 $content = $rev ?
$rev->getContent( Revision
::RAW
) : null;
1289 if ( $content === false ||
$content === null ) {
1290 if ( !$this->contentModel
) {
1291 $this->contentModel
= $this->getTitle()->getContentModel();
1293 $handler = ContentHandler
::getForModelID( $this->contentModel
);
1295 return $handler->makeEmptyContent();
1296 } elseif ( !$this->undidRev
) {
1297 // Content models should always be the same since we error
1298 // out if they are different before this point (in ->edit()).
1299 // The exception being, during an undo, the current revision might
1300 // differ from the prior revision.
1301 $logger = LoggerFactory
::getInstance( 'editpage' );
1302 if ( $this->contentModel
!== $rev->getContentModel() ) {
1303 $logger->warning( "Overriding content model from current edit {prev} to {new}", [
1304 'prev' => $this->contentModel
,
1305 'new' => $rev->getContentModel(),
1306 'title' => $this->getTitle()->getPrefixedDBkey(),
1307 'method' => __METHOD__
1309 $this->contentModel
= $rev->getContentModel();
1312 // Given that the content models should match, the current selected
1313 // format should be supported.
1314 if ( !$content->isSupportedFormat( $this->contentFormat
) ) {
1315 $logger->warning( "Current revision content format unsupported. Overriding {prev} to {new}", [
1317 'prev' => $this->contentFormat
,
1318 'new' => $rev->getContentFormat(),
1319 'title' => $this->getTitle()->getPrefixedDBkey(),
1320 'method' => __METHOD__
1322 $this->contentFormat
= $rev->getContentFormat();
1329 * Use this method before edit() to preload some content into the edit box
1331 * @param Content $content
1335 public function setPreloadedContent( Content
$content ) {
1336 $this->mPreloadContent
= $content;
1340 * Get the contents to be preloaded into the box, either set by
1341 * an earlier setPreloadText() or by loading the given page.
1343 * @param string $preload Representing the title to preload from.
1344 * @param array $params Parameters to use (interface-message style) in the preloaded text
1350 protected function getPreloadedContent( $preload, $params = [] ) {
1353 if ( !empty( $this->mPreloadContent
) ) {
1354 return $this->mPreloadContent
;
1357 $handler = ContentHandler
::getForModelID( $this->contentModel
);
1359 if ( $preload === '' ) {
1360 return $handler->makeEmptyContent();
1363 $title = Title
::newFromText( $preload );
1364 # Check for existence to avoid getting MediaWiki:Noarticletext
1365 if ( $title === null ||
!$title->exists() ||
!$title->userCan( 'read', $wgUser ) ) {
1366 // TODO: somehow show a warning to the user!
1367 return $handler->makeEmptyContent();
1370 $page = WikiPage
::factory( $title );
1371 if ( $page->isRedirect() ) {
1372 $title = $page->getRedirectTarget();
1374 if ( $title === null ||
!$title->exists() ||
!$title->userCan( 'read', $wgUser ) ) {
1375 // TODO: somehow show a warning to the user!
1376 return $handler->makeEmptyContent();
1378 $page = WikiPage
::factory( $title );
1381 $parserOptions = ParserOptions
::newFromUser( $wgUser );
1382 $content = $page->getContent( Revision
::RAW
);
1385 // TODO: somehow show a warning to the user!
1386 return $handler->makeEmptyContent();
1389 if ( $content->getModel() !== $handler->getModelID() ) {
1390 $converted = $content->convert( $handler->getModelID() );
1392 if ( !$converted ) {
1393 // TODO: somehow show a warning to the user!
1394 wfDebug( "Attempt to preload incompatible content: " .
1395 "can't convert " . $content->getModel() .
1396 " to " . $handler->getModelID() );
1398 return $handler->makeEmptyContent();
1401 $content = $converted;
1404 return $content->preloadTransform( $title, $parserOptions, $params );
1408 * Make sure the form isn't faking a user's credentials.
1410 * @param WebRequest $request
1414 function tokenOk( &$request ) {
1416 $token = $request->getVal( 'wpEditToken' );
1417 $this->mTokenOk
= $wgUser->matchEditToken( $token );
1418 $this->mTokenOkExceptSuffix
= $wgUser->matchEditTokenNoSuffix( $token );
1419 return $this->mTokenOk
;
1423 * Sets post-edit cookie indicating the user just saved a particular revision.
1425 * This uses a temporary cookie for each revision ID so separate saves will never
1426 * interfere with each other.
1428 * The cookie is deleted in the mediawiki.action.view.postEdit JS module after
1429 * the redirect. It must be clearable by JavaScript code, so it must not be
1430 * marked HttpOnly. The JavaScript code converts the cookie to a wgPostEdit config
1433 * If the variable were set on the server, it would be cached, which is unwanted
1434 * since the post-edit state should only apply to the load right after the save.
1436 * @param int $statusValue The status value (to check for new article status)
1438 protected function setPostEditCookie( $statusValue ) {
1439 $revisionId = $this->page
->getLatest();
1440 $postEditKey = self
::POST_EDIT_COOKIE_KEY_PREFIX
. $revisionId;
1443 if ( $statusValue == self
::AS_SUCCESS_NEW_ARTICLE
) {
1445 } elseif ( $this->oldid
) {
1449 $response = RequestContext
::getMain()->getRequest()->response();
1450 $response->setCookie( $postEditKey, $val, time() + self
::POST_EDIT_COOKIE_DURATION
, [
1451 'httpOnly' => false,
1456 * Attempt submission
1457 * @param array|bool $resultDetails See docs for $result in internalAttemptSave
1458 * @throws UserBlockedError|ReadOnlyError|ThrottledError|PermissionsError
1459 * @return Status The resulting status object.
1461 public function attemptSave( &$resultDetails = false ) {
1464 # Allow bots to exempt some edits from bot flagging
1465 $bot = $wgUser->isAllowed( 'bot' ) && $this->bot
;
1466 $status = $this->internalAttemptSave( $resultDetails, $bot );
1468 Hooks
::run( 'EditPage::attemptSave:after', [ $this, $status, $resultDetails ] );
1474 * Handle status, such as after attempt save
1476 * @param Status $status
1477 * @param array|bool $resultDetails
1479 * @throws ErrorPageError
1480 * @return bool False, if output is done, true if rest of the form should be displayed
1482 private function handleStatus( Status
$status, $resultDetails ) {
1483 global $wgUser, $wgOut;
1486 * @todo FIXME: once the interface for internalAttemptSave() is made
1487 * nicer, this should use the message in $status
1489 if ( $status->value
== self
::AS_SUCCESS_UPDATE
1490 ||
$status->value
== self
::AS_SUCCESS_NEW_ARTICLE
1492 $this->didSave
= true;
1493 if ( !$resultDetails['nullEdit'] ) {
1494 $this->setPostEditCookie( $status->value
);
1498 // "wpExtraQueryRedirect" is a hidden input to modify
1499 // after save URL and is not used by actual edit form
1500 $request = RequestContext
::getMain()->getRequest();
1501 $extraQueryRedirect = $request->getVal( 'wpExtraQueryRedirect' );
1503 switch ( $status->value
) {
1504 case self
::AS_HOOK_ERROR_EXPECTED
:
1505 case self
::AS_CONTENT_TOO_BIG
:
1506 case self
::AS_ARTICLE_WAS_DELETED
:
1507 case self
::AS_CONFLICT_DETECTED
:
1508 case self
::AS_SUMMARY_NEEDED
:
1509 case self
::AS_TEXTBOX_EMPTY
:
1510 case self
::AS_MAX_ARTICLE_SIZE_EXCEEDED
:
1512 case self
::AS_BLANK_ARTICLE
:
1513 case self
::AS_SELF_REDIRECT
:
1516 case self
::AS_HOOK_ERROR
:
1519 case self
::AS_CANNOT_USE_CUSTOM_MODEL
:
1520 case self
::AS_PARSE_ERROR
:
1521 $wgOut->addWikiText( '<div class="error">' . "\n" . $status->getWikiText() . '</div>' );
1524 case self
::AS_SUCCESS_NEW_ARTICLE
:
1525 $query = $resultDetails['redirect'] ?
'redirect=no' : '';
1526 if ( $extraQueryRedirect ) {
1527 if ( $query === '' ) {
1528 $query = $extraQueryRedirect;
1530 $query = $query . '&' . $extraQueryRedirect;
1533 $anchor = isset( $resultDetails['sectionanchor'] ) ?
$resultDetails['sectionanchor'] : '';
1534 $wgOut->redirect( $this->mTitle
->getFullURL( $query ) . $anchor );
1537 case self
::AS_SUCCESS_UPDATE
:
1539 $sectionanchor = $resultDetails['sectionanchor'];
1541 // Give extensions a chance to modify URL query on update
1543 'ArticleUpdateBeforeRedirect',
1544 [ $this->mArticle
, &$sectionanchor, &$extraQuery ]
1547 if ( $resultDetails['redirect'] ) {
1548 if ( $extraQuery == '' ) {
1549 $extraQuery = 'redirect=no';
1551 $extraQuery = 'redirect=no&' . $extraQuery;
1554 if ( $extraQueryRedirect ) {
1555 if ( $extraQuery === '' ) {
1556 $extraQuery = $extraQueryRedirect;
1558 $extraQuery = $extraQuery . '&' . $extraQueryRedirect;
1562 $wgOut->redirect( $this->mTitle
->getFullURL( $extraQuery ) . $sectionanchor );
1565 case self
::AS_SPAM_ERROR
:
1566 $this->spamPageWithContent( $resultDetails['spam'] );
1569 case self
::AS_BLOCKED_PAGE_FOR_USER
:
1570 throw new UserBlockedError( $wgUser->getBlock() );
1572 case self
::AS_IMAGE_REDIRECT_ANON
:
1573 case self
::AS_IMAGE_REDIRECT_LOGGED
:
1574 throw new PermissionsError( 'upload' );
1576 case self
::AS_READ_ONLY_PAGE_ANON
:
1577 case self
::AS_READ_ONLY_PAGE_LOGGED
:
1578 throw new PermissionsError( 'edit' );
1580 case self
::AS_READ_ONLY_PAGE
:
1581 throw new ReadOnlyError
;
1583 case self
::AS_RATE_LIMITED
:
1584 throw new ThrottledError();
1586 case self
::AS_NO_CREATE_PERMISSION
:
1587 $permission = $this->mTitle
->isTalkPage() ?
'createtalk' : 'createpage';
1588 throw new PermissionsError( $permission );
1590 case self
::AS_NO_CHANGE_CONTENT_MODEL
:
1591 throw new PermissionsError( 'editcontentmodel' );
1594 // We don't recognize $status->value. The only way that can happen
1595 // is if an extension hook aborted from inside ArticleSave.
1596 // Render the status object into $this->hookError
1597 // FIXME this sucks, we should just use the Status object throughout
1598 $this->hookError
= '<div class="error">' ."\n" . $status->getWikiText() .
1605 * Run hooks that can filter edits just before they get saved.
1607 * @param Content $content The Content to filter.
1608 * @param Status $status For reporting the outcome to the caller
1609 * @param User $user The user performing the edit
1613 protected function runPostMergeFilters( Content
$content, Status
$status, User
$user ) {
1614 // Run old style post-section-merge edit filter
1615 if ( !ContentHandler
::runLegacyHooks( 'EditFilterMerged',
1616 [ $this, $content, &$this->hookError
, $this->summary
] )
1618 # Error messages etc. could be handled within the hook...
1619 $status->fatal( 'hookaborted' );
1620 $status->value
= self
::AS_HOOK_ERROR
;
1622 } elseif ( $this->hookError
!= '' ) {
1623 # ...or the hook could be expecting us to produce an error
1624 $status->fatal( 'hookaborted' );
1625 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1629 // Run new style post-section-merge edit filter
1630 if ( !Hooks
::run( 'EditFilterMergedContent',
1631 [ $this->mArticle
->getContext(), $content, $status, $this->summary
,
1632 $user, $this->minoredit
] )
1634 # Error messages etc. could be handled within the hook...
1635 if ( $status->isGood() ) {
1636 $status->fatal( 'hookaborted' );
1637 // Not setting $this->hookError here is a hack to allow the hook
1638 // to cause a return to the edit page without $this->hookError
1639 // being set. This is used by ConfirmEdit to display a captcha
1640 // without any error message cruft.
1642 $this->hookError
= $status->getWikiText();
1644 // Use the existing $status->value if the hook set it
1645 if ( !$status->value
) {
1646 $status->value
= self
::AS_HOOK_ERROR
;
1649 } elseif ( !$status->isOK() ) {
1650 # ...or the hook could be expecting us to produce an error
1651 // FIXME this sucks, we should just use the Status object throughout
1652 $this->hookError
= $status->getWikiText();
1653 $status->fatal( 'hookaborted' );
1654 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1662 * Return the summary to be used for a new section.
1664 * @param string $sectionanchor Set to the section anchor text
1667 private function newSectionSummary( &$sectionanchor = null ) {
1670 if ( $this->sectiontitle
!== '' ) {
1671 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $this->sectiontitle
);
1672 // If no edit summary was specified, create one automatically from the section
1673 // title and have it link to the new section. Otherwise, respect the summary as
1675 if ( $this->summary
=== '' ) {
1676 $cleanSectionTitle = $wgParser->stripSectionName( $this->sectiontitle
);
1677 return wfMessage( 'newsectionsummary' )
1678 ->rawParams( $cleanSectionTitle )->inContentLanguage()->text();
1680 } elseif ( $this->summary
!== '' ) {
1681 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $this->summary
);
1682 # This is a new section, so create a link to the new section
1683 # in the revision summary.
1684 $cleanSummary = $wgParser->stripSectionName( $this->summary
);
1685 return wfMessage( 'newsectionsummary' )
1686 ->rawParams( $cleanSummary )->inContentLanguage()->text();
1688 return $this->summary
;
1692 * Attempt submission (no UI)
1694 * @param array $result Array to add statuses to, currently with the
1696 * - spam (string): Spam string from content if any spam is detected by
1698 * - sectionanchor (string): Section anchor for a section save.
1699 * - nullEdit (boolean): Set if doEditContent is OK. True if null edit,
1701 * - redirect (bool): Set if doEditContent is OK. True if resulting
1702 * revision is a redirect.
1703 * @param bool $bot True if edit is being made under the bot right.
1705 * @return Status Status object, possibly with a message, but always with
1706 * one of the AS_* constants in $status->value,
1708 * @todo FIXME: This interface is TERRIBLE, but hard to get rid of due to
1709 * various error display idiosyncrasies. There are also lots of cases
1710 * where error metadata is set in the object and retrieved later instead
1711 * of being returned, e.g. AS_CONTENT_TOO_BIG and
1712 * AS_BLOCKED_PAGE_FOR_USER. All that stuff needs to be cleaned up some
1715 function internalAttemptSave( &$result, $bot = false ) {
1716 global $wgUser, $wgRequest, $wgParser, $wgMaxArticleSize;
1717 global $wgContentHandlerUseDB;
1719 $status = Status
::newGood();
1721 if ( !Hooks
::run( 'EditPage::attemptSave', [ $this ] ) ) {
1722 wfDebug( "Hook 'EditPage::attemptSave' aborted article saving\n" );
1723 $status->fatal( 'hookaborted' );
1724 $status->value
= self
::AS_HOOK_ERROR
;
1728 $spam = $wgRequest->getText( 'wpAntispam' );
1729 if ( $spam !== '' ) {
1732 $wgUser->getName() .
1734 $this->mTitle
->getPrefixedText() .
1735 '" submitted bogus field "' .
1739 $status->fatal( 'spamprotectionmatch', false );
1740 $status->value
= self
::AS_SPAM_ERROR
;
1745 # Construct Content object
1746 $textbox_content = $this->toEditContent( $this->textbox1
);
1747 } catch ( MWContentSerializationException
$ex ) {
1749 'content-failed-to-parse',
1750 $this->contentModel
,
1751 $this->contentFormat
,
1754 $status->value
= self
::AS_PARSE_ERROR
;
1758 # Check image redirect
1759 if ( $this->mTitle
->getNamespace() == NS_FILE
&&
1760 $textbox_content->isRedirect() &&
1761 !$wgUser->isAllowed( 'upload' )
1763 $code = $wgUser->isAnon() ? self
::AS_IMAGE_REDIRECT_ANON
: self
::AS_IMAGE_REDIRECT_LOGGED
;
1764 $status->setResult( false, $code );
1770 $match = self
::matchSummarySpamRegex( $this->summary
);
1771 if ( $match === false && $this->section
== 'new' ) {
1772 # $wgSpamRegex is enforced on this new heading/summary because, unlike
1773 # regular summaries, it is added to the actual wikitext.
1774 if ( $this->sectiontitle
!== '' ) {
1775 # This branch is taken when the API is used with the 'sectiontitle' parameter.
1776 $match = self
::matchSpamRegex( $this->sectiontitle
);
1778 # This branch is taken when the "Add Topic" user interface is used, or the API
1779 # is used with the 'summary' parameter.
1780 $match = self
::matchSpamRegex( $this->summary
);
1783 if ( $match === false ) {
1784 $match = self
::matchSpamRegex( $this->textbox1
);
1786 if ( $match !== false ) {
1787 $result['spam'] = $match;
1788 $ip = $wgRequest->getIP();
1789 $pdbk = $this->mTitle
->getPrefixedDBkey();
1790 $match = str_replace( "\n", '', $match );
1791 wfDebugLog( 'SpamRegex', "$ip spam regex hit [[$pdbk]]: \"$match\"" );
1792 $status->fatal( 'spamprotectionmatch', $match );
1793 $status->value
= self
::AS_SPAM_ERROR
;
1798 [ $this, $this->textbox1
, $this->section
, &$this->hookError
, $this->summary
] )
1800 # Error messages etc. could be handled within the hook...
1801 $status->fatal( 'hookaborted' );
1802 $status->value
= self
::AS_HOOK_ERROR
;
1804 } elseif ( $this->hookError
!= '' ) {
1805 # ...or the hook could be expecting us to produce an error
1806 $status->fatal( 'hookaborted' );
1807 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1811 if ( $wgUser->isBlockedFrom( $this->mTitle
, false ) ) {
1812 // Auto-block user's IP if the account was "hard" blocked
1813 if ( !wfReadOnly() ) {
1814 $wgUser->spreadAnyEditBlock();
1816 # Check block state against master, thus 'false'.
1817 $status->setResult( false, self
::AS_BLOCKED_PAGE_FOR_USER
);
1821 $this->contentLength
= strlen( $this->textbox1
);
1822 if ( $this->contentLength
> $wgMaxArticleSize * 1024 ) {
1823 // Error will be displayed by showEditForm()
1824 $this->tooBig
= true;
1825 $status->setResult( false, self
::AS_CONTENT_TOO_BIG
);
1829 if ( !$wgUser->isAllowed( 'edit' ) ) {
1830 if ( $wgUser->isAnon() ) {
1831 $status->setResult( false, self
::AS_READ_ONLY_PAGE_ANON
);
1834 $status->fatal( 'readonlytext' );
1835 $status->value
= self
::AS_READ_ONLY_PAGE_LOGGED
;
1840 $changingContentModel = false;
1841 if ( $this->contentModel
!== $this->mTitle
->getContentModel() ) {
1842 if ( !$wgContentHandlerUseDB ) {
1843 $status->fatal( 'editpage-cannot-use-custom-model' );
1844 $status->value
= self
::AS_CANNOT_USE_CUSTOM_MODEL
;
1846 } elseif ( !$wgUser->isAllowed( 'editcontentmodel' ) ) {
1847 $status->setResult( false, self
::AS_NO_CHANGE_CONTENT_MODEL
);
1851 $changingContentModel = true;
1852 $oldContentModel = $this->mTitle
->getContentModel();
1855 if ( $this->changeTags
) {
1856 $changeTagsStatus = ChangeTags
::canAddTagsAccompanyingChange(
1857 $this->changeTags
, $wgUser );
1858 if ( !$changeTagsStatus->isOK() ) {
1859 $changeTagsStatus->value
= self
::AS_CHANGE_TAG_ERROR
;
1860 return $changeTagsStatus;
1864 if ( wfReadOnly() ) {
1865 $status->fatal( 'readonlytext' );
1866 $status->value
= self
::AS_READ_ONLY_PAGE
;
1869 if ( $wgUser->pingLimiter() ||
$wgUser->pingLimiter( 'linkpurge', 0 )
1870 ||
( $changingContentModel && $wgUser->pingLimiter( 'editcontentmodel' ) )
1872 $status->fatal( 'actionthrottledtext' );
1873 $status->value
= self
::AS_RATE_LIMITED
;
1877 # If the article has been deleted while editing, don't save it without
1879 if ( $this->wasDeletedSinceLastEdit() && !$this->recreate
) {
1880 $status->setResult( false, self
::AS_ARTICLE_WAS_DELETED
);
1884 # Load the page data from the master. If anything changes in the meantime,
1885 # we detect it by using page_latest like a token in a 1 try compare-and-swap.
1886 $this->page
->loadPageData( 'fromdbmaster' );
1887 $new = !$this->page
->exists();
1890 // Late check for create permission, just in case *PARANOIA*
1891 if ( !$this->mTitle
->userCan( 'create', $wgUser ) ) {
1892 $status->fatal( 'nocreatetext' );
1893 $status->value
= self
::AS_NO_CREATE_PERMISSION
;
1894 wfDebug( __METHOD__
. ": no create permission\n" );
1898 // Don't save a new page if it's blank or if it's a MediaWiki:
1899 // message with content equivalent to default (allow empty pages
1900 // in this case to disable messages, see bug 50124)
1901 $defaultMessageText = $this->mTitle
->getDefaultMessageText();
1902 if ( $this->mTitle
->getNamespace() === NS_MEDIAWIKI
&& $defaultMessageText !== false ) {
1903 $defaultText = $defaultMessageText;
1908 if ( !$this->allowBlankArticle
&& $this->textbox1
=== $defaultText ) {
1909 $this->blankArticle
= true;
1910 $status->fatal( 'blankarticle' );
1911 $status->setResult( false, self
::AS_BLANK_ARTICLE
);
1915 if ( !$this->runPostMergeFilters( $textbox_content, $status, $wgUser ) ) {
1919 $content = $textbox_content;
1921 $result['sectionanchor'] = '';
1922 if ( $this->section
== 'new' ) {
1923 if ( $this->sectiontitle
!== '' ) {
1924 // Insert the section title above the content.
1925 $content = $content->addSectionHeader( $this->sectiontitle
);
1926 } elseif ( $this->summary
!== '' ) {
1927 // Insert the section title above the content.
1928 $content = $content->addSectionHeader( $this->summary
);
1930 $this->summary
= $this->newSectionSummary( $result['sectionanchor'] );
1933 $status->value
= self
::AS_SUCCESS_NEW_ARTICLE
;
1937 # Article exists. Check for edit conflict.
1939 $this->page
->clear(); # Force reload of dates, etc.
1940 $timestamp = $this->page
->getTimestamp();
1941 $latest = $this->page
->getLatest();
1943 wfDebug( "timestamp: {$timestamp}, edittime: {$this->edittime}\n" );
1945 // Check editRevId if set, which handles same-second timestamp collisions
1946 if ( $timestamp != $this->edittime
1947 ||
( $this->editRevId
!== null && $this->editRevId
!= $latest )
1949 $this->isConflict
= true;
1950 if ( $this->section
== 'new' ) {
1951 if ( $this->page
->getUserText() == $wgUser->getName() &&
1952 $this->page
->getComment() == $this->newSectionSummary()
1954 // Probably a duplicate submission of a new comment.
1955 // This can happen when CDN resends a request after
1956 // a timeout but the first one actually went through.
1958 . ": duplicate new section submission; trigger edit conflict!\n" );
1960 // New comment; suppress conflict.
1961 $this->isConflict
= false;
1962 wfDebug( __METHOD__
. ": conflict suppressed; new section\n" );
1964 } elseif ( $this->section
== ''
1965 && Revision
::userWasLastToEdit(
1966 DB_MASTER
, $this->mTitle
->getArticleID(),
1967 $wgUser->getId(), $this->edittime
1970 # Suppress edit conflict with self, except for section edits where merging is required.
1971 wfDebug( __METHOD__
. ": Suppressing edit conflict, same user.\n" );
1972 $this->isConflict
= false;
1976 // If sectiontitle is set, use it, otherwise use the summary as the section title.
1977 if ( $this->sectiontitle
!== '' ) {
1978 $sectionTitle = $this->sectiontitle
;
1980 $sectionTitle = $this->summary
;
1985 if ( $this->isConflict
) {
1987 . ": conflict! getting section '{$this->section}' for time '{$this->edittime}'"
1988 . " (id '{$this->editRevId}') (article time '{$timestamp}')\n" );
1989 // @TODO: replaceSectionAtRev() with base ID (not prior current) for ?oldid=X case
1990 // ...or disable section editing for non-current revisions (not exposed anyway).
1991 if ( $this->editRevId
!== null ) {
1992 $content = $this->page
->replaceSectionAtRev(
1999 $content = $this->page
->replaceSectionContent(
2007 wfDebug( __METHOD__
. ": getting section '{$this->section}'\n" );
2008 $content = $this->page
->replaceSectionContent(
2015 if ( is_null( $content ) ) {
2016 wfDebug( __METHOD__
. ": activating conflict; section replace failed.\n" );
2017 $this->isConflict
= true;
2018 $content = $textbox_content; // do not try to merge here!
2019 } elseif ( $this->isConflict
) {
2021 if ( $this->mergeChangesIntoContent( $content ) ) {
2022 // Successful merge! Maybe we should tell the user the good news?
2023 $this->isConflict
= false;
2024 wfDebug( __METHOD__
. ": Suppressing edit conflict, successful merge.\n" );
2026 $this->section
= '';
2027 $this->textbox1
= ContentHandler
::getContentText( $content );
2028 wfDebug( __METHOD__
. ": Keeping edit conflict, failed merge.\n" );
2032 if ( $this->isConflict
) {
2033 $status->setResult( false, self
::AS_CONFLICT_DETECTED
);
2037 if ( !$this->runPostMergeFilters( $content, $status, $wgUser ) ) {
2041 if ( $this->section
== 'new' ) {
2042 // Handle the user preference to force summaries here
2043 if ( !$this->allowBlankSummary
&& trim( $this->summary
) == '' ) {
2044 $this->missingSummary
= true;
2045 $status->fatal( 'missingsummary' ); // or 'missingcommentheader' if $section == 'new'. Blegh
2046 $status->value
= self
::AS_SUMMARY_NEEDED
;
2050 // Do not allow the user to post an empty comment
2051 if ( $this->textbox1
== '' ) {
2052 $this->missingComment
= true;
2053 $status->fatal( 'missingcommenttext' );
2054 $status->value
= self
::AS_TEXTBOX_EMPTY
;
2057 } elseif ( !$this->allowBlankSummary
2058 && !$content->equals( $this->getOriginalContent( $wgUser ) )
2059 && !$content->isRedirect()
2060 && md5( $this->summary
) == $this->autoSumm
2062 $this->missingSummary
= true;
2063 $status->fatal( 'missingsummary' );
2064 $status->value
= self
::AS_SUMMARY_NEEDED
;
2069 $sectionanchor = '';
2070 if ( $this->section
== 'new' ) {
2071 $this->summary
= $this->newSectionSummary( $sectionanchor );
2072 } elseif ( $this->section
!= '' ) {
2073 # Try to get a section anchor from the section source, redirect
2074 # to edited section if header found.
2075 # XXX: Might be better to integrate this into Article::replaceSectionAtRev
2076 # for duplicate heading checking and maybe parsing.
2077 $hasmatch = preg_match( "/^ *([=]{1,6})(.*?)(\\1) *\\n/i", $this->textbox1
, $matches );
2078 # We can't deal with anchors, includes, html etc in the header for now,
2079 # headline would need to be parsed to improve this.
2080 if ( $hasmatch && strlen( $matches[2] ) > 0 ) {
2081 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $matches[2] );
2084 $result['sectionanchor'] = $sectionanchor;
2086 // Save errors may fall down to the edit form, but we've now
2087 // merged the section into full text. Clear the section field
2088 // so that later submission of conflict forms won't try to
2089 // replace that into a duplicated mess.
2090 $this->textbox1
= $this->toEditText( $content );
2091 $this->section
= '';
2093 $status->value
= self
::AS_SUCCESS_UPDATE
;
2096 if ( !$this->allowSelfRedirect
2097 && $content->isRedirect()
2098 && $content->getRedirectTarget()->equals( $this->getTitle() )
2100 // If the page already redirects to itself, don't warn.
2101 $currentTarget = $this->getCurrentContent()->getRedirectTarget();
2102 if ( !$currentTarget ||
!$currentTarget->equals( $this->getTitle() ) ) {
2103 $this->selfRedirect
= true;
2104 $status->fatal( 'selfredirect' );
2105 $status->value
= self
::AS_SELF_REDIRECT
;
2110 // Check for length errors again now that the section is merged in
2111 $this->contentLength
= strlen( $this->toEditText( $content ) );
2112 if ( $this->contentLength
> $wgMaxArticleSize * 1024 ) {
2113 $this->tooBig
= true;
2114 $status->setResult( false, self
::AS_MAX_ARTICLE_SIZE_EXCEEDED
);
2118 $flags = EDIT_AUTOSUMMARY |
2119 ( $new ? EDIT_NEW
: EDIT_UPDATE
) |
2120 ( ( $this->minoredit
&& !$this->isNew
) ? EDIT_MINOR
: 0 ) |
2121 ( $bot ? EDIT_FORCE_BOT
: 0 );
2123 $doEditStatus = $this->page
->doEditContent(
2129 $content->getDefaultFormat(),
2133 if ( !$doEditStatus->isOK() ) {
2134 // Failure from doEdit()
2135 // Show the edit conflict page for certain recognized errors from doEdit(),
2136 // but don't show it for errors from extension hooks
2137 $errors = $doEditStatus->getErrorsArray();
2138 if ( in_array( $errors[0][0],
2139 [ 'edit-gone-missing', 'edit-conflict', 'edit-already-exists' ] )
2141 $this->isConflict
= true;
2142 // Destroys data doEdit() put in $status->value but who cares
2143 $doEditStatus->value
= self
::AS_END
;
2145 return $doEditStatus;
2148 $result['nullEdit'] = $doEditStatus->hasMessage( 'edit-no-change' );
2149 if ( $result['nullEdit'] ) {
2150 // We don't know if it was a null edit until now, so increment here
2151 $wgUser->pingLimiter( 'linkpurge' );
2153 $result['redirect'] = $content->isRedirect();
2155 $this->updateWatchlist();
2157 // If the content model changed, add a log entry
2158 if ( $changingContentModel ) {
2159 $this->addContentModelChangeLogEntry(
2161 $new ?
false : $oldContentModel,
2162 $this->contentModel
,
2172 * @param string|false $oldModel false if the page is being newly created
2173 * @param string $newModel
2174 * @param string $reason
2176 protected function addContentModelChangeLogEntry( User
$user, $oldModel, $newModel, $reason ) {
2177 $new = $oldModel === false;
2178 $log = new ManualLogEntry( 'contentmodel', $new ?
'new' : 'change' );
2179 $log->setPerformer( $user );
2180 $log->setTarget( $this->mTitle
);
2181 $log->setComment( $reason );
2182 $log->setParameters( [
2183 '4::oldmodel' => $oldModel,
2184 '5::newmodel' => $newModel
2186 $logid = $log->insert();
2187 $log->publish( $logid );
2191 * Register the change of watch status
2193 protected function updateWatchlist() {
2196 if ( !$wgUser->isLoggedIn() ) {
2201 $title = $this->mTitle
;
2202 $watch = $this->watchthis
;
2203 // Do this in its own transaction to reduce contention...
2204 DeferredUpdates
::addCallableUpdate( function () use ( $user, $title, $watch ) {
2205 if ( $watch == $user->isWatched( $title, User
::IGNORE_USER_RIGHTS
) ) {
2206 return; // nothing to change
2208 WatchAction
::doWatchOrUnwatch( $watch, $title, $user );
2213 * Attempts to do 3-way merge of edit content with a base revision
2214 * and current content, in case of edit conflict, in whichever way appropriate
2215 * for the content type.
2219 * @param Content $editContent
2223 private function mergeChangesIntoContent( &$editContent ) {
2225 $db = wfGetDB( DB_MASTER
);
2227 // This is the revision the editor started from
2228 $baseRevision = $this->getBaseRevision();
2229 $baseContent = $baseRevision ?
$baseRevision->getContent() : null;
2231 if ( is_null( $baseContent ) ) {
2235 // The current state, we want to merge updates into it
2236 $currentRevision = Revision
::loadFromTitle( $db, $this->mTitle
);
2237 $currentContent = $currentRevision ?
$currentRevision->getContent() : null;
2239 if ( is_null( $currentContent ) ) {
2243 $handler = ContentHandler
::getForModelID( $baseContent->getModel() );
2245 $result = $handler->merge3( $baseContent, $editContent, $currentContent );
2248 $editContent = $result;
2249 // Update parentRevId to what we just merged.
2250 $this->parentRevId
= $currentRevision->getId();
2258 * @note: this method is very poorly named. If the user opened the form with ?oldid=X,
2259 * one might think of X as the "base revision", which is NOT what this returns.
2260 * @return Revision Current version when the edit was started
2262 function getBaseRevision() {
2263 if ( !$this->mBaseRevision
) {
2264 $db = wfGetDB( DB_MASTER
);
2265 $this->mBaseRevision
= $this->editRevId
2266 ? Revision
::newFromId( $this->editRevId
, Revision
::READ_LATEST
)
2267 : Revision
::loadFromTimestamp( $db, $this->mTitle
, $this->edittime
);
2269 return $this->mBaseRevision
;
2273 * Check given input text against $wgSpamRegex, and return the text of the first match.
2275 * @param string $text
2277 * @return string|bool Matching string or false
2279 public static function matchSpamRegex( $text ) {
2280 global $wgSpamRegex;
2281 // For back compatibility, $wgSpamRegex may be a single string or an array of regexes.
2282 $regexes = (array)$wgSpamRegex;
2283 return self
::matchSpamRegexInternal( $text, $regexes );
2287 * Check given input text against $wgSummarySpamRegex, and return the text of the first match.
2289 * @param string $text
2291 * @return string|bool Matching string or false
2293 public static function matchSummarySpamRegex( $text ) {
2294 global $wgSummarySpamRegex;
2295 $regexes = (array)$wgSummarySpamRegex;
2296 return self
::matchSpamRegexInternal( $text, $regexes );
2300 * @param string $text
2301 * @param array $regexes
2302 * @return bool|string
2304 protected static function matchSpamRegexInternal( $text, $regexes ) {
2305 foreach ( $regexes as $regex ) {
2307 if ( preg_match( $regex, $text, $matches ) ) {
2314 function setHeaders() {
2315 global $wgOut, $wgUser, $wgAjaxEditStash;
2317 $wgOut->addModules( 'mediawiki.action.edit' );
2318 $wgOut->addModuleStyles( 'mediawiki.action.edit.styles' );
2320 if ( $wgUser->getOption( 'showtoolbar' ) ) {
2321 // The addition of default buttons is handled by getEditToolbar() which
2322 // has its own dependency on this module. The call here ensures the module
2323 // is loaded in time (it has position "top") for other modules to register
2324 // buttons (e.g. extensions, gadgets, user scripts).
2325 $wgOut->addModules( 'mediawiki.toolbar' );
2328 if ( $wgUser->getOption( 'uselivepreview' ) ) {
2329 $wgOut->addModules( 'mediawiki.action.edit.preview' );
2332 if ( $wgUser->getOption( 'useeditwarning' ) ) {
2333 $wgOut->addModules( 'mediawiki.action.edit.editWarning' );
2336 # Enabled article-related sidebar, toplinks, etc.
2337 $wgOut->setArticleRelated( true );
2339 $contextTitle = $this->getContextTitle();
2340 if ( $this->isConflict
) {
2341 $msg = 'editconflict';
2342 } elseif ( $contextTitle->exists() && $this->section
!= '' ) {
2343 $msg = $this->section
== 'new' ?
'editingcomment' : 'editingsection';
2345 $msg = $contextTitle->exists()
2346 ||
( $contextTitle->getNamespace() == NS_MEDIAWIKI
2347 && $contextTitle->getDefaultMessageText() !== false
2353 # Use the title defined by DISPLAYTITLE magic word when present
2354 # NOTE: getDisplayTitle() returns HTML while getPrefixedText() returns plain text.
2355 # setPageTitle() treats the input as wikitext, which should be safe in either case.
2356 $displayTitle = isset( $this->mParserOutput
) ?
$this->mParserOutput
->getDisplayTitle() : false;
2357 if ( $displayTitle === false ) {
2358 $displayTitle = $contextTitle->getPrefixedText();
2360 $wgOut->setPageTitle( wfMessage( $msg, $displayTitle ) );
2361 # Transmit the name of the message to JavaScript for live preview
2362 # Keep Resources.php/mediawiki.action.edit.preview in sync with the possible keys
2363 $wgOut->addJsConfigVars( [
2364 'wgEditMessage' => $msg,
2365 'wgAjaxEditStash' => $wgAjaxEditStash,
2370 * Show all applicable editing introductions
2372 protected function showIntro() {
2373 global $wgOut, $wgUser;
2374 if ( $this->suppressIntro
) {
2378 $namespace = $this->mTitle
->getNamespace();
2380 if ( $namespace == NS_MEDIAWIKI
) {
2381 # Show a warning if editing an interface message
2382 $wgOut->wrapWikiMsg( "<div class='mw-editinginterface'>\n$1\n</div>", 'editinginterface' );
2383 # If this is a default message (but not css or js),
2384 # show a hint that it is translatable on translatewiki.net
2385 if ( !$this->mTitle
->hasContentModel( CONTENT_MODEL_CSS
)
2386 && !$this->mTitle
->hasContentModel( CONTENT_MODEL_JAVASCRIPT
)
2388 $defaultMessageText = $this->mTitle
->getDefaultMessageText();
2389 if ( $defaultMessageText !== false ) {
2390 $wgOut->wrapWikiMsg( "<div class='mw-translateinterface'>\n$1\n</div>",
2391 'translateinterface' );
2394 } elseif ( $namespace == NS_FILE
) {
2395 # Show a hint to shared repo
2396 $file = wfFindFile( $this->mTitle
);
2397 if ( $file && !$file->isLocal() ) {
2398 $descUrl = $file->getDescriptionUrl();
2399 # there must be a description url to show a hint to shared repo
2401 if ( !$this->mTitle
->exists() ) {
2402 $wgOut->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-create\">\n$1\n</div>", [
2403 'sharedupload-desc-create', $file->getRepo()->getDisplayName(), $descUrl
2406 $wgOut->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-edit\">\n$1\n</div>", [
2407 'sharedupload-desc-edit', $file->getRepo()->getDisplayName(), $descUrl
2414 # Show a warning message when someone creates/edits a user (talk) page but the user does not exist
2415 # Show log extract when the user is currently blocked
2416 if ( $namespace == NS_USER ||
$namespace == NS_USER_TALK
) {
2417 $username = explode( '/', $this->mTitle
->getText(), 2 )[0];
2418 $user = User
::newFromName( $username, false /* allow IP users*/ );
2419 $ip = User
::isIP( $username );
2420 $block = Block
::newFromTarget( $user, $user );
2421 if ( !( $user && $user->isLoggedIn() ) && !$ip ) { # User does not exist
2422 $wgOut->wrapWikiMsg( "<div class=\"mw-userpage-userdoesnotexist error\">\n$1\n</div>",
2423 [ 'userpage-userdoesnotexist', wfEscapeWikiText( $username ) ] );
2424 } elseif ( !is_null( $block ) && $block->getType() != Block
::TYPE_AUTO
) {
2425 # Show log extract if the user is currently blocked
2426 LogEventsList
::showLogExtract(
2429 MWNamespace
::getCanonicalName( NS_USER
) . ':' . $block->getTarget(),
2433 'showIfEmpty' => false,
2435 'blocked-notice-logextract',
2436 $user->getName() # Support GENDER in notice
2442 # Try to add a custom edit intro, or use the standard one if this is not possible.
2443 if ( !$this->showCustomIntro() && !$this->mTitle
->exists() ) {
2444 $helpLink = wfExpandUrl( Skin
::makeInternalOrExternalUrl(
2445 wfMessage( 'helppage' )->inContentLanguage()->text()
2447 if ( $wgUser->isLoggedIn() ) {
2448 $wgOut->wrapWikiMsg(
2449 // Suppress the external link icon, consider the help url an internal one
2450 "<div class=\"mw-newarticletext plainlinks\">\n$1\n</div>",
2457 $wgOut->wrapWikiMsg(
2458 // Suppress the external link icon, consider the help url an internal one
2459 "<div class=\"mw-newarticletextanon plainlinks\">\n$1\n</div>",
2461 'newarticletextanon',
2467 # Give a notice if the user is editing a deleted/moved page...
2468 if ( !$this->mTitle
->exists() ) {
2469 LogEventsList
::showLogExtract( $wgOut, [ 'delete', 'move' ], $this->mTitle
,
2473 'conds' => [ "log_action != 'revision'" ],
2474 'showIfEmpty' => false,
2475 'msgKey' => [ 'recreate-moveddeleted-warn' ]
2482 * Attempt to show a custom editing introduction, if supplied
2486 protected function showCustomIntro() {
2487 if ( $this->editintro
) {
2488 $title = Title
::newFromText( $this->editintro
);
2489 if ( $title instanceof Title
&& $title->exists() && $title->userCan( 'read' ) ) {
2491 // Added using template syntax, to take <noinclude>'s into account.
2492 $wgOut->addWikiTextTitleTidy(
2493 '<div class="mw-editintro">{{:' . $title->getFullText() . '}}</div>',
2503 * Gets an editable textual representation of $content.
2504 * The textual representation can be turned by into a Content object by the
2505 * toEditContent() method.
2507 * If $content is null or false or a string, $content is returned unchanged.
2509 * If the given Content object is not of a type that can be edited using
2510 * the text base EditPage, an exception will be raised. Set
2511 * $this->allowNonTextContent to true to allow editing of non-textual
2514 * @param Content|null|bool|string $content
2515 * @return string The editable text form of the content.
2517 * @throws MWException If $content is not an instance of TextContent and
2518 * $this->allowNonTextContent is not true.
2520 protected function toEditText( $content ) {
2521 if ( $content === null ||
$content === false ||
is_string( $content ) ) {
2525 if ( !$this->isSupportedContentModel( $content->getModel() ) ) {
2526 throw new MWException( 'This content model is not supported: ' . $content->getModel() );
2529 return $content->serialize( $this->contentFormat
);
2533 * Turns the given text into a Content object by unserializing it.
2535 * If the resulting Content object is not of a type that can be edited using
2536 * the text base EditPage, an exception will be raised. Set
2537 * $this->allowNonTextContent to true to allow editing of non-textual
2540 * @param string|null|bool $text Text to unserialize
2541 * @return Content|bool|null The content object created from $text. If $text was false
2542 * or null, false resp. null will be returned instead.
2544 * @throws MWException If unserializing the text results in a Content
2545 * object that is not an instance of TextContent and
2546 * $this->allowNonTextContent is not true.
2548 protected function toEditContent( $text ) {
2549 if ( $text === false ||
$text === null ) {
2553 $content = ContentHandler
::makeContent( $text, $this->getTitle(),
2554 $this->contentModel
, $this->contentFormat
);
2556 if ( !$this->isSupportedContentModel( $content->getModel() ) ) {
2557 throw new MWException( 'This content model is not supported: ' . $content->getModel() );
2564 * Send the edit form and related headers to $wgOut
2565 * @param callable|null $formCallback That takes an OutputPage parameter; will be called
2566 * during form output near the top, for captchas and the like.
2568 * The $formCallback parameter is deprecated since MediaWiki 1.25. Please
2569 * use the EditPage::showEditForm:fields hook instead.
2571 function showEditForm( $formCallback = null ) {
2572 global $wgOut, $wgUser;
2574 # need to parse the preview early so that we know which templates are used,
2575 # otherwise users with "show preview after edit box" will get a blank list
2576 # we parse this near the beginning so that setHeaders can do the title
2577 # setting work instead of leaving it in getPreviewText
2578 $previewOutput = '';
2579 if ( $this->formtype
== 'preview' ) {
2580 $previewOutput = $this->getPreviewText();
2583 Hooks
::run( 'EditPage::showEditForm:initial', [ &$this, &$wgOut ] );
2585 $this->setHeaders();
2587 if ( $this->showHeader() === false ) {
2591 $wgOut->addHTML( $this->editFormPageTop
);
2593 if ( $wgUser->getOption( 'previewontop' ) ) {
2594 $this->displayPreviewArea( $previewOutput, true );
2597 $wgOut->addHTML( $this->editFormTextTop
);
2599 $showToolbar = true;
2600 if ( $this->wasDeletedSinceLastEdit() ) {
2601 if ( $this->formtype
== 'save' ) {
2602 // Hide the toolbar and edit area, user can click preview to get it back
2603 // Add an confirmation checkbox and explanation.
2604 $showToolbar = false;
2606 $wgOut->wrapWikiMsg( "<div class='error mw-deleted-while-editing'>\n$1\n</div>",
2607 'deletedwhileediting' );
2611 // @todo add EditForm plugin interface and use it here!
2612 // search for textarea1 and textares2, and allow EditForm to override all uses.
2613 $wgOut->addHTML( Html
::openElement(
2616 'id' => self
::EDITFORM_ID
,
2617 'name' => self
::EDITFORM_ID
,
2619 'action' => $this->getActionURL( $this->getContextTitle() ),
2620 'enctype' => 'multipart/form-data'
2624 if ( is_callable( $formCallback ) ) {
2625 wfWarn( 'The $formCallback parameter to ' . __METHOD__
. 'is deprecated' );
2626 call_user_func_array( $formCallback, [ &$wgOut ] );
2629 // Add an empty field to trip up spambots
2631 Xml
::openElement( 'div', [ 'id' => 'antispam-container', 'style' => 'display: none;' ] )
2634 [ 'for' => 'wpAntispam' ],
2635 wfMessage( 'simpleantispam-label' )->parse()
2641 'name' => 'wpAntispam',
2642 'id' => 'wpAntispam',
2646 . Xml
::closeElement( 'div' )
2649 Hooks
::run( 'EditPage::showEditForm:fields', [ &$this, &$wgOut ] );
2651 // Put these up at the top to ensure they aren't lost on early form submission
2652 $this->showFormBeforeText();
2654 if ( $this->wasDeletedSinceLastEdit() && 'save' == $this->formtype
) {
2655 $username = $this->lastDelete
->user_name
;
2656 $comment = $this->lastDelete
->log_comment
;
2658 // It is better to not parse the comment at all than to have templates expanded in the middle
2659 // TODO: can the checkLabel be moved outside of the div so that wrapWikiMsg could be used?
2660 $key = $comment === ''
2661 ?
'confirmrecreate-noreason'
2662 : 'confirmrecreate';
2664 '<div class="mw-confirm-recreate">' .
2665 wfMessage( $key, $username, "<nowiki>$comment</nowiki>" )->parse() .
2666 Xml
::checkLabel( wfMessage( 'recreate' )->text(), 'wpRecreate', 'wpRecreate', false,
2667 [ 'title' => Linker
::titleAttrib( 'recreate' ), 'tabindex' => 1, 'id' => 'wpRecreate' ]
2673 # When the summary is hidden, also hide them on preview/show changes
2674 if ( $this->nosummary
) {
2675 $wgOut->addHTML( Html
::hidden( 'nosummary', true ) );
2678 # If a blank edit summary was previously provided, and the appropriate
2679 # user preference is active, pass a hidden tag as wpIgnoreBlankSummary. This will stop the
2680 # user being bounced back more than once in the event that a summary
2683 # For a bit more sophisticated detection of blank summaries, hash the
2684 # automatic one and pass that in the hidden field wpAutoSummary.
2685 if ( $this->missingSummary ||
( $this->section
== 'new' && $this->nosummary
) ) {
2686 $wgOut->addHTML( Html
::hidden( 'wpIgnoreBlankSummary', true ) );
2689 if ( $this->undidRev
) {
2690 $wgOut->addHTML( Html
::hidden( 'wpUndidRevision', $this->undidRev
) );
2693 if ( $this->selfRedirect
) {
2694 $wgOut->addHTML( Html
::hidden( 'wpIgnoreSelfRedirect', true ) );
2697 if ( $this->hasPresetSummary
) {
2698 // If a summary has been preset using &summary= we don't want to prompt for
2699 // a different summary. Only prompt for a summary if the summary is blanked.
2701 $this->autoSumm
= md5( '' );
2704 $autosumm = $this->autoSumm ?
$this->autoSumm
: md5( $this->summary
);
2705 $wgOut->addHTML( Html
::hidden( 'wpAutoSummary', $autosumm ) );
2707 $wgOut->addHTML( Html
::hidden( 'oldid', $this->oldid
) );
2708 $wgOut->addHTML( Html
::hidden( 'parentRevId', $this->getParentRevId() ) );
2710 $wgOut->addHTML( Html
::hidden( 'format', $this->contentFormat
) );
2711 $wgOut->addHTML( Html
::hidden( 'model', $this->contentModel
) );
2713 if ( $this->section
== 'new' ) {
2714 $this->showSummaryInput( true, $this->summary
);
2715 $wgOut->addHTML( $this->getSummaryPreview( true, $this->summary
) );
2718 $wgOut->addHTML( $this->editFormTextBeforeContent
);
2720 if ( !$this->isCssJsSubpage
&& $showToolbar && $wgUser->getOption( 'showtoolbar' ) ) {
2721 $wgOut->addHTML( EditPage
::getEditToolbar( $this->mTitle
) );
2724 if ( $this->blankArticle
) {
2725 $wgOut->addHTML( Html
::hidden( 'wpIgnoreBlankArticle', true ) );
2728 if ( $this->isConflict
) {
2729 // In an edit conflict bypass the overridable content form method
2730 // and fallback to the raw wpTextbox1 since editconflicts can't be
2731 // resolved between page source edits and custom ui edits using the
2733 $this->textbox2
= $this->textbox1
;
2735 $content = $this->getCurrentContent();
2736 $this->textbox1
= $this->toEditText( $content );
2738 $this->showTextbox1();
2740 $this->showContentForm();
2743 $wgOut->addHTML( $this->editFormTextAfterContent
);
2745 $this->showStandardInputs();
2747 $this->showFormAfterText();
2749 $this->showTosSummary();
2751 $this->showEditTools();
2753 $wgOut->addHTML( $this->editFormTextAfterTools
. "\n" );
2755 $wgOut->addHTML( $this->makeTemplatesOnThisPageList( $this->getTemplates() ) );
2757 $wgOut->addHTML( Html
::rawElement( 'div', [ 'class' => 'hiddencats' ],
2758 Linker
::formatHiddenCategories( $this->page
->getHiddenCategories() ) ) );
2760 if ( $this->mParserOutput
) {
2761 $wgOut->setLimitReportData( $this->mParserOutput
->getLimitReportData() );
2764 $wgOut->addModules( 'mediawiki.action.edit.collapsibleFooter' );
2766 if ( $this->isConflict
) {
2768 $this->showConflict();
2769 } catch ( MWContentSerializationException
$ex ) {
2770 // this can't really happen, but be nice if it does.
2772 'content-failed-to-parse',
2773 $this->contentModel
,
2774 $this->contentFormat
,
2777 $wgOut->addWikiText( '<div class="error">' . $msg->text() . '</div>' );
2781 // Set a hidden field so JS knows what edit form mode we are in
2782 if ( $this->isConflict
) {
2784 } elseif ( $this->preview
) {
2786 } elseif ( $this->diff
) {
2791 $wgOut->addHTML( Html
::hidden( 'mode', $mode, [ 'id' => 'mw-edit-mode' ] ) );
2793 // Marker for detecting truncated form data. This must be the last
2794 // parameter sent in order to be of use, so do not move me.
2795 $wgOut->addHTML( Html
::hidden( 'wpUltimateParam', true ) );
2796 $wgOut->addHTML( $this->editFormTextBottom
. "\n</form>\n" );
2798 if ( !$wgUser->getOption( 'previewontop' ) ) {
2799 $this->displayPreviewArea( $previewOutput, false );
2805 * Wrapper around TemplatesOnThisPageFormatter to make
2806 * a "templates on this page" list.
2808 * @param Title[] $templates
2809 * @return string HTML
2811 protected function makeTemplatesOnThisPageList( array $templates ) {
2812 $templateListFormatter = new TemplatesOnThisPageFormatter(
2813 $this->context
, MediaWikiServices
::getInstance()->getLinkRenderer()
2816 // preview if preview, else section if section, else false
2818 if ( $this->preview
) {
2820 } elseif ( $this->section
!= '' ) {
2824 return Html
::rawElement( 'div', [ 'class' => 'templatesUsed' ],
2825 $templateListFormatter->format( $templates, $type )
2831 * Extract the section title from current section text, if any.
2833 * @param string $text
2834 * @return string|bool String or false
2836 public static function extractSectionTitle( $text ) {
2837 preg_match( "/^(=+)(.+)\\1\\s*(\n|$)/i", $text, $matches );
2838 if ( !empty( $matches[2] ) ) {
2840 return $wgParser->stripSectionName( trim( $matches[2] ) );
2849 protected function showHeader() {
2850 global $wgOut, $wgUser, $wgMaxArticleSize, $wgLang;
2851 global $wgAllowUserCss, $wgAllowUserJs;
2853 if ( $this->mTitle
->isTalkPage() ) {
2854 $wgOut->addWikiMsg( 'talkpagetext' );
2858 $editNotices = $this->mTitle
->getEditNotices( $this->oldid
);
2859 if ( count( $editNotices ) ) {
2860 $wgOut->addHTML( implode( "\n", $editNotices ) );
2862 $msg = wfMessage( 'editnotice-notext' );
2863 if ( !$msg->isDisabled() ) {
2865 '<div class="mw-editnotice-notext">'
2866 . $msg->parseAsBlock()
2872 if ( $this->isConflict
) {
2873 $wgOut->wrapWikiMsg( "<div class='mw-explainconflict'>\n$1\n</div>", 'explainconflict' );
2874 $this->editRevId
= $this->page
->getLatest();
2876 if ( $this->section
!= '' && !$this->isSectionEditSupported() ) {
2877 // We use $this->section to much before this and getVal('wgSection') directly in other places
2878 // at this point we can't reset $this->section to '' to fallback to non-section editing.
2879 // Someone is welcome to try refactoring though
2880 $wgOut->showErrorPage( 'sectioneditnotsupported-title', 'sectioneditnotsupported-text' );
2884 if ( $this->section
!= '' && $this->section
!= 'new' ) {
2885 if ( !$this->summary
&& !$this->preview
&& !$this->diff
) {
2886 $sectionTitle = self
::extractSectionTitle( $this->textbox1
); // FIXME: use Content object
2887 if ( $sectionTitle !== false ) {
2888 $this->summary
= "/* $sectionTitle */ ";
2893 if ( $this->missingComment
) {
2894 $wgOut->wrapWikiMsg( "<div id='mw-missingcommenttext'>\n$1\n</div>", 'missingcommenttext' );
2897 if ( $this->missingSummary
&& $this->section
!= 'new' ) {
2898 $wgOut->wrapWikiMsg( "<div id='mw-missingsummary'>\n$1\n</div>", 'missingsummary' );
2901 if ( $this->missingSummary
&& $this->section
== 'new' ) {
2902 $wgOut->wrapWikiMsg( "<div id='mw-missingcommentheader'>\n$1\n</div>", 'missingcommentheader' );
2905 if ( $this->blankArticle
) {
2906 $wgOut->wrapWikiMsg( "<div id='mw-blankarticle'>\n$1\n</div>", 'blankarticle' );
2909 if ( $this->selfRedirect
) {
2910 $wgOut->wrapWikiMsg( "<div id='mw-selfredirect'>\n$1\n</div>", 'selfredirect' );
2913 if ( $this->hookError
!== '' ) {
2914 $wgOut->addWikiText( $this->hookError
);
2917 if ( !$this->checkUnicodeCompliantBrowser() ) {
2918 $wgOut->addWikiMsg( 'nonunicodebrowser' );
2921 if ( $this->section
!= 'new' ) {
2922 $revision = $this->mArticle
->getRevisionFetched();
2924 // Let sysop know that this will make private content public if saved
2926 if ( !$revision->userCan( Revision
::DELETED_TEXT
, $wgUser ) ) {
2927 $wgOut->wrapWikiMsg(
2928 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
2929 'rev-deleted-text-permission'
2931 } elseif ( $revision->isDeleted( Revision
::DELETED_TEXT
) ) {
2932 $wgOut->wrapWikiMsg(
2933 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
2934 'rev-deleted-text-view'
2938 if ( !$revision->isCurrent() ) {
2939 $this->mArticle
->setOldSubtitle( $revision->getId() );
2940 $wgOut->addWikiMsg( 'editingold' );
2942 } elseif ( $this->mTitle
->exists() ) {
2943 // Something went wrong
2945 $wgOut->wrapWikiMsg( "<div class='errorbox'>\n$1\n</div>\n",
2946 [ 'missing-revision', $this->oldid
] );
2951 if ( wfReadOnly() ) {
2952 $wgOut->wrapWikiMsg(
2953 "<div id=\"mw-read-only-warning\">\n$1\n</div>",
2954 [ 'readonlywarning', wfReadOnlyReason() ]
2956 } elseif ( $wgUser->isAnon() ) {
2957 if ( $this->formtype
!= 'preview' ) {
2958 $wgOut->wrapWikiMsg(
2959 "<div id='mw-anon-edit-warning' class='warningbox'>\n$1\n</div>",
2960 [ 'anoneditwarning',
2962 SpecialPage
::getTitleFor( 'Userlogin' )->getFullURL( [
2963 'returnto' => $this->getTitle()->getPrefixedDBkey()
2966 SpecialPage
::getTitleFor( 'CreateAccount' )->getFullURL( [
2967 'returnto' => $this->getTitle()->getPrefixedDBkey()
2972 $wgOut->wrapWikiMsg( "<div id=\"mw-anon-preview-warning\" class=\"warningbox\">\n$1</div>",
2973 'anonpreviewwarning'
2977 if ( $this->isCssJsSubpage
) {
2978 # Check the skin exists
2979 if ( $this->isWrongCaseCssJsPage
) {
2980 $wgOut->wrapWikiMsg(
2981 "<div class='error' id='mw-userinvalidcssjstitle'>\n$1\n</div>",
2982 [ 'userinvalidcssjstitle', $this->mTitle
->getSkinFromCssJsSubpage() ]
2985 if ( $this->getTitle()->isSubpageOf( $wgUser->getUserPage() ) ) {
2986 $wgOut->wrapWikiMsg( '<div class="mw-usercssjspublic">$1</div>',
2987 $this->isCssSubpage ?
'usercssispublic' : 'userjsispublic'
2989 if ( $this->formtype
!== 'preview' ) {
2990 if ( $this->isCssSubpage
&& $wgAllowUserCss ) {
2991 $wgOut->wrapWikiMsg(
2992 "<div id='mw-usercssyoucanpreview'>\n$1\n</div>",
2993 [ 'usercssyoucanpreview' ]
2997 if ( $this->isJsSubpage
&& $wgAllowUserJs ) {
2998 $wgOut->wrapWikiMsg(
2999 "<div id='mw-userjsyoucanpreview'>\n$1\n</div>",
3000 [ 'userjsyoucanpreview' ]
3008 if ( $this->mTitle
->isProtected( 'edit' ) &&
3009 MWNamespace
::getRestrictionLevels( $this->mTitle
->getNamespace() ) !== [ '' ]
3011 # Is the title semi-protected?
3012 if ( $this->mTitle
->isSemiProtected() ) {
3013 $noticeMsg = 'semiprotectedpagewarning';
3015 # Then it must be protected based on static groups (regular)
3016 $noticeMsg = 'protectedpagewarning';
3018 LogEventsList
::showLogExtract( $wgOut, 'protect', $this->mTitle
, '',
3019 [ 'lim' => 1, 'msgKey' => [ $noticeMsg ] ] );
3021 if ( $this->mTitle
->isCascadeProtected() ) {
3022 # Is this page under cascading protection from some source pages?
3023 /** @var Title[] $cascadeSources */
3024 list( $cascadeSources, /* $restrictions */ ) = $this->mTitle
->getCascadeProtectionSources();
3025 $notice = "<div class='mw-cascadeprotectedwarning'>\n$1\n";
3026 $cascadeSourcesCount = count( $cascadeSources );
3027 if ( $cascadeSourcesCount > 0 ) {
3028 # Explain, and list the titles responsible
3029 foreach ( $cascadeSources as $page ) {
3030 $notice .= '* [[:' . $page->getPrefixedText() . "]]\n";
3033 $notice .= '</div>';
3034 $wgOut->wrapWikiMsg( $notice, [ 'cascadeprotectedwarning', $cascadeSourcesCount ] );
3036 if ( !$this->mTitle
->exists() && $this->mTitle
->getRestrictions( 'create' ) ) {
3037 LogEventsList
::showLogExtract( $wgOut, 'protect', $this->mTitle
, '',
3039 'showIfEmpty' => false,
3040 'msgKey' => [ 'titleprotectedwarning' ],
3041 'wrap' => "<div class=\"mw-titleprotectedwarning\">\n$1</div>" ] );
3044 if ( $this->contentLength
=== false ) {
3045 $this->contentLength
= strlen( $this->textbox1
);
3048 if ( $this->tooBig ||
$this->contentLength
> $wgMaxArticleSize * 1024 ) {
3049 $wgOut->wrapWikiMsg( "<div class='error' id='mw-edit-longpageerror'>\n$1\n</div>",
3052 $wgLang->formatNum( round( $this->contentLength
/ 1024, 3 ) ),
3053 $wgLang->formatNum( $wgMaxArticleSize )
3057 if ( !wfMessage( 'longpage-hint' )->isDisabled() ) {
3058 $wgOut->wrapWikiMsg( "<div id='mw-edit-longpage-hint'>\n$1\n</div>",
3061 $wgLang->formatSize( strlen( $this->textbox1
) ),
3062 strlen( $this->textbox1
)
3067 # Add header copyright warning
3068 $this->showHeaderCopyrightWarning();
3074 * Standard summary input and label (wgSummary), abstracted so EditPage
3075 * subclasses may reorganize the form.
3076 * Note that you do not need to worry about the label's for=, it will be
3077 * inferred by the id given to the input. You can remove them both by
3078 * passing [ 'id' => false ] to $userInputAttrs.
3080 * @param string $summary The value of the summary input
3081 * @param string $labelText The html to place inside the label
3082 * @param array $inputAttrs Array of attrs to use on the input
3083 * @param array $spanLabelAttrs Array of attrs to use on the span inside the label
3085 * @return array An array in the format [ $label, $input ]
3087 function getSummaryInput( $summary = "", $labelText = null,
3088 $inputAttrs = null, $spanLabelAttrs = null
3090 // Note: the maxlength is overridden in JS to 255 and to make it use UTF-8 bytes, not characters.
3091 $inputAttrs = ( is_array( $inputAttrs ) ?
$inputAttrs : [] ) +
[
3092 'id' => 'wpSummary',
3093 'maxlength' => '200',
3096 'spellcheck' => 'true',
3097 ] + Linker
::tooltipAndAccesskeyAttribs( 'summary' );
3099 $spanLabelAttrs = ( is_array( $spanLabelAttrs ) ?
$spanLabelAttrs : [] ) +
[
3100 'class' => $this->missingSummary ?
'mw-summarymissed' : 'mw-summary',
3101 'id' => "wpSummaryLabel"
3108 $inputAttrs['id'] ?
[ 'for' => $inputAttrs['id'] ] : null,
3111 $label = Xml
::tags( 'span', $spanLabelAttrs, $label );
3114 $input = Html
::input( 'wpSummary', $summary, 'text', $inputAttrs );
3116 return [ $label, $input ];
3120 * @param bool $isSubjectPreview True if this is the section subject/title
3121 * up top, or false if this is the comment summary
3122 * down below the textarea
3123 * @param string $summary The text of the summary to display
3125 protected function showSummaryInput( $isSubjectPreview, $summary = "" ) {
3127 # Add a class if 'missingsummary' is triggered to allow styling of the summary line
3128 $summaryClass = $this->missingSummary ?
'mw-summarymissed' : 'mw-summary';
3129 if ( $isSubjectPreview ) {
3130 if ( $this->nosummary
) {
3134 if ( !$this->mShowSummaryField
) {
3138 $labelText = wfMessage( $isSubjectPreview ?
'subject' : 'summary' )->parse();
3139 list( $label, $input ) = $this->getSummaryInput(
3142 [ 'class' => $summaryClass ],
3145 $wgOut->addHTML( "{$label} {$input}" );
3149 * @param bool $isSubjectPreview True if this is the section subject/title
3150 * up top, or false if this is the comment summary
3151 * down below the textarea
3152 * @param string $summary The text of the summary to display
3155 protected function getSummaryPreview( $isSubjectPreview, $summary = "" ) {
3156 // avoid spaces in preview, gets always trimmed on save
3157 $summary = trim( $summary );
3158 if ( !$summary ||
( !$this->preview
&& !$this->diff
) ) {
3164 if ( $isSubjectPreview ) {
3165 $summary = wfMessage( 'newsectionsummary' )->rawParams( $wgParser->stripSectionName( $summary ) )
3166 ->inContentLanguage()->text();
3169 $message = $isSubjectPreview ?
'subject-preview' : 'summary-preview';
3171 $summary = wfMessage( $message )->parse()
3172 . Linker
::commentBlock( $summary, $this->mTitle
, $isSubjectPreview );
3173 return Xml
::tags( 'div', [ 'class' => 'mw-summary-preview' ], $summary );
3176 protected function showFormBeforeText() {
3178 $section = htmlspecialchars( $this->section
);
3179 $wgOut->addHTML( <<<HTML
3180 <input type='hidden' value="{$section}" name="wpSection"/>
3181 <input type='hidden' value="{$this->starttime}" name="wpStarttime" />
3182 <input type='hidden' value="{$this->edittime}" name="wpEdittime" />
3183 <input type='hidden' value="{$this->editRevId}" name="editRevId" />
3184 <input type='hidden' value="{$this->scrolltop}" name="wpScrolltop" id="wpScrolltop" />
3188 if ( !$this->checkUnicodeCompliantBrowser() ) {
3189 $wgOut->addHTML( Html
::hidden( 'safemode', '1' ) );
3193 protected function showFormAfterText() {
3194 global $wgOut, $wgUser;
3196 * To make it harder for someone to slip a user a page
3197 * which submits an edit form to the wiki without their
3198 * knowledge, a random token is associated with the login
3199 * session. If it's not passed back with the submission,
3200 * we won't save the page, or render user JavaScript and
3203 * For anon editors, who may not have a session, we just
3204 * include the constant suffix to prevent editing from
3205 * broken text-mangling proxies.
3207 $wgOut->addHTML( "\n" . Html
::hidden( "wpEditToken", $wgUser->getEditToken() ) . "\n" );
3211 * Subpage overridable method for printing the form for page content editing
3212 * By default this simply outputs wpTextbox1
3213 * Subclasses can override this to provide a custom UI for editing;
3214 * be it a form, or simply wpTextbox1 with a modified content that will be
3215 * reverse modified when extracted from the post data.
3216 * Note that this is basically the inverse for importContentFormData
3218 protected function showContentForm() {
3219 $this->showTextbox1();
3223 * Method to output wpTextbox1
3224 * The $textoverride method can be used by subclasses overriding showContentForm
3225 * to pass back to this method.
3227 * @param array $customAttribs Array of html attributes to use in the textarea
3228 * @param string $textoverride Optional text to override $this->textarea1 with
3230 protected function showTextbox1( $customAttribs = null, $textoverride = null ) {
3231 if ( $this->wasDeletedSinceLastEdit() && $this->formtype
== 'save' ) {
3232 $attribs = [ 'style' => 'display:none;' ];
3234 $classes = []; // Textarea CSS
3235 if ( $this->mTitle
->isProtected( 'edit' ) &&
3236 MWNamespace
::getRestrictionLevels( $this->mTitle
->getNamespace() ) !== [ '' ]
3238 # Is the title semi-protected?
3239 if ( $this->mTitle
->isSemiProtected() ) {
3240 $classes[] = 'mw-textarea-sprotected';
3242 # Then it must be protected based on static groups (regular)
3243 $classes[] = 'mw-textarea-protected';
3245 # Is the title cascade-protected?
3246 if ( $this->mTitle
->isCascadeProtected() ) {
3247 $classes[] = 'mw-textarea-cprotected';
3251 $attribs = [ 'tabindex' => 1 ];
3253 if ( is_array( $customAttribs ) ) {
3254 $attribs +
= $customAttribs;
3257 if ( count( $classes ) ) {
3258 if ( isset( $attribs['class'] ) ) {
3259 $classes[] = $attribs['class'];
3261 $attribs['class'] = implode( ' ', $classes );
3266 $textoverride !== null ?
$textoverride : $this->textbox1
,
3272 protected function showTextbox2() {
3273 $this->showTextbox( $this->textbox2
, 'wpTextbox2', [ 'tabindex' => 6, 'readonly' ] );
3276 protected function showTextbox( $text, $name, $customAttribs = [] ) {
3277 global $wgOut, $wgUser;
3279 $wikitext = $this->safeUnicodeOutput( $text );
3280 if ( strval( $wikitext ) !== '' ) {
3281 // Ensure there's a newline at the end, otherwise adding lines
3283 // But don't add a newline if the ext is empty, or Firefox in XHTML
3284 // mode will show an extra newline. A bit annoying.
3288 $attribs = $customAttribs +
[
3291 'cols' => $wgUser->getIntOption( 'cols' ),
3292 'rows' => $wgUser->getIntOption( 'rows' ),
3293 // Avoid PHP notices when appending preferences
3294 // (appending allows customAttribs['style'] to still work).
3298 $pageLang = $this->mTitle
->getPageLanguage();
3299 $attribs['lang'] = $pageLang->getHtmlCode();
3300 $attribs['dir'] = $pageLang->getDir();
3302 $wgOut->addHTML( Html
::textarea( $name, $wikitext, $attribs ) );
3305 protected function displayPreviewArea( $previewOutput, $isOnTop = false ) {
3309 $classes[] = 'ontop';
3312 $attribs = [ 'id' => 'wikiPreview', 'class' => implode( ' ', $classes ) ];
3314 if ( $this->formtype
!= 'preview' ) {
3315 $attribs['style'] = 'display: none;';
3318 $wgOut->addHTML( Xml
::openElement( 'div', $attribs ) );
3320 if ( $this->formtype
== 'preview' ) {
3321 $this->showPreview( $previewOutput );
3323 // Empty content container for LivePreview
3324 $pageViewLang = $this->mTitle
->getPageViewLanguage();
3325 $attribs = [ 'lang' => $pageViewLang->getHtmlCode(), 'dir' => $pageViewLang->getDir(),
3326 'class' => 'mw-content-' . $pageViewLang->getDir() ];
3327 $wgOut->addHTML( Html
::rawElement( 'div', $attribs ) );
3330 $wgOut->addHTML( '</div>' );
3332 if ( $this->formtype
== 'diff' ) {
3335 } catch ( MWContentSerializationException
$ex ) {
3337 'content-failed-to-parse',
3338 $this->contentModel
,
3339 $this->contentFormat
,
3342 $wgOut->addWikiText( '<div class="error">' . $msg->text() . '</div>' );
3348 * Append preview output to $wgOut.
3349 * Includes category rendering if this is a category page.
3351 * @param string $text The HTML to be output for the preview.
3353 protected function showPreview( $text ) {
3355 if ( $this->mTitle
->getNamespace() == NS_CATEGORY
) {
3356 $this->mArticle
->openShowCategory();
3358 # This hook seems slightly odd here, but makes things more
3359 # consistent for extensions.
3360 Hooks
::run( 'OutputPageBeforeHTML', [ &$wgOut, &$text ] );
3361 $wgOut->addHTML( $text );
3362 if ( $this->mTitle
->getNamespace() == NS_CATEGORY
) {
3363 $this->mArticle
->closeShowCategory();
3368 * Get a diff between the current contents of the edit box and the
3369 * version of the page we're editing from.
3371 * If this is a section edit, we'll replace the section as for final
3372 * save and then make a comparison.
3374 function showDiff() {
3375 global $wgUser, $wgContLang, $wgOut;
3377 $oldtitlemsg = 'currentrev';
3378 # if message does not exist, show diff against the preloaded default
3379 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
&& !$this->mTitle
->exists() ) {
3380 $oldtext = $this->mTitle
->getDefaultMessageText();
3381 if ( $oldtext !== false ) {
3382 $oldtitlemsg = 'defaultmessagetext';
3383 $oldContent = $this->toEditContent( $oldtext );
3388 $oldContent = $this->getCurrentContent();
3391 $textboxContent = $this->toEditContent( $this->textbox1
);
3392 if ( $this->editRevId
!== null ) {
3393 $newContent = $this->page
->replaceSectionAtRev(
3394 $this->section
, $textboxContent, $this->summary
, $this->editRevId
3397 $newContent = $this->page
->replaceSectionContent(
3398 $this->section
, $textboxContent, $this->summary
, $this->edittime
3402 if ( $newContent ) {
3403 ContentHandler
::runLegacyHooks( 'EditPageGetDiffText', [ $this, &$newContent ] );
3404 Hooks
::run( 'EditPageGetDiffContent', [ $this, &$newContent ] );
3406 $popts = ParserOptions
::newFromUserAndLang( $wgUser, $wgContLang );
3407 $newContent = $newContent->preSaveTransform( $this->mTitle
, $wgUser, $popts );
3410 if ( ( $oldContent && !$oldContent->isEmpty() ) ||
( $newContent && !$newContent->isEmpty() ) ) {
3411 $oldtitle = wfMessage( $oldtitlemsg )->parse();
3412 $newtitle = wfMessage( 'yourtext' )->parse();
3414 if ( !$oldContent ) {
3415 $oldContent = $newContent->getContentHandler()->makeEmptyContent();
3418 if ( !$newContent ) {
3419 $newContent = $oldContent->getContentHandler()->makeEmptyContent();
3422 $de = $oldContent->getContentHandler()->createDifferenceEngine( $this->mArticle
->getContext() );
3423 $de->setContent( $oldContent, $newContent );
3425 $difftext = $de->getDiff( $oldtitle, $newtitle );
3426 $de->showDiffStyle();
3431 $wgOut->addHTML( '<div id="wikiDiff">' . $difftext . '</div>' );
3435 * Show the header copyright warning.
3437 protected function showHeaderCopyrightWarning() {
3438 $msg = 'editpage-head-copy-warn';
3439 if ( !wfMessage( $msg )->isDisabled() ) {
3441 $wgOut->wrapWikiMsg( "<div class='editpage-head-copywarn'>\n$1\n</div>",
3442 'editpage-head-copy-warn' );
3447 * Give a chance for site and per-namespace customizations of
3448 * terms of service summary link that might exist separately
3449 * from the copyright notice.
3451 * This will display between the save button and the edit tools,
3452 * so should remain short!
3454 protected function showTosSummary() {
3455 $msg = 'editpage-tos-summary';
3456 Hooks
::run( 'EditPageTosSummary', [ $this->mTitle
, &$msg ] );
3457 if ( !wfMessage( $msg )->isDisabled() ) {
3459 $wgOut->addHTML( '<div class="mw-tos-summary">' );
3460 $wgOut->addWikiMsg( $msg );
3461 $wgOut->addHTML( '</div>' );
3465 protected function showEditTools() {
3467 $wgOut->addHTML( '<div class="mw-editTools">' .
3468 wfMessage( 'edittools' )->inContentLanguage()->parse() .
3473 * Get the copyright warning
3475 * Renamed to getCopyrightWarning(), old name kept around for backwards compatibility
3478 protected function getCopywarn() {
3479 return self
::getCopyrightWarning( $this->mTitle
);
3483 * Get the copyright warning, by default returns wikitext
3485 * @param Title $title
3486 * @param string $format Output format, valid values are any function of a Message object
3489 public static function getCopyrightWarning( $title, $format = 'plain' ) {
3490 global $wgRightsText;
3491 if ( $wgRightsText ) {
3492 $copywarnMsg = [ 'copyrightwarning',
3493 '[[' . wfMessage( 'copyrightpage' )->inContentLanguage()->text() . ']]',
3496 $copywarnMsg = [ 'copyrightwarning2',
3497 '[[' . wfMessage( 'copyrightpage' )->inContentLanguage()->text() . ']]' ];
3499 // Allow for site and per-namespace customization of contribution/copyright notice.
3500 Hooks
::run( 'EditPageCopyrightWarning', [ $title, &$copywarnMsg ] );
3502 return "<div id=\"editpage-copywarn\">\n" .
3503 call_user_func_array( 'wfMessage', $copywarnMsg )->$format() . "\n</div>";
3507 * Get the Limit report for page previews
3510 * @param ParserOutput $output ParserOutput object from the parse
3511 * @return string HTML
3513 public static function getPreviewLimitReport( $output ) {
3514 if ( !$output ||
!$output->getLimitReportData() ) {
3518 return ResourceLoader
::makeInlineScript(
3519 ResourceLoader
::makeConfigSetScript(
3520 [ 'wgPageParseReport' => $output->getLimitReportData() ],
3526 protected function showStandardInputs( &$tabindex = 2 ) {
3528 $wgOut->addHTML( "<div class='editOptions'>\n" );
3530 if ( $this->section
!= 'new' ) {
3531 $this->showSummaryInput( false, $this->summary
);
3532 $wgOut->addHTML( $this->getSummaryPreview( false, $this->summary
) );
3535 $checkboxes = $this->getCheckboxes( $tabindex,
3536 [ 'minor' => $this->minoredit
, 'watch' => $this->watchthis
] );
3537 $wgOut->addHTML( "<div class='editCheckboxes'>" . implode( $checkboxes, "\n" ) . "</div>\n" );
3539 // Show copyright warning.
3540 $wgOut->addWikiText( $this->getCopywarn() );
3541 $wgOut->addHTML( $this->editFormTextAfterWarn
);
3543 $wgOut->addHTML( "<div class='editButtons'>\n" );
3544 $wgOut->addHTML( implode( $this->getEditButtons( $tabindex ), "\n" ) . "\n" );
3546 $cancel = $this->getCancelLink();
3547 if ( $cancel !== '' ) {
3548 $cancel .= Html
::element( 'span',
3549 [ 'class' => 'mw-editButtons-pipe-separator' ],
3550 wfMessage( 'pipe-separator' )->text() );
3553 $message = wfMessage( 'edithelppage' )->inContentLanguage()->text();
3554 $edithelpurl = Skin
::makeInternalOrExternalUrl( $message );
3556 'target' => 'helpwindow',
3557 'href' => $edithelpurl,
3559 $edithelp = Html
::linkButton( wfMessage( 'edithelp' )->text(),
3560 $attrs, [ 'mw-ui-quiet' ] ) .
3561 wfMessage( 'word-separator' )->escaped() .
3562 wfMessage( 'newwindow' )->parse();
3564 $wgOut->addHTML( " <span class='cancelLink'>{$cancel}</span>\n" );
3565 $wgOut->addHTML( " <span class='editHelp'>{$edithelp}</span>\n" );
3566 $wgOut->addHTML( "</div><!-- editButtons -->\n" );
3568 Hooks
::run( 'EditPage::showStandardInputs:options', [ $this, $wgOut, &$tabindex ] );
3570 $wgOut->addHTML( "</div><!-- editOptions -->\n" );
3574 * Show an edit conflict. textbox1 is already shown in showEditForm().
3575 * If you want to use another entry point to this function, be careful.
3577 protected function showConflict() {
3580 if ( Hooks
::run( 'EditPageBeforeConflictDiff', [ &$this, &$wgOut ] ) ) {
3581 $stats = $wgOut->getContext()->getStats();
3582 $stats->increment( 'edit.failures.conflict' );
3583 // Only include 'standard' namespaces to avoid creating unknown numbers of statsd metrics
3585 $this->mTitle
->getNamespace() >= NS_MAIN
&&
3586 $this->mTitle
->getNamespace() <= NS_CATEGORY_TALK
3588 $stats->increment( 'edit.failures.conflict.byNamespaceId.' . $this->mTitle
->getNamespace() );
3591 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
3593 $content1 = $this->toEditContent( $this->textbox1
);
3594 $content2 = $this->toEditContent( $this->textbox2
);
3596 $handler = ContentHandler
::getForModelID( $this->contentModel
);
3597 $de = $handler->createDifferenceEngine( $this->mArticle
->getContext() );
3598 $de->setContent( $content2, $content1 );
3600 wfMessage( 'yourtext' )->parse(),
3601 wfMessage( 'storedversion' )->text()
3604 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
3605 $this->showTextbox2();
3612 public function getCancelLink() {
3614 if ( !$this->isConflict
&& $this->oldid
> 0 ) {
3615 $cancelParams['oldid'] = $this->oldid
;
3616 } elseif ( $this->getContextTitle()->isRedirect() ) {
3617 $cancelParams['redirect'] = 'no';
3619 $attrs = [ 'id' => 'mw-editform-cancel' ];
3621 return Linker
::linkKnown(
3622 $this->getContextTitle(),
3623 wfMessage( 'cancel' )->parse(),
3624 Html
::buttonAttributes( $attrs, [ 'mw-ui-quiet' ] ),
3630 * Returns the URL to use in the form's action attribute.
3631 * This is used by EditPage subclasses when simply customizing the action
3632 * variable in the constructor is not enough. This can be used when the
3633 * EditPage lives inside of a Special page rather than a custom page action.
3635 * @param Title $title Title object for which is being edited (where we go to for &action= links)
3638 protected function getActionURL( Title
$title ) {
3639 return $title->getLocalURL( [ 'action' => $this->action
] );
3643 * Check if a page was deleted while the user was editing it, before submit.
3644 * Note that we rely on the logging table, which hasn't been always there,
3645 * but that doesn't matter, because this only applies to brand new
3649 protected function wasDeletedSinceLastEdit() {
3650 if ( $this->deletedSinceEdit
!== null ) {
3651 return $this->deletedSinceEdit
;
3654 $this->deletedSinceEdit
= false;
3656 if ( !$this->mTitle
->exists() && $this->mTitle
->isDeletedQuick() ) {
3657 $this->lastDelete
= $this->getLastDelete();
3658 if ( $this->lastDelete
) {
3659 $deleteTime = wfTimestamp( TS_MW
, $this->lastDelete
->log_timestamp
);
3660 if ( $deleteTime > $this->starttime
) {
3661 $this->deletedSinceEdit
= true;
3666 return $this->deletedSinceEdit
;
3670 * @return bool|stdClass
3672 protected function getLastDelete() {
3673 $dbr = wfGetDB( DB_REPLICA
);
3674 $data = $dbr->selectRow(
3675 [ 'logging', 'user' ],
3688 'log_namespace' => $this->mTitle
->getNamespace(),
3689 'log_title' => $this->mTitle
->getDBkey(),
3690 'log_type' => 'delete',
3691 'log_action' => 'delete',
3695 [ 'LIMIT' => 1, 'ORDER BY' => 'log_timestamp DESC' ]
3697 // Quick paranoid permission checks...
3698 if ( is_object( $data ) ) {
3699 if ( $data->log_deleted
& LogPage
::DELETED_USER
) {
3700 $data->user_name
= wfMessage( 'rev-deleted-user' )->escaped();
3703 if ( $data->log_deleted
& LogPage
::DELETED_COMMENT
) {
3704 $data->log_comment
= wfMessage( 'rev-deleted-comment' )->escaped();
3712 * Get the rendered text for previewing.
3713 * @throws MWException
3716 function getPreviewText() {
3717 global $wgOut, $wgRawHtml, $wgLang;
3718 global $wgAllowUserCss, $wgAllowUserJs;
3720 $stats = $wgOut->getContext()->getStats();
3722 if ( $wgRawHtml && !$this->mTokenOk
) {
3723 // Could be an offsite preview attempt. This is very unsafe if
3724 // HTML is enabled, as it could be an attack.
3726 if ( $this->textbox1
!== '' ) {
3727 // Do not put big scary notice, if previewing the empty
3728 // string, which happens when you initially edit
3729 // a category page, due to automatic preview-on-open.
3730 $parsedNote = $wgOut->parse( "<div class='previewnote'>" .
3731 wfMessage( 'session_fail_preview_html' )->text() . "</div>", true, /* interface */true );
3733 $stats->increment( 'edit.failures.session_loss' );
3740 $content = $this->toEditContent( $this->textbox1
);
3744 'AlternateEditPreview',
3745 [ $this, &$content, &$previewHTML, &$this->mParserOutput
] )
3747 return $previewHTML;
3750 # provide a anchor link to the editform
3751 $continueEditing = '<span class="mw-continue-editing">' .
3752 '[[#' . self
::EDITFORM_ID
. '|' . $wgLang->getArrow() . ' ' .
3753 wfMessage( 'continue-editing' )->text() . ']]</span>';
3754 if ( $this->mTriedSave
&& !$this->mTokenOk
) {
3755 if ( $this->mTokenOkExceptSuffix
) {
3756 $note = wfMessage( 'token_suffix_mismatch' )->plain();
3757 $stats->increment( 'edit.failures.bad_token' );
3759 $note = wfMessage( 'session_fail_preview' )->plain();
3760 $stats->increment( 'edit.failures.session_loss' );
3762 } elseif ( $this->incompleteForm
) {
3763 $note = wfMessage( 'edit_form_incomplete' )->plain();
3764 if ( $this->mTriedSave
) {
3765 $stats->increment( 'edit.failures.incomplete_form' );
3768 $note = wfMessage( 'previewnote' )->plain() . ' ' . $continueEditing;
3771 # don't parse non-wikitext pages, show message about preview
3772 if ( $this->mTitle
->isCssJsSubpage() ||
$this->mTitle
->isCssOrJsPage() ) {
3773 if ( $this->mTitle
->isCssJsSubpage() ) {
3775 } elseif ( $this->mTitle
->isCssOrJsPage() ) {
3781 if ( $content->getModel() == CONTENT_MODEL_CSS
) {
3783 if ( $level === 'user' && !$wgAllowUserCss ) {
3786 } elseif ( $content->getModel() == CONTENT_MODEL_JAVASCRIPT
) {
3788 if ( $level === 'user' && !$wgAllowUserJs ) {
3795 # Used messages to make sure grep find them:
3796 # Messages: usercsspreview, userjspreview, sitecsspreview, sitejspreview
3797 if ( $level && $format ) {
3798 $note = "<div id='mw-{$level}{$format}preview'>" .
3799 wfMessage( "{$level}{$format}preview" )->text() .
3800 ' ' . $continueEditing . "</div>";
3804 # If we're adding a comment, we need to show the
3805 # summary as the headline
3806 if ( $this->section
=== "new" && $this->summary
!== "" ) {
3807 $content = $content->addSectionHeader( $this->summary
);
3810 $hook_args = [ $this, &$content ];
3811 ContentHandler
::runLegacyHooks( 'EditPageGetPreviewText', $hook_args );
3812 Hooks
::run( 'EditPageGetPreviewContent', $hook_args );
3814 $parserResult = $this->doPreviewParse( $content );
3815 $parserOutput = $parserResult['parserOutput'];
3816 $previewHTML = $parserResult['html'];
3817 $this->mParserOutput
= $parserOutput;
3818 $wgOut->addParserOutputMetadata( $parserOutput );
3820 if ( count( $parserOutput->getWarnings() ) ) {
3821 $note .= "\n\n" . implode( "\n\n", $parserOutput->getWarnings() );
3824 } catch ( MWContentSerializationException
$ex ) {
3826 'content-failed-to-parse',
3827 $this->contentModel
,
3828 $this->contentFormat
,
3831 $note .= "\n\n" . $m->parse();
3835 if ( $this->isConflict
) {
3836 $conflict = '<h2 id="mw-previewconflict">'
3837 . wfMessage( 'previewconflict' )->escaped() . "</h2>\n";
3839 $conflict = '<hr />';
3842 $previewhead = "<div class='previewnote'>\n" .
3843 '<h2 id="mw-previewheader">' . wfMessage( 'preview' )->escaped() . "</h2>" .
3844 $wgOut->parse( $note, true, /* interface */true ) . $conflict . "</div>\n";
3846 $pageViewLang = $this->mTitle
->getPageViewLanguage();
3847 $attribs = [ 'lang' => $pageViewLang->getHtmlCode(), 'dir' => $pageViewLang->getDir(),
3848 'class' => 'mw-content-' . $pageViewLang->getDir() ];
3849 $previewHTML = Html
::rawElement( 'div', $attribs, $previewHTML );
3851 return $previewhead . $previewHTML . $this->previewTextAfterContent
;
3855 * Get parser options for a preview
3856 * @return ParserOptions
3858 protected function getPreviewParserOptions() {
3859 $parserOptions = $this->page
->makeParserOptions( $this->mArticle
->getContext() );
3860 $parserOptions->setIsPreview( true );
3861 $parserOptions->setIsSectionPreview( !is_null( $this->section
) && $this->section
!== '' );
3862 $parserOptions->enableLimitReport();
3863 return $parserOptions;
3867 * Parse the page for a preview. Subclasses may override this class, in order
3868 * to parse with different options, or to otherwise modify the preview HTML.
3870 * @param Content $content The page content
3871 * @return array with keys:
3872 * - parserOutput: The ParserOutput object
3873 * - html: The HTML to be displayed
3875 protected function doPreviewParse( Content
$content ) {
3877 $parserOptions = $this->getPreviewParserOptions();
3878 $pstContent = $content->preSaveTransform( $this->mTitle
, $wgUser, $parserOptions );
3879 $scopedCallback = $parserOptions->setupFakeRevision(
3880 $this->mTitle
, $pstContent, $wgUser );
3881 $parserOutput = $pstContent->getParserOutput( $this->mTitle
, null, $parserOptions );
3882 ScopedCallback
::consume( $scopedCallback );
3883 $parserOutput->setEditSectionTokens( false ); // no section edit links
3885 'parserOutput' => $parserOutput,
3886 'html' => $parserOutput->getText() ];
3892 function getTemplates() {
3893 if ( $this->preview ||
$this->section
!= '' ) {
3895 if ( !isset( $this->mParserOutput
) ) {
3898 foreach ( $this->mParserOutput
->getTemplates() as $ns => $template ) {
3899 foreach ( array_keys( $template ) as $dbk ) {
3900 $templates[] = Title
::makeTitle( $ns, $dbk );
3905 return $this->mTitle
->getTemplateLinksFrom();
3910 * Shows a bulletin board style toolbar for common editing functions.
3911 * It can be disabled in the user preferences.
3913 * @param Title $title Title object for the page being edited (optional)
3916 static function getEditToolbar( $title = null ) {
3917 global $wgContLang, $wgOut;
3918 global $wgEnableUploads, $wgForeignFileRepos;
3920 $imagesAvailable = $wgEnableUploads ||
count( $wgForeignFileRepos );
3921 $showSignature = true;
3923 $showSignature = MWNamespace
::wantSignatures( $title->getNamespace() );
3927 * $toolarray is an array of arrays each of which includes the
3928 * opening tag, the closing tag, optionally a sample text that is
3929 * inserted between the two when no selection is highlighted
3930 * and. The tip text is shown when the user moves the mouse
3933 * Images are defined in ResourceLoaderEditToolbarModule.
3937 'id' => 'mw-editbutton-bold',
3939 'close' => '\'\'\'',
3940 'sample' => wfMessage( 'bold_sample' )->text(),
3941 'tip' => wfMessage( 'bold_tip' )->text(),
3944 'id' => 'mw-editbutton-italic',
3947 'sample' => wfMessage( 'italic_sample' )->text(),
3948 'tip' => wfMessage( 'italic_tip' )->text(),
3951 'id' => 'mw-editbutton-link',
3954 'sample' => wfMessage( 'link_sample' )->text(),
3955 'tip' => wfMessage( 'link_tip' )->text(),
3958 'id' => 'mw-editbutton-extlink',
3961 'sample' => wfMessage( 'extlink_sample' )->text(),
3962 'tip' => wfMessage( 'extlink_tip' )->text(),
3965 'id' => 'mw-editbutton-headline',
3968 'sample' => wfMessage( 'headline_sample' )->text(),
3969 'tip' => wfMessage( 'headline_tip' )->text(),
3971 $imagesAvailable ?
[
3972 'id' => 'mw-editbutton-image',
3973 'open' => '[[' . $wgContLang->getNsText( NS_FILE
) . ':',
3975 'sample' => wfMessage( 'image_sample' )->text(),
3976 'tip' => wfMessage( 'image_tip' )->text(),
3978 $imagesAvailable ?
[
3979 'id' => 'mw-editbutton-media',
3980 'open' => '[[' . $wgContLang->getNsText( NS_MEDIA
) . ':',
3982 'sample' => wfMessage( 'media_sample' )->text(),
3983 'tip' => wfMessage( 'media_tip' )->text(),
3986 'id' => 'mw-editbutton-nowiki',
3987 'open' => "<nowiki>",
3988 'close' => "</nowiki>",
3989 'sample' => wfMessage( 'nowiki_sample' )->text(),
3990 'tip' => wfMessage( 'nowiki_tip' )->text(),
3993 'id' => 'mw-editbutton-signature',
3994 'open' => wfMessage( 'sig-text', '~~~~' )->inContentLanguage()->text(),
3997 'tip' => wfMessage( 'sig_tip' )->text(),
4000 'id' => 'mw-editbutton-hr',
4001 'open' => "\n----\n",
4004 'tip' => wfMessage( 'hr_tip' )->text(),
4008 $script = 'mw.loader.using("mediawiki.toolbar", function () {';
4009 foreach ( $toolarray as $tool ) {
4015 // Images are defined in ResourceLoaderEditToolbarModule
4017 // Note that we use the tip both for the ALT tag and the TITLE tag of the image.
4018 // Older browsers show a "speedtip" type message only for ALT.
4019 // Ideally these should be different, realistically they
4020 // probably don't need to be.
4028 $script .= Xml
::encodeJsCall(
4029 'mw.toolbar.addButton',
4031 ResourceLoader
::inDebugMode()
4036 $wgOut->addScript( ResourceLoader
::makeInlineScript( $script ) );
4038 $toolbar = '<div id="toolbar"></div>';
4040 Hooks
::run( 'EditPageBeforeEditToolbar', [ &$toolbar ] );
4046 * Returns an array of html code of the following checkboxes:
4049 * @param int $tabindex Current tabindex
4050 * @param array $checked Array of checkbox => bool, where bool indicates the checked
4051 * status of the checkbox
4055 public function getCheckboxes( &$tabindex, $checked ) {
4056 global $wgUser, $wgUseMediaWikiUIEverywhere;
4060 // don't show the minor edit checkbox if it's a new page or section
4061 if ( !$this->isNew
) {
4062 $checkboxes['minor'] = '';
4063 $minorLabel = wfMessage( 'minoredit' )->parse();
4064 if ( $wgUser->isAllowed( 'minoredit' ) ) {
4066 'tabindex' => ++
$tabindex,
4067 'accesskey' => wfMessage( 'accesskey-minoredit' )->text(),
4068 'id' => 'wpMinoredit',
4071 Xml
::check( 'wpMinoredit', $checked['minor'], $attribs ) .
4072 " <label for='wpMinoredit' id='mw-editpage-minoredit'" .
4073 Xml
::expandAttributes( [ 'title' => Linker
::titleAttrib( 'minoredit', 'withaccess' ) ] ) .
4074 ">{$minorLabel}</label>";
4076 if ( $wgUseMediaWikiUIEverywhere ) {
4077 $checkboxes['minor'] = Html
::openElement( 'div', [ 'class' => 'mw-ui-checkbox' ] ) .
4079 Html
::closeElement( 'div' );
4081 $checkboxes['minor'] = $minorEditHtml;
4086 $watchLabel = wfMessage( 'watchthis' )->parse();
4087 $checkboxes['watch'] = '';
4088 if ( $wgUser->isLoggedIn() ) {
4090 'tabindex' => ++
$tabindex,
4091 'accesskey' => wfMessage( 'accesskey-watch' )->text(),
4092 'id' => 'wpWatchthis',
4095 Xml
::check( 'wpWatchthis', $checked['watch'], $attribs ) .
4096 " <label for='wpWatchthis' id='mw-editpage-watch'" .
4097 Xml
::expandAttributes( [ 'title' => Linker
::titleAttrib( 'watch', 'withaccess' ) ] ) .
4098 ">{$watchLabel}</label>";
4099 if ( $wgUseMediaWikiUIEverywhere ) {
4100 $checkboxes['watch'] = Html
::openElement( 'div', [ 'class' => 'mw-ui-checkbox' ] ) .
4102 Html
::closeElement( 'div' );
4104 $checkboxes['watch'] = $watchThisHtml;
4107 Hooks
::run( 'EditPageBeforeEditChecks', [ &$this, &$checkboxes, &$tabindex ] );
4112 * Returns an array of html code of the following buttons:
4113 * save, diff, preview and live
4115 * @param int $tabindex Current tabindex
4119 public function getEditButtons( &$tabindex ) {
4123 $this->mArticle
->getContext()->getConfig()->get( 'EditSubmitButtonLabelPublish' );
4125 // Can't use $this->isNew as that's also true if we're adding a new section to an extant page
4126 if ( $labelAsPublish ) {
4127 $buttonLabelKey = !$this->mTitle
->exists() ?
'publishpage' : 'publishchanges';
4129 $buttonLabelKey = !$this->mTitle
->exists() ?
'savearticle' : 'savechanges';
4131 $buttonLabel = wfMessage( $buttonLabelKey )->text();
4135 'tabindex' => ++
$tabindex,
4136 ] + Linker
::tooltipAndAccesskeyAttribs( 'save' );
4137 $buttons['save'] = Html
::submitButton( $buttonLabel, $attribs, [ 'mw-ui-constructive' ] );
4139 ++
$tabindex; // use the same for preview and live preview
4141 'id' => 'wpPreview',
4142 'name' => 'wpPreview',
4143 'tabindex' => $tabindex,
4144 ] + Linker
::tooltipAndAccesskeyAttribs( 'preview' );
4145 $buttons['preview'] = Html
::submitButton( wfMessage( 'showpreview' )->text(),
4147 $buttons['live'] = '';
4152 'tabindex' => ++
$tabindex,
4153 ] + Linker
::tooltipAndAccesskeyAttribs( 'diff' );
4154 $buttons['diff'] = Html
::submitButton( wfMessage( 'showdiff' )->text(),
4157 Hooks
::run( 'EditPageBeforeEditButtons', [ &$this, &$buttons, &$tabindex ] );
4162 * Creates a basic error page which informs the user that
4163 * they have attempted to edit a nonexistent section.
4165 function noSuchSectionPage() {
4168 $wgOut->prepareErrorPage( wfMessage( 'nosuchsectiontitle' ) );
4170 $res = wfMessage( 'nosuchsectiontext', $this->section
)->parseAsBlock();
4171 Hooks
::run( 'EditPageNoSuchSection', [ &$this, &$res ] );
4172 $wgOut->addHTML( $res );
4174 $wgOut->returnToMain( false, $this->mTitle
);
4178 * Show "your edit contains spam" page with your diff and text
4180 * @param string|array|bool $match Text (or array of texts) which triggered one or more filters
4182 public function spamPageWithContent( $match = false ) {
4183 global $wgOut, $wgLang;
4184 $this->textbox2
= $this->textbox1
;
4186 if ( is_array( $match ) ) {
4187 $match = $wgLang->listToText( $match );
4189 $wgOut->prepareErrorPage( wfMessage( 'spamprotectiontitle' ) );
4191 $wgOut->addHTML( '<div id="spamprotected">' );
4192 $wgOut->addWikiMsg( 'spamprotectiontext' );
4194 $wgOut->addWikiMsg( 'spamprotectionmatch', wfEscapeWikiText( $match ) );
4196 $wgOut->addHTML( '</div>' );
4198 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
4201 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
4202 $this->showTextbox2();
4204 $wgOut->addReturnTo( $this->getContextTitle(), [ 'action' => 'edit' ] );
4208 * Check if the browser is on a blacklist of user-agents known to
4209 * mangle UTF-8 data on form submission. Returns true if Unicode
4210 * should make it through, false if it's known to be a problem.
4213 private function checkUnicodeCompliantBrowser() {
4214 global $wgBrowserBlackList, $wgRequest;
4216 $currentbrowser = $wgRequest->getHeader( 'User-Agent' );
4217 if ( $currentbrowser === false ) {
4218 // No User-Agent header sent? Trust it by default...
4222 foreach ( $wgBrowserBlackList as $browser ) {
4223 if ( preg_match( $browser, $currentbrowser ) ) {
4231 * Filter an input field through a Unicode de-armoring process if it
4232 * came from an old browser with known broken Unicode editing issues.
4234 * @param WebRequest $request
4235 * @param string $field
4238 protected function safeUnicodeInput( $request, $field ) {
4239 $text = rtrim( $request->getText( $field ) );
4240 return $request->getBool( 'safemode' )
4241 ?
$this->unmakeSafe( $text )
4246 * Filter an output field through a Unicode armoring process if it is
4247 * going to an old browser with known broken Unicode editing issues.
4249 * @param string $text
4252 protected function safeUnicodeOutput( $text ) {
4253 return $this->checkUnicodeCompliantBrowser()
4255 : $this->makesafe( $text );
4259 * A number of web browsers are known to corrupt non-ASCII characters
4260 * in a UTF-8 text editing environment. To protect against this,
4261 * detected browsers will be served an armored version of the text,
4262 * with non-ASCII chars converted to numeric HTML character references.
4264 * Preexisting such character references will have a 0 added to them
4265 * to ensure that round-trips do not alter the original data.
4267 * @param string $invalue
4270 private function makeSafe( $invalue ) {
4271 // Armor existing references for reversibility.
4272 $invalue = strtr( $invalue, [ "&#x" => "�" ] );
4277 $valueLength = strlen( $invalue );
4278 for ( $i = 0; $i < $valueLength; $i++
) {
4279 $bytevalue = ord( $invalue[$i] );
4280 if ( $bytevalue <= 0x7F ) { // 0xxx xxxx
4281 $result .= chr( $bytevalue );
4283 } elseif ( $bytevalue <= 0xBF ) { // 10xx xxxx
4284 $working = $working << 6;
4285 $working +
= ( $bytevalue & 0x3F );
4287 if ( $bytesleft <= 0 ) {
4288 $result .= "&#x" . strtoupper( dechex( $working ) ) . ";";
4290 } elseif ( $bytevalue <= 0xDF ) { // 110x xxxx
4291 $working = $bytevalue & 0x1F;
4293 } elseif ( $bytevalue <= 0xEF ) { // 1110 xxxx
4294 $working = $bytevalue & 0x0F;
4296 } else { // 1111 0xxx
4297 $working = $bytevalue & 0x07;
4305 * Reverse the previously applied transliteration of non-ASCII characters
4306 * back to UTF-8. Used to protect data from corruption by broken web browsers
4307 * as listed in $wgBrowserBlackList.
4309 * @param string $invalue
4312 private function unmakeSafe( $invalue ) {
4314 $valueLength = strlen( $invalue );
4315 for ( $i = 0; $i < $valueLength; $i++
) {
4316 if ( ( substr( $invalue, $i, 3 ) == "&#x" ) && ( $invalue[$i +
3] != '0' ) ) {
4320 $hexstring .= $invalue[$i];
4322 } while ( ctype_xdigit( $invalue[$i] ) && ( $i < strlen( $invalue ) ) );
4324 // Do some sanity checks. These aren't needed for reversibility,
4325 // but should help keep the breakage down if the editor
4326 // breaks one of the entities whilst editing.
4327 if ( ( substr( $invalue, $i, 1 ) == ";" ) && ( strlen( $hexstring ) <= 6 ) ) {
4328 $codepoint = hexdec( $hexstring );
4329 $result .= UtfNormal\Utils
::codepointToUtf8( $codepoint );
4331 $result .= "&#x" . $hexstring . substr( $invalue, $i, 1 );
4334 $result .= substr( $invalue, $i, 1 );
4337 // reverse the transform that we made for reversibility reasons.
4338 return strtr( $result, [ "�" => "&#x" ] );