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
;
26 * The edit page/HTML interface (split from Article)
27 * The actual database and text munging is still in Article,
28 * but it should get easier to call those from alternate
31 * EditPage cares about two distinct titles:
32 * $this->mContextTitle is the page that forms submit to, links point to,
33 * redirects go to, etc. $this->mTitle (as well as $mArticle) is the
34 * page in the database that is actually being edited. These are
35 * usually the same, but they are now allowed to be different.
37 * Surgeon General's Warning: prolonged exposure to this class is known to cause
38 * headaches, which may be fatal.
42 * Status: Article successfully updated
44 const AS_SUCCESS_UPDATE
= 200;
47 * Status: Article successfully created
49 const AS_SUCCESS_NEW_ARTICLE
= 201;
52 * Status: Article update aborted by a hook function
54 const AS_HOOK_ERROR
= 210;
57 * Status: A hook function returned an error
59 const AS_HOOK_ERROR_EXPECTED
= 212;
62 * Status: User is blocked from editing this page
64 const AS_BLOCKED_PAGE_FOR_USER
= 215;
67 * Status: Content too big (> $wgMaxArticleSize)
69 const AS_CONTENT_TOO_BIG
= 216;
72 * Status: this anonymous user is not allowed to edit this page
74 const AS_READ_ONLY_PAGE_ANON
= 218;
77 * Status: this logged in user is not allowed to edit this page
79 const AS_READ_ONLY_PAGE_LOGGED
= 219;
82 * Status: wiki is in readonly mode (wfReadOnly() == true)
84 const AS_READ_ONLY_PAGE
= 220;
87 * Status: rate limiter for action 'edit' was tripped
89 const AS_RATE_LIMITED
= 221;
92 * Status: article was deleted while editing and param wpRecreate == false or form
95 const AS_ARTICLE_WAS_DELETED
= 222;
98 * Status: user tried to create this page, but is not allowed to do that
99 * ( Title->userCan('create') == false )
101 const AS_NO_CREATE_PERMISSION
= 223;
104 * Status: user tried to create a blank page and wpIgnoreBlankArticle == false
106 const AS_BLANK_ARTICLE
= 224;
109 * Status: (non-resolvable) edit conflict
111 const AS_CONFLICT_DETECTED
= 225;
114 * Status: no edit summary given and the user has forceeditsummary set and the user is not
115 * editing in his own userspace or talkspace and wpIgnoreBlankSummary == false
117 const AS_SUMMARY_NEEDED
= 226;
120 * Status: user tried to create a new section without content
122 const AS_TEXTBOX_EMPTY
= 228;
125 * Status: article is too big (> $wgMaxArticleSize), after merging in the new section
127 const AS_MAX_ARTICLE_SIZE_EXCEEDED
= 229;
130 * Status: WikiPage::doEdit() was unsuccessful
135 * Status: summary contained spam according to one of the regexes in $wgSummarySpamRegex
137 const AS_SPAM_ERROR
= 232;
140 * Status: anonymous user is not allowed to upload (User::isAllowed('upload') == false)
142 const AS_IMAGE_REDIRECT_ANON
= 233;
145 * Status: logged in user is not allowed to upload (User::isAllowed('upload') == false)
147 const AS_IMAGE_REDIRECT_LOGGED
= 234;
150 * Status: user tried to modify the content model, but is not allowed to do that
151 * ( User::isAllowed('editcontentmodel') == false )
153 const AS_NO_CHANGE_CONTENT_MODEL
= 235;
156 * Status: user tried to create self-redirect (redirect to the same article) and
157 * wpIgnoreSelfRedirect == false
159 const AS_SELF_REDIRECT
= 236;
162 * Status: an error relating to change tagging. Look at the message key for
165 const AS_CHANGE_TAG_ERROR
= 237;
168 * Status: can't parse content
170 const AS_PARSE_ERROR
= 240;
173 * Status: when changing the content model is disallowed due to
174 * $wgContentHandlerUseDB being false
176 const AS_CANNOT_USE_CUSTOM_MODEL
= 241;
179 * HTML id and name for the beginning of the edit form.
181 const EDITFORM_ID
= 'editform';
184 * Prefix of key for cookie used to pass post-edit state.
185 * The revision id edited is added after this
187 const POST_EDIT_COOKIE_KEY_PREFIX
= 'PostEditRevision';
190 * Duration of PostEdit cookie, in seconds.
191 * The cookie will be removed instantly if the JavaScript runs.
193 * Otherwise, though, we don't want the cookies to accumulate.
194 * RFC 2109 ( https://www.ietf.org/rfc/rfc2109.txt ) specifies a possible
195 * limit of only 20 cookies per domain. This still applies at least to some
196 * versions of IE without full updates:
197 * https://blogs.msdn.com/b/ieinternals/archive/2009/08/20/wininet-ie-cookie-internals-faq.aspx
199 * A value of 20 minutes should be enough to take into account slow loads and minor
200 * clock skew while still avoiding cookie accumulation when JavaScript is turned off.
202 const POST_EDIT_COOKIE_DURATION
= 1200;
212 /** @var null|Title */
213 private $mContextTitle = null;
216 public $action = 'submit';
219 public $isConflict = false;
222 public $isCssJsSubpage = false;
225 public $isCssSubpage = false;
228 public $isJsSubpage = false;
231 public $isWrongCaseCssJsPage = false;
233 /** @var bool New page or new section */
234 public $isNew = false;
237 public $deletedSinceEdit;
245 /** @var bool|stdClass */
249 public $mTokenOk = false;
252 public $mTokenOkExceptSuffix = false;
255 public $mTriedSave = false;
258 public $incompleteForm = false;
261 public $tooBig = false;
264 public $missingComment = false;
267 public $missingSummary = false;
270 public $allowBlankSummary = false;
273 protected $blankArticle = false;
276 protected $allowBlankArticle = false;
279 protected $selfRedirect = false;
282 protected $allowSelfRedirect = false;
285 public $autoSumm = '';
288 public $hookError = '';
290 /** @var ParserOutput */
291 public $mParserOutput;
293 /** @var bool Has a summary been preset using GET parameter &summary= ? */
294 public $hasPresetSummary = false;
297 public $mBaseRevision = false;
300 public $mShowSummaryField = true;
305 public $save = false;
308 public $preview = false;
311 public $diff = false;
314 public $minoredit = false;
317 public $watchthis = false;
320 public $recreate = false;
323 public $textbox1 = '';
326 public $textbox2 = '';
329 public $summary = '';
332 public $nosummary = false;
335 public $edittime = '';
338 private $editRevId = null;
341 public $section = '';
344 public $sectiontitle = '';
347 public $starttime = '';
353 public $parentRevId = 0;
356 public $editintro = '';
359 public $scrolltop = null;
364 /** @var null|string */
365 public $contentModel = null;
367 /** @var null|string */
368 public $contentFormat = null;
370 /** @var null|array */
371 private $changeTags = null;
373 # Placeholders for text injection by hooks (must be HTML)
374 # extensions should take care to _append_ to the present value
376 /** @var string Before even the preview */
377 public $editFormPageTop = '';
378 public $editFormTextTop = '';
379 public $editFormTextBeforeContent = '';
380 public $editFormTextAfterWarn = '';
381 public $editFormTextAfterTools = '';
382 public $editFormTextBottom = '';
383 public $editFormTextAfterContent = '';
384 public $previewTextAfterContent = '';
385 public $mPreloadContent = null;
387 /* $didSave should be set to true whenever an article was successfully altered. */
388 public $didSave = false;
389 public $undidRev = 0;
391 public $suppressIntro = false;
397 protected $contentLength = false;
400 * @var bool Set in ApiEditPage, based on ContentHandler::allowsDirectApiEditing
402 private $enableApiEditOverride = false;
405 * @var IContextSource
410 * @param Article $article
412 public function __construct( Article
$article ) {
413 $this->mArticle
= $article;
414 $this->page
= $article->getPage(); // model object
415 $this->mTitle
= $article->getTitle();
416 $this->context
= $article->getContext();
418 $this->contentModel
= $this->mTitle
->getContentModel();
420 $handler = ContentHandler
::getForModelID( $this->contentModel
);
421 $this->contentFormat
= $handler->getDefaultFormat();
427 public function getArticle() {
428 return $this->mArticle
;
433 * @return IContextSource
435 public function getContext() {
436 return $this->context
;
443 public function getTitle() {
444 return $this->mTitle
;
448 * Set the context Title object
450 * @param Title|null $title Title object or null
452 public function setContextTitle( $title ) {
453 $this->mContextTitle
= $title;
457 * Get the context title object.
458 * If not set, $wgTitle will be returned. This behavior might change in
459 * the future to return $this->mTitle instead.
463 public function getContextTitle() {
464 if ( is_null( $this->mContextTitle
) ) {
468 return $this->mContextTitle
;
473 * Returns if the given content model is editable.
475 * @param string $modelId The ID of the content model to test. Use CONTENT_MODEL_XXX constants.
477 * @throws MWException If $modelId has no known handler
479 public function isSupportedContentModel( $modelId ) {
480 return $this->enableApiEditOverride
=== true ||
481 ContentHandler
::getForModelID( $modelId )->supportsDirectEditing();
485 * Allow editing of content that supports API direct editing, but not general
486 * direct editing. Set to false by default.
488 * @param bool $enableOverride
490 public function setApiEditOverride( $enableOverride ) {
491 $this->enableApiEditOverride
= $enableOverride;
499 * This is the function that gets called for "action=edit". It
500 * sets up various member variables, then passes execution to
501 * another function, usually showEditForm()
503 * The edit form is self-submitting, so that when things like
504 * preview and edit conflicts occur, we get the same form back
505 * with the extra stuff added. Only when the final submission
506 * is made and all is well do we actually save and redirect to
507 * the newly-edited page.
510 // Allow extensions to modify/prevent this form or submission
511 if ( !Hooks
::run( 'AlternateEdit', [ $this ] ) ) {
515 wfDebug( __METHOD__
. ": enter\n" );
517 $request = $this->context
->getRequest();
518 $out = $this->context
->getOutput();
519 // If they used redlink=1 and the page exists, redirect to the main article
520 if ( $request->getBool( 'redlink' ) && $this->mTitle
->exists() ) {
521 $out->redirect( $this->mTitle
->getFullURL() );
525 $this->importFormData( $request );
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() ) {
554 $user = $this->context
->getUser();
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 if ( $revision && $revision->getContentModel() !== $this->contentModel
) {
567 $this->displayViewSourcePage(
568 $this->getContentObject(),
570 'contentmodelediterror',
571 $revision->getContentModel(),
578 $this->isConflict
= false;
579 // css / js subpages of user pages get a special treatment
580 $this->isCssJsSubpage
= $this->mTitle
->isCssJsSubpage();
581 $this->isCssSubpage
= $this->mTitle
->isCssSubpage();
582 $this->isJsSubpage
= $this->mTitle
->isJsSubpage();
583 // @todo FIXME: Silly assignment.
584 $this->isWrongCaseCssJsPage
= $this->isWrongCaseCssJsPage();
586 # Show applicable editing introductions
587 if ( $this->formtype
== 'initial' ||
$this->firsttime
) {
591 # Attempt submission here. This will check for edit conflicts,
592 # and redundantly check for locked database, blocked IPs, etc.
593 # that edit() already checked just in case someone tries to sneak
594 # in the back door with a hand-edited submission URL.
596 if ( 'save' == $this->formtype
) {
597 $resultDetails = null;
598 $status = $this->attemptSave( $resultDetails );
599 if ( !$this->handleStatus( $status, $resultDetails ) ) {
604 # First time through: get contents, set time for conflict
606 if ( 'initial' == $this->formtype ||
$this->firsttime
) {
607 if ( $this->initialiseForm() === false ) {
608 $this->noSuchSectionPage();
612 if ( !$this->mTitle
->getArticleID() ) {
613 Hooks
::run( 'EditFormPreloadText', [ &$this->textbox1
, &$this->mTitle
] );
615 Hooks
::run( 'EditFormInitialText', [ $this ] );
620 $this->showEditForm();
624 * @param string $rigor Same format as Title::getUserPermissionErrors()
627 protected function getEditPermissionErrors( $rigor = 'secure' ) {
628 $user = $this->context
->getUser();
629 $permErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $user, $rigor );
630 # Can this title be created?
631 if ( !$this->mTitle
->exists() ) {
632 $permErrors = array_merge(
635 $this->mTitle
->getUserPermissionsErrors( 'create', $user, $rigor ),
640 # Ignore some permissions errors when a user is just previewing/viewing diffs
642 foreach ( $permErrors as $error ) {
643 if ( ( $this->preview ||
$this->diff
)
644 && ( $error[0] == 'blockedtext' ||
$error[0] == 'autoblockedtext' )
649 $permErrors = wfArrayDiff2( $permErrors, $remove );
655 * Display a permissions error page, like OutputPage::showPermissionsErrorPage(),
656 * but with the following differences:
657 * - If redlink=1, the user will be redirected to the page
658 * - If there is content to display or the error occurs while either saving,
659 * previewing or showing the difference, it will be a
660 * "View source for ..." page displaying the source code after the error message.
663 * @param array $permErrors Array of permissions errors, as returned by
664 * Title::getUserPermissionsErrors().
665 * @throws PermissionsError
667 protected function displayPermissionsError( array $permErrors ) {
668 $out = $this->context
->getOutput();
669 if ( $this->context
->getRequest()->getBool( 'redlink' ) ) {
670 // The edit page was reached via a red link.
671 // Redirect to the article page and let them click the edit tab if
672 // they really want a permission error.
673 $out->redirect( $this->mTitle
->getFullURL() );
677 $content = $this->getContentObject();
679 # Use the normal message if there's nothing to display
680 if ( $this->firsttime
&& ( !$content ||
$content->isEmpty() ) ) {
681 $action = $this->mTitle
->exists() ?
'edit' :
682 ( $this->mTitle
->isTalkPage() ?
'createtalk' : 'createpage' );
683 throw new PermissionsError( $action, $permErrors );
686 $this->displayViewSourcePage(
688 $out->formatPermissionsErrorMessage( $permErrors, 'edit' )
693 * Display a read-only View Source page
694 * @param Content $content content object
695 * @param string $errorMessage additional wikitext error message to display
697 protected function displayViewSourcePage( Content
$content, $errorMessage = '' ) {
698 $out = $this->context
->getOutput();
699 Hooks
::run( 'EditPage::showReadOnlyForm:initial', [ $this, &$out ] );
701 $out->setRobotPolicy( 'noindex,nofollow' );
702 $out->setPageTitle( wfMessage(
704 $this->getContextTitle()->getPrefixedText()
706 $out->addBacklinkSubtitle( $this->getContextTitle() );
707 $out->addHTML( $this->editFormPageTop
);
708 $out->addHTML( $this->editFormTextTop
);
710 if ( $errorMessage !== '' ) {
711 $out->addWikiText( $errorMessage );
712 $out->addHTML( "<hr />\n" );
715 # If the user made changes, preserve them when showing the markup
716 # (This happens when a user is blocked during edit, for instance)
717 if ( !$this->firsttime
) {
718 $text = $this->textbox1
;
719 $out->addWikiMsg( 'viewyourtext' );
722 $text = $this->toEditText( $content );
723 } catch ( MWException
$e ) {
724 # Serialize using the default format if the content model is not supported
725 # (e.g. for an old revision with a different model)
726 $text = $content->serialize();
728 $out->addWikiMsg( 'viewsourcetext' );
731 $out->addHTML( $this->editFormTextBeforeContent
);
732 $this->showTextbox( $text, 'wpTextbox1', [ 'readonly' ] );
733 $out->addHTML( $this->editFormTextAfterContent
);
735 $out->addHTML( Html
::rawElement( 'div', [ 'class' => 'templatesUsed' ],
736 Linker
::formatTemplates( $this->getTemplates() ) ) );
738 $out->addModules( 'mediawiki.action.edit.collapsibleFooter' );
740 $out->addHTML( $this->editFormTextBottom
);
741 if ( $this->mTitle
->exists() ) {
742 $out->returnToMain( null, $this->mTitle
);
747 * Should we show a preview when the edit form is first shown?
751 protected function previewOnOpen() {
752 global $wgPreviewOnOpenNamespaces;
753 $request = $this->context
->getRequest();
754 if ( $request->getVal( 'preview' ) == 'yes' ) {
755 // Explicit override from request
757 } elseif ( $request->getVal( 'preview' ) == 'no' ) {
758 // Explicit override from request
760 } elseif ( $this->section
== 'new' ) {
761 // Nothing *to* preview for new sections
763 } elseif ( ( $request->getVal( 'preload' ) !== null ||
$this->mTitle
->exists() )
764 && $this->context
->getUser()->getOption( 'previewonfirst' )
766 // Standard preference behavior
768 } elseif ( !$this->mTitle
->exists()
769 && isset( $wgPreviewOnOpenNamespaces[$this->mTitle
->getNamespace()] )
770 && $wgPreviewOnOpenNamespaces[$this->mTitle
->getNamespace()]
772 // Categories are special
780 * Checks whether the user entered a skin name in uppercase,
781 * e.g. "User:Example/Monobook.css" instead of "monobook.css"
785 protected function isWrongCaseCssJsPage() {
786 if ( $this->mTitle
->isCssJsSubpage() ) {
787 $name = $this->mTitle
->getSkinFromCssJsSubpage();
788 $skins = array_merge(
789 array_keys( Skin
::getSkinNames() ),
792 return !in_array( $name, $skins )
793 && in_array( strtolower( $name ), $skins );
800 * Returns whether section editing is supported for the current page.
801 * Subclasses may override this to replace the default behavior, which is
802 * to check ContentHandler::supportsSections.
804 * @return bool True if this edit page supports sections, false otherwise.
806 protected function isSectionEditSupported() {
807 $contentHandler = ContentHandler
::getForTitle( $this->mTitle
);
808 return $contentHandler->supportsSections();
812 * This function collects the form data and uses it to populate various member variables.
813 * @param WebRequest $request
814 * @throws ErrorPageError
816 function importFormData( &$request ) {
819 # Section edit can come from either the form or a link
820 $this->section
= $request->getVal( 'wpSection', $request->getVal( 'section' ) );
822 if ( $this->section
!== null && $this->section
!== '' && !$this->isSectionEditSupported() ) {
823 throw new ErrorPageError( 'sectioneditnotsupported-title', 'sectioneditnotsupported-text' );
826 $this->isNew
= !$this->mTitle
->exists() ||
$this->section
== 'new';
828 if ( $request->wasPosted() ) {
829 # These fields need to be checked for encoding.
830 # Also remove trailing whitespace, but don't remove _initial_
831 # whitespace from the text boxes. This may be significant formatting.
832 $this->textbox1
= $this->safeUnicodeInput( $request, 'wpTextbox1' );
833 if ( !$request->getCheck( 'wpTextbox2' ) ) {
834 // Skip this if wpTextbox2 has input, it indicates that we came
835 // from a conflict page with raw page text, not a custom form
836 // modified by subclasses
837 $textbox1 = $this->importContentFormData( $request );
838 if ( $textbox1 !== null ) {
839 $this->textbox1
= $textbox1;
843 # Truncate for whole multibyte characters
844 $this->summary
= $wgContLang->truncate( $request->getText( 'wpSummary' ), 255 );
846 # If the summary consists of a heading, e.g. '==Foobar==', extract the title from the
847 # header syntax, e.g. 'Foobar'. This is mainly an issue when we are using wpSummary for
849 $this->summary
= preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->summary
);
851 # Treat sectiontitle the same way as summary.
852 # Note that wpSectionTitle is not yet a part of the actual edit form, as wpSummary is
853 # currently doing double duty as both edit summary and section title. Right now this
854 # is just to allow API edits to work around this limitation, but this should be
855 # incorporated into the actual edit form when EditPage is rewritten (Bugs 18654, 26312).
856 $this->sectiontitle
= $wgContLang->truncate( $request->getText( 'wpSectionTitle' ), 255 );
857 $this->sectiontitle
= preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->sectiontitle
);
859 $this->edittime
= $request->getVal( 'wpEdittime' );
860 $this->editRevId
= $request->getIntOrNull( 'editRevId' );
861 $this->starttime
= $request->getVal( 'wpStarttime' );
863 $undidRev = $request->getInt( 'wpUndidRevision' );
865 $this->undidRev
= $undidRev;
868 $this->scrolltop
= $request->getIntOrNull( 'wpScrolltop' );
870 if ( $this->textbox1
=== '' && $request->getVal( 'wpTextbox1' ) === null ) {
871 // wpTextbox1 field is missing, possibly due to being "too big"
872 // according to some filter rules such as Suhosin's setting for
873 // suhosin.request.max_value_length (d'oh)
874 $this->incompleteForm
= true;
876 // If we receive the last parameter of the request, we can fairly
877 // claim the POST request has not been truncated.
879 // TODO: softened the check for cutover. Once we determine
880 // that it is safe, we should complete the transition by
881 // removing the "edittime" clause.
882 $this->incompleteForm
= ( !$request->getVal( 'wpUltimateParam' )
883 && is_null( $this->edittime
) );
885 if ( $this->incompleteForm
) {
886 # If the form is incomplete, force to preview.
887 wfDebug( __METHOD__
. ": Form data appears to be incomplete\n" );
888 wfDebug( "POST DATA: " . var_export( $_POST, true ) . "\n" );
889 $this->preview
= true;
891 $this->preview
= $request->getCheck( 'wpPreview' );
892 $this->diff
= $request->getCheck( 'wpDiff' );
894 // Remember whether a save was requested, so we can indicate
895 // if we forced preview due to session failure.
896 $this->mTriedSave
= !$this->preview
;
898 if ( $this->tokenOk( $request ) ) {
899 # Some browsers will not report any submit button
900 # if the user hits enter in the comment box.
901 # The unmarked state will be assumed to be a save,
902 # if the form seems otherwise complete.
903 wfDebug( __METHOD__
. ": Passed token check.\n" );
904 } elseif ( $this->diff
) {
905 # Failed token check, but only requested "Show Changes".
906 wfDebug( __METHOD__
. ": Failed token check; Show Changes requested.\n" );
908 # Page might be a hack attempt posted from
909 # an external site. Preview instead of saving.
910 wfDebug( __METHOD__
. ": Failed token check; forcing preview\n" );
911 $this->preview
= true;
914 $this->save
= !$this->preview
&& !$this->diff
;
915 if ( !preg_match( '/^\d{14}$/', $this->edittime
) ) {
916 $this->edittime
= null;
919 if ( !preg_match( '/^\d{14}$/', $this->starttime
) ) {
920 $this->starttime
= null;
923 $this->recreate
= $request->getCheck( 'wpRecreate' );
925 $this->minoredit
= $request->getCheck( 'wpMinoredit' );
926 $this->watchthis
= $request->getCheck( 'wpWatchthis' );
928 # Don't force edit summaries when a user is editing their own user or talk page
929 $user = $this->context
->getUser();
930 if ( ( $this->mTitle
->mNamespace
== NS_USER ||
$this->mTitle
->mNamespace
== NS_USER_TALK
)
931 && $this->mTitle
->getText() == $user->getName()
933 $this->allowBlankSummary
= true;
935 $this->allowBlankSummary
= $request->getBool( 'wpIgnoreBlankSummary' )
936 ||
!$user->getOption( 'forceeditsummary' );
939 $this->autoSumm
= $request->getText( 'wpAutoSummary' );
941 $this->allowBlankArticle
= $request->getBool( 'wpIgnoreBlankArticle' );
942 $this->allowSelfRedirect
= $request->getBool( 'wpIgnoreSelfRedirect' );
944 $changeTags = $request->getVal( 'wpChangeTags' );
945 if ( is_null( $changeTags ) ||
$changeTags === '' ) {
946 $this->changeTags
= [];
948 $this->changeTags
= array_filter( array_map( 'trim', explode( ',',
952 # Not a posted form? Start with nothing.
953 wfDebug( __METHOD__
. ": Not a posted form.\n" );
954 $this->textbox1
= '';
956 $this->sectiontitle
= '';
957 $this->edittime
= '';
958 $this->editRevId
= null;
959 $this->starttime
= wfTimestampNow();
961 $this->preview
= false;
964 $this->minoredit
= false;
965 // Watch may be overridden by request parameters
966 $this->watchthis
= $request->getBool( 'watchthis', false );
967 $this->recreate
= false;
969 // When creating a new section, we can preload a section title by passing it as the
970 // preloadtitle parameter in the URL (Bug 13100)
971 if ( $this->section
== 'new' && $request->getVal( 'preloadtitle' ) ) {
972 $this->sectiontitle
= $request->getVal( 'preloadtitle' );
973 // Once wpSummary isn't being use for setting section titles, we should delete this.
974 $this->summary
= $request->getVal( 'preloadtitle' );
975 } elseif ( $this->section
!= 'new' && $request->getVal( 'summary' ) ) {
976 $this->summary
= $request->getText( 'summary' );
977 if ( $this->summary
!== '' ) {
978 $this->hasPresetSummary
= true;
982 if ( $request->getVal( 'minor' ) ) {
983 $this->minoredit
= true;
987 $this->oldid
= $request->getInt( 'oldid' );
988 $this->parentRevId
= $request->getInt( 'parentRevId' );
990 $this->bot
= $request->getBool( 'bot', true );
991 $this->nosummary
= $request->getBool( 'nosummary' );
993 // May be overridden by revision.
994 $this->contentModel
= $request->getText( 'model', $this->contentModel
);
995 // May be overridden by revision.
996 $this->contentFormat
= $request->getText( 'format', $this->contentFormat
);
998 if ( !ContentHandler
::getForModelID( $this->contentModel
)
999 ->isSupportedFormat( $this->contentFormat
)
1001 throw new ErrorPageError(
1002 'editpage-notsupportedcontentformat-title',
1003 'editpage-notsupportedcontentformat-text',
1004 [ $this->contentFormat
, ContentHandler
::getLocalizedName( $this->contentModel
) ]
1009 * @todo Check if the desired model is allowed in this namespace, and if
1010 * a transition from the page's current model to the new model is
1014 $this->editintro
= $request->getText( 'editintro',
1015 // Custom edit intro for new sections
1016 $this->section
=== 'new' ?
'MediaWiki:addsection-editintro' : '' );
1018 // Allow extensions to modify form data
1019 Hooks
::run( 'EditPage::importFormData', [ $this, $request ] );
1024 * Subpage overridable method for extracting the page content data from the
1025 * posted form to be placed in $this->textbox1, if using customized input
1026 * this method should be overridden and return the page text that will be used
1027 * for saving, preview parsing and so on...
1029 * @param WebRequest $request
1030 * @return string|null
1032 protected function importContentFormData( &$request ) {
1033 return; // Don't do anything, EditPage already extracted wpTextbox1
1037 * Initialise form fields in the object
1038 * Called on the first invocation, e.g. when a user clicks an edit link
1039 * @return bool If the requested section is valid
1041 function initialiseForm() {
1043 $this->edittime
= $this->page
->getTimestamp();
1044 $this->editRevId
= $this->page
->getLatest();
1046 $content = $this->getContentObject( false ); # TODO: track content object?!
1047 if ( $content === false ) {
1050 $this->textbox1
= $this->toEditText( $content );
1052 // activate checkboxes if user wants them to be always active
1053 # Sort out the "watch" checkbox
1054 if ( $wgUser->getOption( 'watchdefault' ) ) {
1056 $this->watchthis
= true;
1057 } elseif ( $wgUser->getOption( 'watchcreations' ) && !$this->mTitle
->exists() ) {
1059 $this->watchthis
= true;
1060 } elseif ( $wgUser->isWatched( $this->mTitle
) ) {
1062 $this->watchthis
= true;
1064 if ( $wgUser->getOption( 'minordefault' ) && !$this->isNew
) {
1065 $this->minoredit
= true;
1067 if ( $this->textbox1
=== false ) {
1074 * @param Content|null $def_content The default value to return
1076 * @return Content|null Content on success, $def_content for invalid sections
1080 protected function getContentObject( $def_content = null ) {
1081 global $wgOut, $wgRequest, $wgUser, $wgContLang;
1085 // For message page not locally set, use the i18n message.
1086 // For other non-existent articles, use preload text if any.
1087 if ( !$this->mTitle
->exists() ||
$this->section
== 'new' ) {
1088 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
&& $this->section
!= 'new' ) {
1089 # If this is a system message, get the default text.
1090 $msg = $this->mTitle
->getDefaultMessageText();
1092 $content = $this->toEditContent( $msg );
1094 if ( $content === false ) {
1095 # If requested, preload some text.
1096 $preload = $wgRequest->getVal( 'preload',
1097 // Custom preload text for new sections
1098 $this->section
=== 'new' ?
'MediaWiki:addsection-preload' : '' );
1099 $params = $wgRequest->getArray( 'preloadparams', [] );
1101 $content = $this->getPreloadedContent( $preload, $params );
1103 // For existing pages, get text based on "undo" or section parameters.
1105 if ( $this->section
!= '' ) {
1106 // Get section edit text (returns $def_text for invalid sections)
1107 $orig = $this->getOriginalContent( $wgUser );
1108 $content = $orig ?
$orig->getSection( $this->section
) : null;
1111 $content = $def_content;
1114 $undoafter = $wgRequest->getInt( 'undoafter' );
1115 $undo = $wgRequest->getInt( 'undo' );
1117 if ( $undo > 0 && $undoafter > 0 ) {
1118 $undorev = Revision
::newFromId( $undo );
1119 $oldrev = Revision
::newFromId( $undoafter );
1121 # Sanity check, make sure it's the right page,
1122 # the revisions exist and they were not deleted.
1123 # Otherwise, $content will be left as-is.
1124 if ( !is_null( $undorev ) && !is_null( $oldrev ) &&
1125 !$undorev->isDeleted( Revision
::DELETED_TEXT
) &&
1126 !$oldrev->isDeleted( Revision
::DELETED_TEXT
)
1128 $content = $this->page
->getUndoContent( $undorev, $oldrev );
1130 if ( $content === false ) {
1131 # Warn the user that something went wrong
1132 $undoMsg = 'failure';
1134 $oldContent = $this->page
->getContent( Revision
::RAW
);
1135 $popts = ParserOptions
::newFromUserAndLang( $wgUser, $wgContLang );
1136 $newContent = $content->preSaveTransform( $this->mTitle
, $wgUser, $popts );
1138 if ( $newContent->equals( $oldContent ) ) {
1139 # Tell the user that the undo results in no change,
1140 # i.e. the revisions were already undone.
1141 $undoMsg = 'nochange';
1144 # Inform the user of our success and set an automatic edit summary
1145 $undoMsg = 'success';
1147 # If we just undid one rev, use an autosummary
1148 $firstrev = $oldrev->getNext();
1149 if ( $firstrev && $firstrev->getId() == $undo ) {
1150 $userText = $undorev->getUserText();
1151 if ( $userText === '' ) {
1152 $undoSummary = wfMessage(
1153 'undo-summary-username-hidden',
1155 )->inContentLanguage()->text();
1157 $undoSummary = wfMessage(
1161 )->inContentLanguage()->text();
1163 if ( $this->summary
=== '' ) {
1164 $this->summary
= $undoSummary;
1166 $this->summary
= $undoSummary . wfMessage( 'colon-separator' )
1167 ->inContentLanguage()->text() . $this->summary
;
1169 $this->undidRev
= $undo;
1171 $this->formtype
= 'diff';
1175 // Failed basic sanity checks.
1176 // Older revisions may have been removed since the link
1177 // was created, or we may simply have got bogus input.
1181 // Messages: undo-success, undo-failure, undo-norev, undo-nochange
1182 $class = ( $undoMsg == 'success' ?
'' : 'error ' ) . "mw-undo-{$undoMsg}";
1183 $this->editFormPageTop
.= $wgOut->parse( "<div class=\"{$class}\">" .
1184 wfMessage( 'undo-' . $undoMsg )->plain() . '</div>', true, /* interface */true );
1187 if ( $content === false ) {
1188 $content = $this->getOriginalContent( $wgUser );
1197 * Get the content of the wanted revision, without section extraction.
1199 * The result of this function can be used to compare user's input with
1200 * section replaced in its context (using WikiPage::replaceSectionAtRev())
1201 * to the original text of the edit.
1203 * This differs from Article::getContent() that when a missing revision is
1204 * encountered the result will be null and not the
1205 * 'missing-revision' message.
1208 * @param User $user The user to get the revision for
1209 * @return Content|null
1211 private function getOriginalContent( User
$user ) {
1212 if ( $this->section
== 'new' ) {
1213 return $this->getCurrentContent();
1215 $revision = $this->mArticle
->getRevisionFetched();
1216 if ( $revision === null ) {
1217 if ( !$this->contentModel
) {
1218 $this->contentModel
= $this->getTitle()->getContentModel();
1220 $handler = ContentHandler
::getForModelID( $this->contentModel
);
1222 return $handler->makeEmptyContent();
1224 $content = $revision->getContent( Revision
::FOR_THIS_USER
, $user );
1229 * Get the edit's parent revision ID
1231 * The "parent" revision is the ancestor that should be recorded in this
1232 * page's revision history. It is either the revision ID of the in-memory
1233 * article content, or in the case of a 3-way merge in order to rebase
1234 * across a recoverable edit conflict, the ID of the newer revision to
1235 * which we have rebased this page.
1238 * @return int Revision ID
1240 public function getParentRevId() {
1241 if ( $this->parentRevId
) {
1242 return $this->parentRevId
;
1244 return $this->mArticle
->getRevIdFetched();
1249 * Get the current content of the page. This is basically similar to
1250 * WikiPage::getContent( Revision::RAW ) except that when the page doesn't exist an empty
1251 * content object is returned instead of null.
1256 protected function getCurrentContent() {
1257 $rev = $this->page
->getRevision();
1258 $content = $rev ?
$rev->getContent( Revision
::RAW
) : null;
1260 if ( $content === false ||
$content === null ) {
1261 if ( !$this->contentModel
) {
1262 $this->contentModel
= $this->getTitle()->getContentModel();
1264 $handler = ContentHandler
::getForModelID( $this->contentModel
);
1266 return $handler->makeEmptyContent();
1268 // Content models should always be the same since we error
1269 // out if they are different before this point.
1270 $logger = LoggerFactory
::getInstance( 'editpage' );
1271 if ( $this->contentModel
!== $rev->getContentModel() ) {
1272 $logger->warning( "Overriding content model from current edit {prev} to {new}", [
1273 'prev' => $this->contentModel
,
1274 'new' => $rev->getContentModel(),
1275 'title' => $this->getTitle()->getPrefixedDBkey(),
1276 'method' => __METHOD__
1278 $this->contentModel
= $rev->getContentModel();
1281 // Given that the content models should match, the current selected
1282 // format should be supported.
1283 if ( !$content->isSupportedFormat( $this->contentFormat
) ) {
1284 $logger->warning( "Current revision content format unsupported. Overriding {prev} to {new}", [
1286 'prev' => $this->contentFormat
,
1287 'new' => $rev->getContentFormat(),
1288 'title' => $this->getTitle()->getPrefixedDBkey(),
1289 'method' => __METHOD__
1291 $this->contentFormat
= $rev->getContentFormat();
1299 * Use this method before edit() to preload some content into the edit box
1301 * @param Content $content
1305 public function setPreloadedContent( Content
$content ) {
1306 $this->mPreloadContent
= $content;
1310 * Get the contents to be preloaded into the box, either set by
1311 * an earlier setPreloadText() or by loading the given page.
1313 * @param string $preload Representing the title to preload from.
1314 * @param array $params Parameters to use (interface-message style) in the preloaded text
1320 protected function getPreloadedContent( $preload, $params = [] ) {
1323 if ( !empty( $this->mPreloadContent
) ) {
1324 return $this->mPreloadContent
;
1327 $handler = ContentHandler
::getForModelID( $this->contentModel
);
1329 if ( $preload === '' ) {
1330 return $handler->makeEmptyContent();
1333 $title = Title
::newFromText( $preload );
1334 # Check for existence to avoid getting MediaWiki:Noarticletext
1335 if ( $title === null ||
!$title->exists() ||
!$title->userCan( 'read', $wgUser ) ) {
1336 // TODO: somehow show a warning to the user!
1337 return $handler->makeEmptyContent();
1340 $page = WikiPage
::factory( $title );
1341 if ( $page->isRedirect() ) {
1342 $title = $page->getRedirectTarget();
1344 if ( $title === null ||
!$title->exists() ||
!$title->userCan( 'read', $wgUser ) ) {
1345 // TODO: somehow show a warning to the user!
1346 return $handler->makeEmptyContent();
1348 $page = WikiPage
::factory( $title );
1351 $parserOptions = ParserOptions
::newFromUser( $wgUser );
1352 $content = $page->getContent( Revision
::RAW
);
1355 // TODO: somehow show a warning to the user!
1356 return $handler->makeEmptyContent();
1359 if ( $content->getModel() !== $handler->getModelID() ) {
1360 $converted = $content->convert( $handler->getModelID() );
1362 if ( !$converted ) {
1363 // TODO: somehow show a warning to the user!
1364 wfDebug( "Attempt to preload incompatible content: " .
1365 "can't convert " . $content->getModel() .
1366 " to " . $handler->getModelID() );
1368 return $handler->makeEmptyContent();
1371 $content = $converted;
1374 return $content->preloadTransform( $title, $parserOptions, $params );
1378 * Make sure the form isn't faking a user's credentials.
1380 * @param WebRequest $request
1384 function tokenOk( &$request ) {
1386 $token = $request->getVal( 'wpEditToken' );
1387 $this->mTokenOk
= $wgUser->matchEditToken( $token );
1388 $this->mTokenOkExceptSuffix
= $wgUser->matchEditTokenNoSuffix( $token );
1389 return $this->mTokenOk
;
1393 * Sets post-edit cookie indicating the user just saved a particular revision.
1395 * This uses a temporary cookie for each revision ID so separate saves will never
1396 * interfere with each other.
1398 * The cookie is deleted in the mediawiki.action.view.postEdit JS module after
1399 * the redirect. It must be clearable by JavaScript code, so it must not be
1400 * marked HttpOnly. The JavaScript code converts the cookie to a wgPostEdit config
1403 * If the variable were set on the server, it would be cached, which is unwanted
1404 * since the post-edit state should only apply to the load right after the save.
1406 * @param int $statusValue The status value (to check for new article status)
1408 protected function setPostEditCookie( $statusValue ) {
1409 $revisionId = $this->page
->getLatest();
1410 $postEditKey = self
::POST_EDIT_COOKIE_KEY_PREFIX
. $revisionId;
1413 if ( $statusValue == self
::AS_SUCCESS_NEW_ARTICLE
) {
1415 } elseif ( $this->oldid
) {
1419 $response = RequestContext
::getMain()->getRequest()->response();
1420 $response->setCookie( $postEditKey, $val, time() + self
::POST_EDIT_COOKIE_DURATION
, [
1421 'httpOnly' => false,
1426 * Attempt submission
1427 * @param array|bool $resultDetails See docs for $result in internalAttemptSave
1428 * @throws UserBlockedError|ReadOnlyError|ThrottledError|PermissionsError
1429 * @return Status The resulting status object.
1431 public function attemptSave( &$resultDetails = false ) {
1434 # Allow bots to exempt some edits from bot flagging
1435 $bot = $wgUser->isAllowed( 'bot' ) && $this->bot
;
1436 $status = $this->internalAttemptSave( $resultDetails, $bot );
1438 Hooks
::run( 'EditPage::attemptSave:after', [ $this, $status, $resultDetails ] );
1444 * Handle status, such as after attempt save
1446 * @param Status $status
1447 * @param array|bool $resultDetails
1449 * @throws ErrorPageError
1450 * @return bool False, if output is done, true if rest of the form should be displayed
1452 private function handleStatus( Status
$status, $resultDetails ) {
1453 global $wgUser, $wgOut;
1456 * @todo FIXME: once the interface for internalAttemptSave() is made
1457 * nicer, this should use the message in $status
1459 if ( $status->value
== self
::AS_SUCCESS_UPDATE
1460 ||
$status->value
== self
::AS_SUCCESS_NEW_ARTICLE
1462 $this->didSave
= true;
1463 if ( !$resultDetails['nullEdit'] ) {
1464 $this->setPostEditCookie( $status->value
);
1468 // "wpExtraQueryRedirect" is a hidden input to modify
1469 // after save URL and is not used by actual edit form
1470 $request = RequestContext
::getMain()->getRequest();
1471 $extraQueryRedirect = $request->getVal( 'wpExtraQueryRedirect' );
1473 switch ( $status->value
) {
1474 case self
::AS_HOOK_ERROR_EXPECTED
:
1475 case self
::AS_CONTENT_TOO_BIG
:
1476 case self
::AS_ARTICLE_WAS_DELETED
:
1477 case self
::AS_CONFLICT_DETECTED
:
1478 case self
::AS_SUMMARY_NEEDED
:
1479 case self
::AS_TEXTBOX_EMPTY
:
1480 case self
::AS_MAX_ARTICLE_SIZE_EXCEEDED
:
1482 case self
::AS_BLANK_ARTICLE
:
1483 case self
::AS_SELF_REDIRECT
:
1486 case self
::AS_HOOK_ERROR
:
1489 case self
::AS_CANNOT_USE_CUSTOM_MODEL
:
1490 case self
::AS_PARSE_ERROR
:
1491 $wgOut->addWikiText( '<div class="error">' . "\n" . $status->getWikiText() . '</div>' );
1494 case self
::AS_SUCCESS_NEW_ARTICLE
:
1495 $query = $resultDetails['redirect'] ?
'redirect=no' : '';
1496 if ( $extraQueryRedirect ) {
1497 if ( $query === '' ) {
1498 $query = $extraQueryRedirect;
1500 $query = $query . '&' . $extraQueryRedirect;
1503 $anchor = isset( $resultDetails['sectionanchor'] ) ?
$resultDetails['sectionanchor'] : '';
1504 $wgOut->redirect( $this->mTitle
->getFullURL( $query ) . $anchor );
1507 case self
::AS_SUCCESS_UPDATE
:
1509 $sectionanchor = $resultDetails['sectionanchor'];
1511 // Give extensions a chance to modify URL query on update
1513 'ArticleUpdateBeforeRedirect',
1514 [ $this->mArticle
, &$sectionanchor, &$extraQuery ]
1517 if ( $resultDetails['redirect'] ) {
1518 if ( $extraQuery == '' ) {
1519 $extraQuery = 'redirect=no';
1521 $extraQuery = 'redirect=no&' . $extraQuery;
1524 if ( $extraQueryRedirect ) {
1525 if ( $extraQuery === '' ) {
1526 $extraQuery = $extraQueryRedirect;
1528 $extraQuery = $extraQuery . '&' . $extraQueryRedirect;
1532 $wgOut->redirect( $this->mTitle
->getFullURL( $extraQuery ) . $sectionanchor );
1535 case self
::AS_SPAM_ERROR
:
1536 $this->spamPageWithContent( $resultDetails['spam'] );
1539 case self
::AS_BLOCKED_PAGE_FOR_USER
:
1540 throw new UserBlockedError( $wgUser->getBlock() );
1542 case self
::AS_IMAGE_REDIRECT_ANON
:
1543 case self
::AS_IMAGE_REDIRECT_LOGGED
:
1544 throw new PermissionsError( 'upload' );
1546 case self
::AS_READ_ONLY_PAGE_ANON
:
1547 case self
::AS_READ_ONLY_PAGE_LOGGED
:
1548 throw new PermissionsError( 'edit' );
1550 case self
::AS_READ_ONLY_PAGE
:
1551 throw new ReadOnlyError
;
1553 case self
::AS_RATE_LIMITED
:
1554 throw new ThrottledError();
1556 case self
::AS_NO_CREATE_PERMISSION
:
1557 $permission = $this->mTitle
->isTalkPage() ?
'createtalk' : 'createpage';
1558 throw new PermissionsError( $permission );
1560 case self
::AS_NO_CHANGE_CONTENT_MODEL
:
1561 throw new PermissionsError( 'editcontentmodel' );
1564 // We don't recognize $status->value. The only way that can happen
1565 // is if an extension hook aborted from inside ArticleSave.
1566 // Render the status object into $this->hookError
1567 // FIXME this sucks, we should just use the Status object throughout
1568 $this->hookError
= '<div class="error">' ."\n" . $status->getWikiText() .
1575 * Run hooks that can filter edits just before they get saved.
1577 * @param Content $content The Content to filter.
1578 * @param Status $status For reporting the outcome to the caller
1579 * @param User $user The user performing the edit
1583 protected function runPostMergeFilters( Content
$content, Status
$status, User
$user ) {
1584 // Run old style post-section-merge edit filter
1585 if ( !ContentHandler
::runLegacyHooks( 'EditFilterMerged',
1586 [ $this, $content, &$this->hookError
, $this->summary
] )
1588 # Error messages etc. could be handled within the hook...
1589 $status->fatal( 'hookaborted' );
1590 $status->value
= self
::AS_HOOK_ERROR
;
1592 } elseif ( $this->hookError
!= '' ) {
1593 # ...or the hook could be expecting us to produce an error
1594 $status->fatal( 'hookaborted' );
1595 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1599 // Run new style post-section-merge edit filter
1600 if ( !Hooks
::run( 'EditFilterMergedContent',
1601 [ $this->mArticle
->getContext(), $content, $status, $this->summary
,
1602 $user, $this->minoredit
] )
1604 # Error messages etc. could be handled within the hook...
1605 if ( $status->isGood() ) {
1606 $status->fatal( 'hookaborted' );
1607 // Not setting $this->hookError here is a hack to allow the hook
1608 // to cause a return to the edit page without $this->hookError
1609 // being set. This is used by ConfirmEdit to display a captcha
1610 // without any error message cruft.
1612 $this->hookError
= $status->getWikiText();
1614 // Use the existing $status->value if the hook set it
1615 if ( !$status->value
) {
1616 $status->value
= self
::AS_HOOK_ERROR
;
1619 } elseif ( !$status->isOK() ) {
1620 # ...or the hook could be expecting us to produce an error
1621 // FIXME this sucks, we should just use the Status object throughout
1622 $this->hookError
= $status->getWikiText();
1623 $status->fatal( 'hookaborted' );
1624 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1632 * Return the summary to be used for a new section.
1634 * @param string $sectionanchor Set to the section anchor text
1637 private function newSectionSummary( &$sectionanchor = null ) {
1640 if ( $this->sectiontitle
!== '' ) {
1641 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $this->sectiontitle
);
1642 // If no edit summary was specified, create one automatically from the section
1643 // title and have it link to the new section. Otherwise, respect the summary as
1645 if ( $this->summary
=== '' ) {
1646 $cleanSectionTitle = $wgParser->stripSectionName( $this->sectiontitle
);
1647 return wfMessage( 'newsectionsummary' )
1648 ->rawParams( $cleanSectionTitle )->inContentLanguage()->text();
1650 } elseif ( $this->summary
!== '' ) {
1651 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $this->summary
);
1652 # This is a new section, so create a link to the new section
1653 # in the revision summary.
1654 $cleanSummary = $wgParser->stripSectionName( $this->summary
);
1655 return wfMessage( 'newsectionsummary' )
1656 ->rawParams( $cleanSummary )->inContentLanguage()->text();
1658 return $this->summary
;
1662 * Attempt submission (no UI)
1664 * @param array $result Array to add statuses to, currently with the
1666 * - spam (string): Spam string from content if any spam is detected by
1668 * - sectionanchor (string): Section anchor for a section save.
1669 * - nullEdit (boolean): Set if doEditContent is OK. True if null edit,
1671 * - redirect (bool): Set if doEditContent is OK. True if resulting
1672 * revision is a redirect.
1673 * @param bool $bot True if edit is being made under the bot right.
1675 * @return Status Status object, possibly with a message, but always with
1676 * one of the AS_* constants in $status->value,
1678 * @todo FIXME: This interface is TERRIBLE, but hard to get rid of due to
1679 * various error display idiosyncrasies. There are also lots of cases
1680 * where error metadata is set in the object and retrieved later instead
1681 * of being returned, e.g. AS_CONTENT_TOO_BIG and
1682 * AS_BLOCKED_PAGE_FOR_USER. All that stuff needs to be cleaned up some
1685 function internalAttemptSave( &$result, $bot = false ) {
1686 global $wgUser, $wgRequest, $wgParser, $wgMaxArticleSize;
1687 global $wgContentHandlerUseDB;
1689 $status = Status
::newGood();
1691 if ( !Hooks
::run( 'EditPage::attemptSave', [ $this ] ) ) {
1692 wfDebug( "Hook 'EditPage::attemptSave' aborted article saving\n" );
1693 $status->fatal( 'hookaborted' );
1694 $status->value
= self
::AS_HOOK_ERROR
;
1698 $spam = $wgRequest->getText( 'wpAntispam' );
1699 if ( $spam !== '' ) {
1702 $wgUser->getName() .
1704 $this->mTitle
->getPrefixedText() .
1705 '" submitted bogus field "' .
1709 $status->fatal( 'spamprotectionmatch', false );
1710 $status->value
= self
::AS_SPAM_ERROR
;
1715 # Construct Content object
1716 $textbox_content = $this->toEditContent( $this->textbox1
);
1717 } catch ( MWContentSerializationException
$ex ) {
1719 'content-failed-to-parse',
1720 $this->contentModel
,
1721 $this->contentFormat
,
1724 $status->value
= self
::AS_PARSE_ERROR
;
1728 # Check image redirect
1729 if ( $this->mTitle
->getNamespace() == NS_FILE
&&
1730 $textbox_content->isRedirect() &&
1731 !$wgUser->isAllowed( 'upload' )
1733 $code = $wgUser->isAnon() ? self
::AS_IMAGE_REDIRECT_ANON
: self
::AS_IMAGE_REDIRECT_LOGGED
;
1734 $status->setResult( false, $code );
1740 $match = self
::matchSummarySpamRegex( $this->summary
);
1741 if ( $match === false && $this->section
== 'new' ) {
1742 # $wgSpamRegex is enforced on this new heading/summary because, unlike
1743 # regular summaries, it is added to the actual wikitext.
1744 if ( $this->sectiontitle
!== '' ) {
1745 # This branch is taken when the API is used with the 'sectiontitle' parameter.
1746 $match = self
::matchSpamRegex( $this->sectiontitle
);
1748 # This branch is taken when the "Add Topic" user interface is used, or the API
1749 # is used with the 'summary' parameter.
1750 $match = self
::matchSpamRegex( $this->summary
);
1753 if ( $match === false ) {
1754 $match = self
::matchSpamRegex( $this->textbox1
);
1756 if ( $match !== false ) {
1757 $result['spam'] = $match;
1758 $ip = $wgRequest->getIP();
1759 $pdbk = $this->mTitle
->getPrefixedDBkey();
1760 $match = str_replace( "\n", '', $match );
1761 wfDebugLog( 'SpamRegex', "$ip spam regex hit [[$pdbk]]: \"$match\"" );
1762 $status->fatal( 'spamprotectionmatch', $match );
1763 $status->value
= self
::AS_SPAM_ERROR
;
1768 [ $this, $this->textbox1
, $this->section
, &$this->hookError
, $this->summary
] )
1770 # Error messages etc. could be handled within the hook...
1771 $status->fatal( 'hookaborted' );
1772 $status->value
= self
::AS_HOOK_ERROR
;
1774 } elseif ( $this->hookError
!= '' ) {
1775 # ...or the hook could be expecting us to produce an error
1776 $status->fatal( 'hookaborted' );
1777 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1781 if ( $wgUser->isBlockedFrom( $this->mTitle
, false ) ) {
1782 // Auto-block user's IP if the account was "hard" blocked
1783 if ( !wfReadOnly() ) {
1784 $wgUser->spreadAnyEditBlock();
1786 # Check block state against master, thus 'false'.
1787 $status->setResult( false, self
::AS_BLOCKED_PAGE_FOR_USER
);
1791 $this->contentLength
= strlen( $this->textbox1
);
1792 if ( $this->contentLength
> $wgMaxArticleSize * 1024 ) {
1793 // Error will be displayed by showEditForm()
1794 $this->tooBig
= true;
1795 $status->setResult( false, self
::AS_CONTENT_TOO_BIG
);
1799 if ( !$wgUser->isAllowed( 'edit' ) ) {
1800 if ( $wgUser->isAnon() ) {
1801 $status->setResult( false, self
::AS_READ_ONLY_PAGE_ANON
);
1804 $status->fatal( 'readonlytext' );
1805 $status->value
= self
::AS_READ_ONLY_PAGE_LOGGED
;
1810 $changingContentModel = false;
1811 if ( $this->contentModel
!== $this->mTitle
->getContentModel() ) {
1812 if ( !$wgContentHandlerUseDB ) {
1813 $status->fatal( 'editpage-cannot-use-custom-model' );
1814 $status->value
= self
::AS_CANNOT_USE_CUSTOM_MODEL
;
1816 } elseif ( !$wgUser->isAllowed( 'editcontentmodel' ) ) {
1817 $status->setResult( false, self
::AS_NO_CHANGE_CONTENT_MODEL
);
1821 $changingContentModel = true;
1822 $oldContentModel = $this->mTitle
->getContentModel();
1825 if ( $this->changeTags
) {
1826 $changeTagsStatus = ChangeTags
::canAddTagsAccompanyingChange(
1827 $this->changeTags
, $wgUser );
1828 if ( !$changeTagsStatus->isOK() ) {
1829 $changeTagsStatus->value
= self
::AS_CHANGE_TAG_ERROR
;
1830 return $changeTagsStatus;
1834 if ( wfReadOnly() ) {
1835 $status->fatal( 'readonlytext' );
1836 $status->value
= self
::AS_READ_ONLY_PAGE
;
1839 if ( $wgUser->pingLimiter() ||
$wgUser->pingLimiter( 'linkpurge', 0 ) ) {
1840 $status->fatal( 'actionthrottledtext' );
1841 $status->value
= self
::AS_RATE_LIMITED
;
1845 # If the article has been deleted while editing, don't save it without
1847 if ( $this->wasDeletedSinceLastEdit() && !$this->recreate
) {
1848 $status->setResult( false, self
::AS_ARTICLE_WAS_DELETED
);
1852 # Load the page data from the master. If anything changes in the meantime,
1853 # we detect it by using page_latest like a token in a 1 try compare-and-swap.
1854 $this->page
->loadPageData( 'fromdbmaster' );
1855 $new = !$this->page
->exists();
1858 // Late check for create permission, just in case *PARANOIA*
1859 if ( !$this->mTitle
->userCan( 'create', $wgUser ) ) {
1860 $status->fatal( 'nocreatetext' );
1861 $status->value
= self
::AS_NO_CREATE_PERMISSION
;
1862 wfDebug( __METHOD__
. ": no create permission\n" );
1866 // Don't save a new page if it's blank or if it's a MediaWiki:
1867 // message with content equivalent to default (allow empty pages
1868 // in this case to disable messages, see bug 50124)
1869 $defaultMessageText = $this->mTitle
->getDefaultMessageText();
1870 if ( $this->mTitle
->getNamespace() === NS_MEDIAWIKI
&& $defaultMessageText !== false ) {
1871 $defaultText = $defaultMessageText;
1876 if ( !$this->allowBlankArticle
&& $this->textbox1
=== $defaultText ) {
1877 $this->blankArticle
= true;
1878 $status->fatal( 'blankarticle' );
1879 $status->setResult( false, self
::AS_BLANK_ARTICLE
);
1883 if ( !$this->runPostMergeFilters( $textbox_content, $status, $wgUser ) ) {
1887 $content = $textbox_content;
1889 $result['sectionanchor'] = '';
1890 if ( $this->section
== 'new' ) {
1891 if ( $this->sectiontitle
!== '' ) {
1892 // Insert the section title above the content.
1893 $content = $content->addSectionHeader( $this->sectiontitle
);
1894 } elseif ( $this->summary
!== '' ) {
1895 // Insert the section title above the content.
1896 $content = $content->addSectionHeader( $this->summary
);
1898 $this->summary
= $this->newSectionSummary( $result['sectionanchor'] );
1901 $status->value
= self
::AS_SUCCESS_NEW_ARTICLE
;
1905 # Article exists. Check for edit conflict.
1907 $this->page
->clear(); # Force reload of dates, etc.
1908 $timestamp = $this->page
->getTimestamp();
1909 $latest = $this->page
->getLatest();
1911 wfDebug( "timestamp: {$timestamp}, edittime: {$this->edittime}\n" );
1913 // Check editRevId if set, which handles same-second timestamp collisions
1914 if ( $timestamp != $this->edittime
1915 ||
( $this->editRevId
!== null && $this->editRevId
!= $latest )
1917 $this->isConflict
= true;
1918 if ( $this->section
== 'new' ) {
1919 if ( $this->page
->getUserText() == $wgUser->getName() &&
1920 $this->page
->getComment() == $this->newSectionSummary()
1922 // Probably a duplicate submission of a new comment.
1923 // This can happen when CDN resends a request after
1924 // a timeout but the first one actually went through.
1926 . ": duplicate new section submission; trigger edit conflict!\n" );
1928 // New comment; suppress conflict.
1929 $this->isConflict
= false;
1930 wfDebug( __METHOD__
. ": conflict suppressed; new section\n" );
1932 } elseif ( $this->section
== ''
1933 && Revision
::userWasLastToEdit(
1934 DB_MASTER
, $this->mTitle
->getArticleID(),
1935 $wgUser->getId(), $this->edittime
1938 # Suppress edit conflict with self, except for section edits where merging is required.
1939 wfDebug( __METHOD__
. ": Suppressing edit conflict, same user.\n" );
1940 $this->isConflict
= false;
1944 // If sectiontitle is set, use it, otherwise use the summary as the section title.
1945 if ( $this->sectiontitle
!== '' ) {
1946 $sectionTitle = $this->sectiontitle
;
1948 $sectionTitle = $this->summary
;
1953 if ( $this->isConflict
) {
1955 . ": conflict! getting section '{$this->section}' for time '{$this->edittime}'"
1956 . " (id '{$this->editRevId}') (article time '{$timestamp}')\n" );
1957 // @TODO: replaceSectionAtRev() with base ID (not prior current) for ?oldid=X case
1958 // ...or disable section editing for non-current revisions (not exposed anyway).
1959 if ( $this->editRevId
!== null ) {
1960 $content = $this->page
->replaceSectionAtRev(
1967 $content = $this->page
->replaceSectionContent(
1975 wfDebug( __METHOD__
. ": getting section '{$this->section}'\n" );
1976 $content = $this->page
->replaceSectionContent(
1983 if ( is_null( $content ) ) {
1984 wfDebug( __METHOD__
. ": activating conflict; section replace failed.\n" );
1985 $this->isConflict
= true;
1986 $content = $textbox_content; // do not try to merge here!
1987 } elseif ( $this->isConflict
) {
1989 if ( $this->mergeChangesIntoContent( $content ) ) {
1990 // Successful merge! Maybe we should tell the user the good news?
1991 $this->isConflict
= false;
1992 wfDebug( __METHOD__
. ": Suppressing edit conflict, successful merge.\n" );
1994 $this->section
= '';
1995 $this->textbox1
= ContentHandler
::getContentText( $content );
1996 wfDebug( __METHOD__
. ": Keeping edit conflict, failed merge.\n" );
2000 if ( $this->isConflict
) {
2001 $status->setResult( false, self
::AS_CONFLICT_DETECTED
);
2005 if ( !$this->runPostMergeFilters( $content, $status, $wgUser ) ) {
2009 if ( $this->section
== 'new' ) {
2010 // Handle the user preference to force summaries here
2011 if ( !$this->allowBlankSummary
&& trim( $this->summary
) == '' ) {
2012 $this->missingSummary
= true;
2013 $status->fatal( 'missingsummary' ); // or 'missingcommentheader' if $section == 'new'. Blegh
2014 $status->value
= self
::AS_SUMMARY_NEEDED
;
2018 // Do not allow the user to post an empty comment
2019 if ( $this->textbox1
== '' ) {
2020 $this->missingComment
= true;
2021 $status->fatal( 'missingcommenttext' );
2022 $status->value
= self
::AS_TEXTBOX_EMPTY
;
2025 } elseif ( !$this->allowBlankSummary
2026 && !$content->equals( $this->getOriginalContent( $wgUser ) )
2027 && !$content->isRedirect()
2028 && md5( $this->summary
) == $this->autoSumm
2030 $this->missingSummary
= true;
2031 $status->fatal( 'missingsummary' );
2032 $status->value
= self
::AS_SUMMARY_NEEDED
;
2037 $sectionanchor = '';
2038 if ( $this->section
== 'new' ) {
2039 $this->summary
= $this->newSectionSummary( $sectionanchor );
2040 } elseif ( $this->section
!= '' ) {
2041 # Try to get a section anchor from the section source, redirect
2042 # to edited section if header found.
2043 # XXX: Might be better to integrate this into Article::replaceSectionAtRev
2044 # for duplicate heading checking and maybe parsing.
2045 $hasmatch = preg_match( "/^ *([=]{1,6})(.*?)(\\1) *\\n/i", $this->textbox1
, $matches );
2046 # We can't deal with anchors, includes, html etc in the header for now,
2047 # headline would need to be parsed to improve this.
2048 if ( $hasmatch && strlen( $matches[2] ) > 0 ) {
2049 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $matches[2] );
2052 $result['sectionanchor'] = $sectionanchor;
2054 // Save errors may fall down to the edit form, but we've now
2055 // merged the section into full text. Clear the section field
2056 // so that later submission of conflict forms won't try to
2057 // replace that into a duplicated mess.
2058 $this->textbox1
= $this->toEditText( $content );
2059 $this->section
= '';
2061 $status->value
= self
::AS_SUCCESS_UPDATE
;
2064 if ( !$this->allowSelfRedirect
2065 && $content->isRedirect()
2066 && $content->getRedirectTarget()->equals( $this->getTitle() )
2068 // If the page already redirects to itself, don't warn.
2069 $currentTarget = $this->getCurrentContent()->getRedirectTarget();
2070 if ( !$currentTarget ||
!$currentTarget->equals( $this->getTitle() ) ) {
2071 $this->selfRedirect
= true;
2072 $status->fatal( 'selfredirect' );
2073 $status->value
= self
::AS_SELF_REDIRECT
;
2078 // Check for length errors again now that the section is merged in
2079 $this->contentLength
= strlen( $this->toEditText( $content ) );
2080 if ( $this->contentLength
> $wgMaxArticleSize * 1024 ) {
2081 $this->tooBig
= true;
2082 $status->setResult( false, self
::AS_MAX_ARTICLE_SIZE_EXCEEDED
);
2086 $flags = EDIT_AUTOSUMMARY |
2087 ( $new ? EDIT_NEW
: EDIT_UPDATE
) |
2088 ( ( $this->minoredit
&& !$this->isNew
) ? EDIT_MINOR
: 0 ) |
2089 ( $bot ? EDIT_FORCE_BOT
: 0 );
2091 $doEditStatus = $this->page
->doEditContent(
2097 $content->getDefaultFormat(),
2101 if ( !$doEditStatus->isOK() ) {
2102 // Failure from doEdit()
2103 // Show the edit conflict page for certain recognized errors from doEdit(),
2104 // but don't show it for errors from extension hooks
2105 $errors = $doEditStatus->getErrorsArray();
2106 if ( in_array( $errors[0][0],
2107 [ 'edit-gone-missing', 'edit-conflict', 'edit-already-exists' ] )
2109 $this->isConflict
= true;
2110 // Destroys data doEdit() put in $status->value but who cares
2111 $doEditStatus->value
= self
::AS_END
;
2113 return $doEditStatus;
2116 $result['nullEdit'] = $doEditStatus->hasMessage( 'edit-no-change' );
2117 if ( $result['nullEdit'] ) {
2118 // We don't know if it was a null edit until now, so increment here
2119 $wgUser->pingLimiter( 'linkpurge' );
2121 $result['redirect'] = $content->isRedirect();
2123 $this->updateWatchlist();
2125 // If the content model changed, add a log entry
2126 if ( $changingContentModel ) {
2127 $this->addContentModelChangeLogEntry(
2129 $new ?
false : $oldContentModel,
2130 $this->contentModel
,
2140 * @param string|false $oldModel false if the page is being newly created
2141 * @param string $newModel
2142 * @param string $reason
2144 protected function addContentModelChangeLogEntry( User
$user, $oldModel, $newModel, $reason ) {
2145 $new = $oldModel === false;
2146 $log = new ManualLogEntry( 'contentmodel', $new ?
'new' : 'change' );
2147 $log->setPerformer( $user );
2148 $log->setTarget( $this->mTitle
);
2149 $log->setComment( $reason );
2150 $log->setParameters( [
2151 '4::oldmodel' => $oldModel,
2152 '5::newmodel' => $newModel
2154 $logid = $log->insert();
2155 $log->publish( $logid );
2159 * Register the change of watch status
2161 protected function updateWatchlist() {
2164 if ( !$wgUser->isLoggedIn() ) {
2169 $title = $this->mTitle
;
2170 $watch = $this->watchthis
;
2171 // Do this in its own transaction to reduce contention...
2172 DeferredUpdates
::addCallableUpdate( function () use ( $user, $title, $watch ) {
2173 if ( $watch == $user->isWatched( $title, User
::IGNORE_USER_RIGHTS
) ) {
2174 return; // nothing to change
2176 WatchAction
::doWatchOrUnwatch( $watch, $title, $user );
2181 * Attempts to do 3-way merge of edit content with a base revision
2182 * and current content, in case of edit conflict, in whichever way appropriate
2183 * for the content type.
2187 * @param Content $editContent
2191 private function mergeChangesIntoContent( &$editContent ) {
2193 $db = wfGetDB( DB_MASTER
);
2195 // This is the revision the editor started from
2196 $baseRevision = $this->getBaseRevision();
2197 $baseContent = $baseRevision ?
$baseRevision->getContent() : null;
2199 if ( is_null( $baseContent ) ) {
2203 // The current state, we want to merge updates into it
2204 $currentRevision = Revision
::loadFromTitle( $db, $this->mTitle
);
2205 $currentContent = $currentRevision ?
$currentRevision->getContent() : null;
2207 if ( is_null( $currentContent ) ) {
2211 $handler = ContentHandler
::getForModelID( $baseContent->getModel() );
2213 $result = $handler->merge3( $baseContent, $editContent, $currentContent );
2216 $editContent = $result;
2217 // Update parentRevId to what we just merged.
2218 $this->parentRevId
= $currentRevision->getId();
2226 * @note: this method is very poorly named. If the user opened the form with ?oldid=X,
2227 * one might think of X as the "base revision", which is NOT what this returns.
2228 * @return Revision Current version when the edit was started
2230 function getBaseRevision() {
2231 if ( !$this->mBaseRevision
) {
2232 $db = wfGetDB( DB_MASTER
);
2233 $this->mBaseRevision
= $this->editRevId
2234 ? Revision
::newFromId( $this->editRevId
, Revision
::READ_LATEST
)
2235 : Revision
::loadFromTimestamp( $db, $this->mTitle
, $this->edittime
);
2237 return $this->mBaseRevision
;
2241 * Check given input text against $wgSpamRegex, and return the text of the first match.
2243 * @param string $text
2245 * @return string|bool Matching string or false
2247 public static function matchSpamRegex( $text ) {
2248 global $wgSpamRegex;
2249 // For back compatibility, $wgSpamRegex may be a single string or an array of regexes.
2250 $regexes = (array)$wgSpamRegex;
2251 return self
::matchSpamRegexInternal( $text, $regexes );
2255 * Check given input text against $wgSummarySpamRegex, and return the text of the first match.
2257 * @param string $text
2259 * @return string|bool Matching string or false
2261 public static function matchSummarySpamRegex( $text ) {
2262 global $wgSummarySpamRegex;
2263 $regexes = (array)$wgSummarySpamRegex;
2264 return self
::matchSpamRegexInternal( $text, $regexes );
2268 * @param string $text
2269 * @param array $regexes
2270 * @return bool|string
2272 protected static function matchSpamRegexInternal( $text, $regexes ) {
2273 foreach ( $regexes as $regex ) {
2275 if ( preg_match( $regex, $text, $matches ) ) {
2282 function setHeaders() {
2283 global $wgOut, $wgUser, $wgAjaxEditStash;
2285 $wgOut->addModules( 'mediawiki.action.edit' );
2286 $wgOut->addModuleStyles( 'mediawiki.action.edit.styles' );
2288 if ( $wgUser->getOption( 'showtoolbar' ) ) {
2289 // The addition of default buttons is handled by getEditToolbar() which
2290 // has its own dependency on this module. The call here ensures the module
2291 // is loaded in time (it has position "top") for other modules to register
2292 // buttons (e.g. extensions, gadgets, user scripts).
2293 $wgOut->addModules( 'mediawiki.toolbar' );
2296 if ( $wgUser->getOption( 'uselivepreview' ) ) {
2297 $wgOut->addModules( 'mediawiki.action.edit.preview' );
2300 if ( $wgUser->getOption( 'useeditwarning' ) ) {
2301 $wgOut->addModules( 'mediawiki.action.edit.editWarning' );
2304 # Enabled article-related sidebar, toplinks, etc.
2305 $wgOut->setArticleRelated( true );
2307 $contextTitle = $this->getContextTitle();
2308 if ( $this->isConflict
) {
2309 $msg = 'editconflict';
2310 } elseif ( $contextTitle->exists() && $this->section
!= '' ) {
2311 $msg = $this->section
== 'new' ?
'editingcomment' : 'editingsection';
2313 $msg = $contextTitle->exists()
2314 ||
( $contextTitle->getNamespace() == NS_MEDIAWIKI
2315 && $contextTitle->getDefaultMessageText() !== false
2321 # Use the title defined by DISPLAYTITLE magic word when present
2322 # NOTE: getDisplayTitle() returns HTML while getPrefixedText() returns plain text.
2323 # setPageTitle() treats the input as wikitext, which should be safe in either case.
2324 $displayTitle = isset( $this->mParserOutput
) ?
$this->mParserOutput
->getDisplayTitle() : false;
2325 if ( $displayTitle === false ) {
2326 $displayTitle = $contextTitle->getPrefixedText();
2328 $wgOut->setPageTitle( wfMessage( $msg, $displayTitle ) );
2329 # Transmit the name of the message to JavaScript for live preview
2330 # Keep Resources.php/mediawiki.action.edit.preview in sync with the possible keys
2331 $wgOut->addJsConfigVars( [
2332 'wgEditMessage' => $msg,
2333 'wgAjaxEditStash' => $wgAjaxEditStash,
2338 * Show all applicable editing introductions
2340 protected function showIntro() {
2341 global $wgOut, $wgUser;
2342 if ( $this->suppressIntro
) {
2346 $namespace = $this->mTitle
->getNamespace();
2348 if ( $namespace == NS_MEDIAWIKI
) {
2349 # Show a warning if editing an interface message
2350 $wgOut->wrapWikiMsg( "<div class='mw-editinginterface'>\n$1\n</div>", 'editinginterface' );
2351 # If this is a default message (but not css or js),
2352 # show a hint that it is translatable on translatewiki.net
2353 if ( !$this->mTitle
->hasContentModel( CONTENT_MODEL_CSS
)
2354 && !$this->mTitle
->hasContentModel( CONTENT_MODEL_JAVASCRIPT
)
2356 $defaultMessageText = $this->mTitle
->getDefaultMessageText();
2357 if ( $defaultMessageText !== false ) {
2358 $wgOut->wrapWikiMsg( "<div class='mw-translateinterface'>\n$1\n</div>",
2359 'translateinterface' );
2362 } elseif ( $namespace == NS_FILE
) {
2363 # Show a hint to shared repo
2364 $file = wfFindFile( $this->mTitle
);
2365 if ( $file && !$file->isLocal() ) {
2366 $descUrl = $file->getDescriptionUrl();
2367 # there must be a description url to show a hint to shared repo
2369 if ( !$this->mTitle
->exists() ) {
2370 $wgOut->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-create\">\n$1\n</div>", [
2371 'sharedupload-desc-create', $file->getRepo()->getDisplayName(), $descUrl
2374 $wgOut->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-edit\">\n$1\n</div>", [
2375 'sharedupload-desc-edit', $file->getRepo()->getDisplayName(), $descUrl
2382 # Show a warning message when someone creates/edits a user (talk) page but the user does not exist
2383 # Show log extract when the user is currently blocked
2384 if ( $namespace == NS_USER ||
$namespace == NS_USER_TALK
) {
2385 $username = explode( '/', $this->mTitle
->getText(), 2 )[0];
2386 $user = User
::newFromName( $username, false /* allow IP users*/ );
2387 $ip = User
::isIP( $username );
2388 $block = Block
::newFromTarget( $user, $user );
2389 if ( !( $user && $user->isLoggedIn() ) && !$ip ) { # User does not exist
2390 $wgOut->wrapWikiMsg( "<div class=\"mw-userpage-userdoesnotexist error\">\n$1\n</div>",
2391 [ 'userpage-userdoesnotexist', wfEscapeWikiText( $username ) ] );
2392 } elseif ( !is_null( $block ) && $block->getType() != Block
::TYPE_AUTO
) {
2393 # Show log extract if the user is currently blocked
2394 LogEventsList
::showLogExtract(
2397 MWNamespace
::getCanonicalName( NS_USER
) . ':' . $block->getTarget(),
2401 'showIfEmpty' => false,
2403 'blocked-notice-logextract',
2404 $user->getName() # Support GENDER in notice
2410 # Try to add a custom edit intro, or use the standard one if this is not possible.
2411 if ( !$this->showCustomIntro() && !$this->mTitle
->exists() ) {
2412 $helpLink = wfExpandUrl( Skin
::makeInternalOrExternalUrl(
2413 wfMessage( 'helppage' )->inContentLanguage()->text()
2415 if ( $wgUser->isLoggedIn() ) {
2416 $wgOut->wrapWikiMsg(
2417 // Suppress the external link icon, consider the help url an internal one
2418 "<div class=\"mw-newarticletext plainlinks\">\n$1\n</div>",
2425 $wgOut->wrapWikiMsg(
2426 // Suppress the external link icon, consider the help url an internal one
2427 "<div class=\"mw-newarticletextanon plainlinks\">\n$1\n</div>",
2429 'newarticletextanon',
2435 # Give a notice if the user is editing a deleted/moved page...
2436 if ( !$this->mTitle
->exists() ) {
2437 LogEventsList
::showLogExtract( $wgOut, [ 'delete', 'move' ], $this->mTitle
,
2441 'conds' => [ "log_action != 'revision'" ],
2442 'showIfEmpty' => false,
2443 'msgKey' => [ 'recreate-moveddeleted-warn' ]
2450 * Attempt to show a custom editing introduction, if supplied
2454 protected function showCustomIntro() {
2455 if ( $this->editintro
) {
2456 $title = Title
::newFromText( $this->editintro
);
2457 if ( $title instanceof Title
&& $title->exists() && $title->userCan( 'read' ) ) {
2459 // Added using template syntax, to take <noinclude>'s into account.
2460 $wgOut->addWikiTextTitleTidy(
2461 '<div class="mw-editintro">{{:' . $title->getFullText() . '}}</div>',
2471 * Gets an editable textual representation of $content.
2472 * The textual representation can be turned by into a Content object by the
2473 * toEditContent() method.
2475 * If $content is null or false or a string, $content is returned unchanged.
2477 * If the given Content object is not of a type that can be edited using
2478 * the text base EditPage, an exception will be raised. Set
2479 * $this->allowNonTextContent to true to allow editing of non-textual
2482 * @param Content|null|bool|string $content
2483 * @return string The editable text form of the content.
2485 * @throws MWException If $content is not an instance of TextContent and
2486 * $this->allowNonTextContent is not true.
2488 protected function toEditText( $content ) {
2489 if ( $content === null ||
$content === false ||
is_string( $content ) ) {
2493 if ( !$this->isSupportedContentModel( $content->getModel() ) ) {
2494 throw new MWException( 'This content model is not supported: '
2495 . ContentHandler
::getLocalizedName( $content->getModel() ) );
2498 return $content->serialize( $this->contentFormat
);
2502 * Turns the given text into a Content object by unserializing it.
2504 * If the resulting Content object is not of a type that can be edited using
2505 * the text base EditPage, an exception will be raised. Set
2506 * $this->allowNonTextContent to true to allow editing of non-textual
2509 * @param string|null|bool $text Text to unserialize
2510 * @return Content|bool|null The content object created from $text. If $text was false
2511 * or null, false resp. null will be returned instead.
2513 * @throws MWException If unserializing the text results in a Content
2514 * object that is not an instance of TextContent and
2515 * $this->allowNonTextContent is not true.
2517 protected function toEditContent( $text ) {
2518 if ( $text === false ||
$text === null ) {
2522 $content = ContentHandler
::makeContent( $text, $this->getTitle(),
2523 $this->contentModel
, $this->contentFormat
);
2525 if ( !$this->isSupportedContentModel( $content->getModel() ) ) {
2526 throw new MWException( 'This content model is not supported: '
2527 . ContentHandler
::getLocalizedName( $content->getModel() ) );
2534 * Send the edit form and related headers to $wgOut
2535 * @param callable|null $formCallback That takes an OutputPage parameter; will be called
2536 * during form output near the top, for captchas and the like.
2538 * The $formCallback parameter is deprecated since MediaWiki 1.25. Please
2539 * use the EditPage::showEditForm:fields hook instead.
2541 function showEditForm( $formCallback = null ) {
2542 global $wgOut, $wgUser;
2544 # need to parse the preview early so that we know which templates are used,
2545 # otherwise users with "show preview after edit box" will get a blank list
2546 # we parse this near the beginning so that setHeaders can do the title
2547 # setting work instead of leaving it in getPreviewText
2548 $previewOutput = '';
2549 if ( $this->formtype
== 'preview' ) {
2550 $previewOutput = $this->getPreviewText();
2553 Hooks
::run( 'EditPage::showEditForm:initial', [ &$this, &$wgOut ] );
2555 $this->setHeaders();
2557 if ( $this->showHeader() === false ) {
2561 $wgOut->addHTML( $this->editFormPageTop
);
2563 if ( $wgUser->getOption( 'previewontop' ) ) {
2564 $this->displayPreviewArea( $previewOutput, true );
2567 $wgOut->addHTML( $this->editFormTextTop
);
2569 $showToolbar = true;
2570 if ( $this->wasDeletedSinceLastEdit() ) {
2571 if ( $this->formtype
== 'save' ) {
2572 // Hide the toolbar and edit area, user can click preview to get it back
2573 // Add an confirmation checkbox and explanation.
2574 $showToolbar = false;
2576 $wgOut->wrapWikiMsg( "<div class='error mw-deleted-while-editing'>\n$1\n</div>",
2577 'deletedwhileediting' );
2581 // @todo add EditForm plugin interface and use it here!
2582 // search for textarea1 and textares2, and allow EditForm to override all uses.
2583 $wgOut->addHTML( Html
::openElement(
2586 'id' => self
::EDITFORM_ID
,
2587 'name' => self
::EDITFORM_ID
,
2589 'action' => $this->getActionURL( $this->getContextTitle() ),
2590 'enctype' => 'multipart/form-data'
2594 if ( is_callable( $formCallback ) ) {
2595 wfWarn( 'The $formCallback parameter to ' . __METHOD__
. 'is deprecated' );
2596 call_user_func_array( $formCallback, [ &$wgOut ] );
2599 // Add an empty field to trip up spambots
2601 Xml
::openElement( 'div', [ 'id' => 'antispam-container', 'style' => 'display: none;' ] )
2604 [ 'for' => 'wpAntispam' ],
2605 wfMessage( 'simpleantispam-label' )->parse()
2611 'name' => 'wpAntispam',
2612 'id' => 'wpAntispam',
2616 . Xml
::closeElement( 'div' )
2619 Hooks
::run( 'EditPage::showEditForm:fields', [ &$this, &$wgOut ] );
2621 // Put these up at the top to ensure they aren't lost on early form submission
2622 $this->showFormBeforeText();
2624 if ( $this->wasDeletedSinceLastEdit() && 'save' == $this->formtype
) {
2625 $username = $this->lastDelete
->user_name
;
2626 $comment = $this->lastDelete
->log_comment
;
2628 // It is better to not parse the comment at all than to have templates expanded in the middle
2629 // TODO: can the checkLabel be moved outside of the div so that wrapWikiMsg could be used?
2630 $key = $comment === ''
2631 ?
'confirmrecreate-noreason'
2632 : 'confirmrecreate';
2634 '<div class="mw-confirm-recreate">' .
2635 wfMessage( $key, $username, "<nowiki>$comment</nowiki>" )->parse() .
2636 Xml
::checkLabel( wfMessage( 'recreate' )->text(), 'wpRecreate', 'wpRecreate', false,
2637 [ 'title' => Linker
::titleAttrib( 'recreate' ), 'tabindex' => 1, 'id' => 'wpRecreate' ]
2643 # When the summary is hidden, also hide them on preview/show changes
2644 if ( $this->nosummary
) {
2645 $wgOut->addHTML( Html
::hidden( 'nosummary', true ) );
2648 # If a blank edit summary was previously provided, and the appropriate
2649 # user preference is active, pass a hidden tag as wpIgnoreBlankSummary. This will stop the
2650 # user being bounced back more than once in the event that a summary
2653 # For a bit more sophisticated detection of blank summaries, hash the
2654 # automatic one and pass that in the hidden field wpAutoSummary.
2655 if ( $this->missingSummary ||
( $this->section
== 'new' && $this->nosummary
) ) {
2656 $wgOut->addHTML( Html
::hidden( 'wpIgnoreBlankSummary', true ) );
2659 if ( $this->undidRev
) {
2660 $wgOut->addHTML( Html
::hidden( 'wpUndidRevision', $this->undidRev
) );
2663 if ( $this->selfRedirect
) {
2664 $wgOut->addHTML( Html
::hidden( 'wpIgnoreSelfRedirect', true ) );
2667 if ( $this->hasPresetSummary
) {
2668 // If a summary has been preset using &summary= we don't want to prompt for
2669 // a different summary. Only prompt for a summary if the summary is blanked.
2671 $this->autoSumm
= md5( '' );
2674 $autosumm = $this->autoSumm ?
$this->autoSumm
: md5( $this->summary
);
2675 $wgOut->addHTML( Html
::hidden( 'wpAutoSummary', $autosumm ) );
2677 $wgOut->addHTML( Html
::hidden( 'oldid', $this->oldid
) );
2678 $wgOut->addHTML( Html
::hidden( 'parentRevId', $this->getParentRevId() ) );
2680 $wgOut->addHTML( Html
::hidden( 'format', $this->contentFormat
) );
2681 $wgOut->addHTML( Html
::hidden( 'model', $this->contentModel
) );
2683 if ( $this->section
== 'new' ) {
2684 $this->showSummaryInput( true, $this->summary
);
2685 $wgOut->addHTML( $this->getSummaryPreview( true, $this->summary
) );
2688 $wgOut->addHTML( $this->editFormTextBeforeContent
);
2690 if ( !$this->isCssJsSubpage
&& $showToolbar && $wgUser->getOption( 'showtoolbar' ) ) {
2691 $wgOut->addHTML( EditPage
::getEditToolbar( $this->mTitle
) );
2694 if ( $this->blankArticle
) {
2695 $wgOut->addHTML( Html
::hidden( 'wpIgnoreBlankArticle', true ) );
2698 if ( $this->isConflict
) {
2699 // In an edit conflict bypass the overridable content form method
2700 // and fallback to the raw wpTextbox1 since editconflicts can't be
2701 // resolved between page source edits and custom ui edits using the
2703 $this->textbox2
= $this->textbox1
;
2705 $content = $this->getCurrentContent();
2706 $this->textbox1
= $this->toEditText( $content );
2708 $this->showTextbox1();
2710 $this->showContentForm();
2713 $wgOut->addHTML( $this->editFormTextAfterContent
);
2715 $this->showStandardInputs();
2717 $this->showFormAfterText();
2719 $this->showTosSummary();
2721 $this->showEditTools();
2723 $wgOut->addHTML( $this->editFormTextAfterTools
. "\n" );
2725 $wgOut->addHTML( Html
::rawElement( 'div', [ 'class' => 'templatesUsed' ],
2726 Linker
::formatTemplates( $this->getTemplates(), $this->preview
, $this->section
!= '' ) ) );
2728 $wgOut->addHTML( Html
::rawElement( 'div', [ 'class' => 'hiddencats' ],
2729 Linker
::formatHiddenCategories( $this->page
->getHiddenCategories() ) ) );
2731 if ( $this->mParserOutput
) {
2732 $wgOut->setLimitReportData( $this->mParserOutput
->getLimitReportData() );
2735 $wgOut->addModules( 'mediawiki.action.edit.collapsibleFooter' );
2737 if ( $this->isConflict
) {
2739 $this->showConflict();
2740 } catch ( MWContentSerializationException
$ex ) {
2741 // this can't really happen, but be nice if it does.
2743 'content-failed-to-parse',
2744 $this->contentModel
,
2745 $this->contentFormat
,
2748 $wgOut->addWikiText( '<div class="error">' . $msg->text() . '</div>' );
2752 // Set a hidden field so JS knows what edit form mode we are in
2753 if ( $this->isConflict
) {
2755 } elseif ( $this->preview
) {
2757 } elseif ( $this->diff
) {
2762 $wgOut->addHTML( Html
::hidden( 'mode', $mode, [ 'id' => 'mw-edit-mode' ] ) );
2764 // Marker for detecting truncated form data. This must be the last
2765 // parameter sent in order to be of use, so do not move me.
2766 $wgOut->addHTML( Html
::hidden( 'wpUltimateParam', true ) );
2767 $wgOut->addHTML( $this->editFormTextBottom
. "\n</form>\n" );
2769 if ( !$wgUser->getOption( 'previewontop' ) ) {
2770 $this->displayPreviewArea( $previewOutput, false );
2776 * Extract the section title from current section text, if any.
2778 * @param string $text
2779 * @return string|bool String or false
2781 public static function extractSectionTitle( $text ) {
2782 preg_match( "/^(=+)(.+)\\1\\s*(\n|$)/i", $text, $matches );
2783 if ( !empty( $matches[2] ) ) {
2785 return $wgParser->stripSectionName( trim( $matches[2] ) );
2794 protected function showHeader() {
2795 global $wgOut, $wgUser, $wgMaxArticleSize, $wgLang;
2796 global $wgAllowUserCss, $wgAllowUserJs;
2798 if ( $this->mTitle
->isTalkPage() ) {
2799 $wgOut->addWikiMsg( 'talkpagetext' );
2803 $editNotices = $this->mTitle
->getEditNotices( $this->oldid
);
2804 if ( count( $editNotices ) ) {
2805 $wgOut->addHTML( implode( "\n", $editNotices ) );
2807 $msg = wfMessage( 'editnotice-notext' );
2808 if ( !$msg->isDisabled() ) {
2810 '<div class="mw-editnotice-notext">'
2811 . $msg->parseAsBlock()
2817 if ( $this->isConflict
) {
2818 $wgOut->wrapWikiMsg( "<div class='mw-explainconflict'>\n$1\n</div>", 'explainconflict' );
2819 $this->editRevId
= $this->page
->getLatest();
2821 if ( $this->section
!= '' && !$this->isSectionEditSupported() ) {
2822 // We use $this->section to much before this and getVal('wgSection') directly in other places
2823 // at this point we can't reset $this->section to '' to fallback to non-section editing.
2824 // Someone is welcome to try refactoring though
2825 $wgOut->showErrorPage( 'sectioneditnotsupported-title', 'sectioneditnotsupported-text' );
2829 if ( $this->section
!= '' && $this->section
!= 'new' ) {
2830 if ( !$this->summary
&& !$this->preview
&& !$this->diff
) {
2831 $sectionTitle = self
::extractSectionTitle( $this->textbox1
); // FIXME: use Content object
2832 if ( $sectionTitle !== false ) {
2833 $this->summary
= "/* $sectionTitle */ ";
2838 if ( $this->missingComment
) {
2839 $wgOut->wrapWikiMsg( "<div id='mw-missingcommenttext'>\n$1\n</div>", 'missingcommenttext' );
2842 if ( $this->missingSummary
&& $this->section
!= 'new' ) {
2843 $wgOut->wrapWikiMsg( "<div id='mw-missingsummary'>\n$1\n</div>", 'missingsummary' );
2846 if ( $this->missingSummary
&& $this->section
== 'new' ) {
2847 $wgOut->wrapWikiMsg( "<div id='mw-missingcommentheader'>\n$1\n</div>", 'missingcommentheader' );
2850 if ( $this->blankArticle
) {
2851 $wgOut->wrapWikiMsg( "<div id='mw-blankarticle'>\n$1\n</div>", 'blankarticle' );
2854 if ( $this->selfRedirect
) {
2855 $wgOut->wrapWikiMsg( "<div id='mw-selfredirect'>\n$1\n</div>", 'selfredirect' );
2858 if ( $this->hookError
!== '' ) {
2859 $wgOut->addWikiText( $this->hookError
);
2862 if ( !$this->checkUnicodeCompliantBrowser() ) {
2863 $wgOut->addWikiMsg( 'nonunicodebrowser' );
2866 if ( $this->section
!= 'new' ) {
2867 $revision = $this->mArticle
->getRevisionFetched();
2869 // Let sysop know that this will make private content public if saved
2871 if ( !$revision->userCan( Revision
::DELETED_TEXT
, $wgUser ) ) {
2872 $wgOut->wrapWikiMsg(
2873 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
2874 'rev-deleted-text-permission'
2876 } elseif ( $revision->isDeleted( Revision
::DELETED_TEXT
) ) {
2877 $wgOut->wrapWikiMsg(
2878 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
2879 'rev-deleted-text-view'
2883 if ( !$revision->isCurrent() ) {
2884 $this->mArticle
->setOldSubtitle( $revision->getId() );
2885 $wgOut->addWikiMsg( 'editingold' );
2887 } elseif ( $this->mTitle
->exists() ) {
2888 // Something went wrong
2890 $wgOut->wrapWikiMsg( "<div class='errorbox'>\n$1\n</div>\n",
2891 [ 'missing-revision', $this->oldid
] );
2896 if ( wfReadOnly() ) {
2897 $wgOut->wrapWikiMsg(
2898 "<div id=\"mw-read-only-warning\">\n$1\n</div>",
2899 [ 'readonlywarning', wfReadOnlyReason() ]
2901 } elseif ( $wgUser->isAnon() ) {
2902 if ( $this->formtype
!= 'preview' ) {
2903 $wgOut->wrapWikiMsg(
2904 "<div id='mw-anon-edit-warning' class='warningbox'>\n$1\n</div>",
2905 [ 'anoneditwarning',
2907 SpecialPage
::getTitleFor( 'Userlogin' )->getFullURL( [
2908 'returnto' => $this->getTitle()->getPrefixedDBkey()
2911 SpecialPage
::getTitleFor( 'CreateAccount' )->getFullURL( [
2912 'returnto' => $this->getTitle()->getPrefixedDBkey()
2917 $wgOut->wrapWikiMsg( "<div id=\"mw-anon-preview-warning\" class=\"warningbox\">\n$1</div>",
2918 'anonpreviewwarning'
2922 if ( $this->isCssJsSubpage
) {
2923 # Check the skin exists
2924 if ( $this->isWrongCaseCssJsPage
) {
2925 $wgOut->wrapWikiMsg(
2926 "<div class='error' id='mw-userinvalidcssjstitle'>\n$1\n</div>",
2927 [ 'userinvalidcssjstitle', $this->mTitle
->getSkinFromCssJsSubpage() ]
2930 if ( $this->getTitle()->isSubpageOf( $wgUser->getUserPage() ) ) {
2931 $wgOut->wrapWikiMsg( '<div class="mw-usercssjspublic">$1</div>',
2932 $this->isCssSubpage ?
'usercssispublic' : 'userjsispublic'
2934 if ( $this->formtype
!== 'preview' ) {
2935 if ( $this->isCssSubpage
&& $wgAllowUserCss ) {
2936 $wgOut->wrapWikiMsg(
2937 "<div id='mw-usercssyoucanpreview'>\n$1\n</div>",
2938 [ 'usercssyoucanpreview' ]
2942 if ( $this->isJsSubpage
&& $wgAllowUserJs ) {
2943 $wgOut->wrapWikiMsg(
2944 "<div id='mw-userjsyoucanpreview'>\n$1\n</div>",
2945 [ 'userjsyoucanpreview' ]
2953 if ( $this->mTitle
->isProtected( 'edit' ) &&
2954 MWNamespace
::getRestrictionLevels( $this->mTitle
->getNamespace() ) !== [ '' ]
2956 # Is the title semi-protected?
2957 if ( $this->mTitle
->isSemiProtected() ) {
2958 $noticeMsg = 'semiprotectedpagewarning';
2960 # Then it must be protected based on static groups (regular)
2961 $noticeMsg = 'protectedpagewarning';
2963 LogEventsList
::showLogExtract( $wgOut, 'protect', $this->mTitle
, '',
2964 [ 'lim' => 1, 'msgKey' => [ $noticeMsg ] ] );
2966 if ( $this->mTitle
->isCascadeProtected() ) {
2967 # Is this page under cascading protection from some source pages?
2968 /** @var Title[] $cascadeSources */
2969 list( $cascadeSources, /* $restrictions */ ) = $this->mTitle
->getCascadeProtectionSources();
2970 $notice = "<div class='mw-cascadeprotectedwarning'>\n$1\n";
2971 $cascadeSourcesCount = count( $cascadeSources );
2972 if ( $cascadeSourcesCount > 0 ) {
2973 # Explain, and list the titles responsible
2974 foreach ( $cascadeSources as $page ) {
2975 $notice .= '* [[:' . $page->getPrefixedText() . "]]\n";
2978 $notice .= '</div>';
2979 $wgOut->wrapWikiMsg( $notice, [ 'cascadeprotectedwarning', $cascadeSourcesCount ] );
2981 if ( !$this->mTitle
->exists() && $this->mTitle
->getRestrictions( 'create' ) ) {
2982 LogEventsList
::showLogExtract( $wgOut, 'protect', $this->mTitle
, '',
2984 'showIfEmpty' => false,
2985 'msgKey' => [ 'titleprotectedwarning' ],
2986 'wrap' => "<div class=\"mw-titleprotectedwarning\">\n$1</div>" ] );
2989 if ( $this->contentLength
=== false ) {
2990 $this->contentLength
= strlen( $this->textbox1
);
2993 if ( $this->tooBig ||
$this->contentLength
> $wgMaxArticleSize * 1024 ) {
2994 $wgOut->wrapWikiMsg( "<div class='error' id='mw-edit-longpageerror'>\n$1\n</div>",
2997 $wgLang->formatNum( round( $this->contentLength
/ 1024, 3 ) ),
2998 $wgLang->formatNum( $wgMaxArticleSize )
3002 if ( !wfMessage( 'longpage-hint' )->isDisabled() ) {
3003 $wgOut->wrapWikiMsg( "<div id='mw-edit-longpage-hint'>\n$1\n</div>",
3006 $wgLang->formatSize( strlen( $this->textbox1
) ),
3007 strlen( $this->textbox1
)
3012 # Add header copyright warning
3013 $this->showHeaderCopyrightWarning();
3019 * Standard summary input and label (wgSummary), abstracted so EditPage
3020 * subclasses may reorganize the form.
3021 * Note that you do not need to worry about the label's for=, it will be
3022 * inferred by the id given to the input. You can remove them both by
3023 * passing array( 'id' => false ) to $userInputAttrs.
3025 * @param string $summary The value of the summary input
3026 * @param string $labelText The html to place inside the label
3027 * @param array $inputAttrs Array of attrs to use on the input
3028 * @param array $spanLabelAttrs Array of attrs to use on the span inside the label
3030 * @return array An array in the format array( $label, $input )
3032 function getSummaryInput( $summary = "", $labelText = null,
3033 $inputAttrs = null, $spanLabelAttrs = null
3035 // Note: the maxlength is overridden in JS to 255 and to make it use UTF-8 bytes, not characters.
3036 $inputAttrs = ( is_array( $inputAttrs ) ?
$inputAttrs : [] ) +
[
3037 'id' => 'wpSummary',
3038 'maxlength' => '200',
3041 'spellcheck' => 'true',
3042 ] + Linker
::tooltipAndAccesskeyAttribs( 'summary' );
3044 $spanLabelAttrs = ( is_array( $spanLabelAttrs ) ?
$spanLabelAttrs : [] ) +
[
3045 'class' => $this->missingSummary ?
'mw-summarymissed' : 'mw-summary',
3046 'id' => "wpSummaryLabel"
3053 $inputAttrs['id'] ?
[ 'for' => $inputAttrs['id'] ] : null,
3056 $label = Xml
::tags( 'span', $spanLabelAttrs, $label );
3059 $input = Html
::input( 'wpSummary', $summary, 'text', $inputAttrs );
3061 return [ $label, $input ];
3065 * @param bool $isSubjectPreview True if this is the section subject/title
3066 * up top, or false if this is the comment summary
3067 * down below the textarea
3068 * @param string $summary The text of the summary to display
3070 protected function showSummaryInput( $isSubjectPreview, $summary = "" ) {
3072 # Add a class if 'missingsummary' is triggered to allow styling of the summary line
3073 $summaryClass = $this->missingSummary ?
'mw-summarymissed' : 'mw-summary';
3074 if ( $isSubjectPreview ) {
3075 if ( $this->nosummary
) {
3079 if ( !$this->mShowSummaryField
) {
3083 $labelText = wfMessage( $isSubjectPreview ?
'subject' : 'summary' )->parse();
3084 list( $label, $input ) = $this->getSummaryInput(
3087 [ 'class' => $summaryClass ],
3090 $wgOut->addHTML( "{$label} {$input}" );
3094 * @param bool $isSubjectPreview True if this is the section subject/title
3095 * up top, or false if this is the comment summary
3096 * down below the textarea
3097 * @param string $summary The text of the summary to display
3100 protected function getSummaryPreview( $isSubjectPreview, $summary = "" ) {
3101 // avoid spaces in preview, gets always trimmed on save
3102 $summary = trim( $summary );
3103 if ( !$summary ||
( !$this->preview
&& !$this->diff
) ) {
3109 if ( $isSubjectPreview ) {
3110 $summary = wfMessage( 'newsectionsummary' )->rawParams( $wgParser->stripSectionName( $summary ) )
3111 ->inContentLanguage()->text();
3114 $message = $isSubjectPreview ?
'subject-preview' : 'summary-preview';
3116 $summary = wfMessage( $message )->parse()
3117 . Linker
::commentBlock( $summary, $this->mTitle
, $isSubjectPreview );
3118 return Xml
::tags( 'div', [ 'class' => 'mw-summary-preview' ], $summary );
3121 protected function showFormBeforeText() {
3123 $section = htmlspecialchars( $this->section
);
3124 $wgOut->addHTML( <<<HTML
3125 <input type='hidden' value="{$section}" name="wpSection"/>
3126 <input type='hidden' value="{$this->starttime}" name="wpStarttime" />
3127 <input type='hidden' value="{$this->edittime}" name="wpEdittime" />
3128 <input type='hidden' value="{$this->editRevId}" name="editRevId" />
3129 <input type='hidden' value="{$this->scrolltop}" name="wpScrolltop" id="wpScrolltop" />
3133 if ( !$this->checkUnicodeCompliantBrowser() ) {
3134 $wgOut->addHTML( Html
::hidden( 'safemode', '1' ) );
3138 protected function showFormAfterText() {
3139 global $wgOut, $wgUser;
3141 * To make it harder for someone to slip a user a page
3142 * which submits an edit form to the wiki without their
3143 * knowledge, a random token is associated with the login
3144 * session. If it's not passed back with the submission,
3145 * we won't save the page, or render user JavaScript and
3148 * For anon editors, who may not have a session, we just
3149 * include the constant suffix to prevent editing from
3150 * broken text-mangling proxies.
3152 $wgOut->addHTML( "\n" . Html
::hidden( "wpEditToken", $wgUser->getEditToken() ) . "\n" );
3156 * Subpage overridable method for printing the form for page content editing
3157 * By default this simply outputs wpTextbox1
3158 * Subclasses can override this to provide a custom UI for editing;
3159 * be it a form, or simply wpTextbox1 with a modified content that will be
3160 * reverse modified when extracted from the post data.
3161 * Note that this is basically the inverse for importContentFormData
3163 protected function showContentForm() {
3164 $this->showTextbox1();
3168 * Method to output wpTextbox1
3169 * The $textoverride method can be used by subclasses overriding showContentForm
3170 * to pass back to this method.
3172 * @param array $customAttribs Array of html attributes to use in the textarea
3173 * @param string $textoverride Optional text to override $this->textarea1 with
3175 protected function showTextbox1( $customAttribs = null, $textoverride = null ) {
3176 if ( $this->wasDeletedSinceLastEdit() && $this->formtype
== 'save' ) {
3177 $attribs = [ 'style' => 'display:none;' ];
3179 $classes = []; // Textarea CSS
3180 if ( $this->mTitle
->isProtected( 'edit' ) &&
3181 MWNamespace
::getRestrictionLevels( $this->mTitle
->getNamespace() ) !== [ '' ]
3183 # Is the title semi-protected?
3184 if ( $this->mTitle
->isSemiProtected() ) {
3185 $classes[] = 'mw-textarea-sprotected';
3187 # Then it must be protected based on static groups (regular)
3188 $classes[] = 'mw-textarea-protected';
3190 # Is the title cascade-protected?
3191 if ( $this->mTitle
->isCascadeProtected() ) {
3192 $classes[] = 'mw-textarea-cprotected';
3196 $attribs = [ 'tabindex' => 1 ];
3198 if ( is_array( $customAttribs ) ) {
3199 $attribs +
= $customAttribs;
3202 if ( count( $classes ) ) {
3203 if ( isset( $attribs['class'] ) ) {
3204 $classes[] = $attribs['class'];
3206 $attribs['class'] = implode( ' ', $classes );
3211 $textoverride !== null ?
$textoverride : $this->textbox1
,
3217 protected function showTextbox2() {
3218 $this->showTextbox( $this->textbox2
, 'wpTextbox2', [ 'tabindex' => 6, 'readonly' ] );
3221 protected function showTextbox( $text, $name, $customAttribs = [] ) {
3222 global $wgOut, $wgUser;
3224 $wikitext = $this->safeUnicodeOutput( $text );
3225 if ( strval( $wikitext ) !== '' ) {
3226 // Ensure there's a newline at the end, otherwise adding lines
3228 // But don't add a newline if the ext is empty, or Firefox in XHTML
3229 // mode will show an extra newline. A bit annoying.
3233 $attribs = $customAttribs +
[
3236 'cols' => $wgUser->getIntOption( 'cols' ),
3237 'rows' => $wgUser->getIntOption( 'rows' ),
3238 // Avoid PHP notices when appending preferences
3239 // (appending allows customAttribs['style'] to still work).
3243 $pageLang = $this->mTitle
->getPageLanguage();
3244 $attribs['lang'] = $pageLang->getHtmlCode();
3245 $attribs['dir'] = $pageLang->getDir();
3247 $wgOut->addHTML( Html
::textarea( $name, $wikitext, $attribs ) );
3250 protected function displayPreviewArea( $previewOutput, $isOnTop = false ) {
3254 $classes[] = 'ontop';
3257 $attribs = [ 'id' => 'wikiPreview', 'class' => implode( ' ', $classes ) ];
3259 if ( $this->formtype
!= 'preview' ) {
3260 $attribs['style'] = 'display: none;';
3263 $wgOut->addHTML( Xml
::openElement( 'div', $attribs ) );
3265 if ( $this->formtype
== 'preview' ) {
3266 $this->showPreview( $previewOutput );
3268 // Empty content container for LivePreview
3269 $pageViewLang = $this->mTitle
->getPageViewLanguage();
3270 $attribs = [ 'lang' => $pageViewLang->getHtmlCode(), 'dir' => $pageViewLang->getDir(),
3271 'class' => 'mw-content-' . $pageViewLang->getDir() ];
3272 $wgOut->addHTML( Html
::rawElement( 'div', $attribs ) );
3275 $wgOut->addHTML( '</div>' );
3277 if ( $this->formtype
== 'diff' ) {
3280 } catch ( MWContentSerializationException
$ex ) {
3282 'content-failed-to-parse',
3283 $this->contentModel
,
3284 $this->contentFormat
,
3287 $wgOut->addWikiText( '<div class="error">' . $msg->text() . '</div>' );
3293 * Append preview output to $wgOut.
3294 * Includes category rendering if this is a category page.
3296 * @param string $text The HTML to be output for the preview.
3298 protected function showPreview( $text ) {
3300 if ( $this->mTitle
->getNamespace() == NS_CATEGORY
) {
3301 $this->mArticle
->openShowCategory();
3303 # This hook seems slightly odd here, but makes things more
3304 # consistent for extensions.
3305 Hooks
::run( 'OutputPageBeforeHTML', [ &$wgOut, &$text ] );
3306 $wgOut->addHTML( $text );
3307 if ( $this->mTitle
->getNamespace() == NS_CATEGORY
) {
3308 $this->mArticle
->closeShowCategory();
3313 * Get a diff between the current contents of the edit box and the
3314 * version of the page we're editing from.
3316 * If this is a section edit, we'll replace the section as for final
3317 * save and then make a comparison.
3319 function showDiff() {
3320 global $wgUser, $wgContLang, $wgOut;
3322 $oldtitlemsg = 'currentrev';
3323 # if message does not exist, show diff against the preloaded default
3324 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
&& !$this->mTitle
->exists() ) {
3325 $oldtext = $this->mTitle
->getDefaultMessageText();
3326 if ( $oldtext !== false ) {
3327 $oldtitlemsg = 'defaultmessagetext';
3328 $oldContent = $this->toEditContent( $oldtext );
3333 $oldContent = $this->getCurrentContent();
3336 $textboxContent = $this->toEditContent( $this->textbox1
);
3337 if ( $this->editRevId
!== null ) {
3338 $newContent = $this->page
->replaceSectionAtRev(
3339 $this->section
, $textboxContent, $this->summary
, $this->editRevId
3342 $newContent = $this->page
->replaceSectionContent(
3343 $this->section
, $textboxContent, $this->summary
, $this->edittime
3347 if ( $newContent ) {
3348 ContentHandler
::runLegacyHooks( 'EditPageGetDiffText', [ $this, &$newContent ] );
3349 Hooks
::run( 'EditPageGetDiffContent', [ $this, &$newContent ] );
3351 $popts = ParserOptions
::newFromUserAndLang( $wgUser, $wgContLang );
3352 $newContent = $newContent->preSaveTransform( $this->mTitle
, $wgUser, $popts );
3355 if ( ( $oldContent && !$oldContent->isEmpty() ) ||
( $newContent && !$newContent->isEmpty() ) ) {
3356 $oldtitle = wfMessage( $oldtitlemsg )->parse();
3357 $newtitle = wfMessage( 'yourtext' )->parse();
3359 if ( !$oldContent ) {
3360 $oldContent = $newContent->getContentHandler()->makeEmptyContent();
3363 if ( !$newContent ) {
3364 $newContent = $oldContent->getContentHandler()->makeEmptyContent();
3367 $de = $oldContent->getContentHandler()->createDifferenceEngine( $this->mArticle
->getContext() );
3368 $de->setContent( $oldContent, $newContent );
3370 $difftext = $de->getDiff( $oldtitle, $newtitle );
3371 $de->showDiffStyle();
3376 $wgOut->addHTML( '<div id="wikiDiff">' . $difftext . '</div>' );
3380 * Show the header copyright warning.
3382 protected function showHeaderCopyrightWarning() {
3383 $msg = 'editpage-head-copy-warn';
3384 if ( !wfMessage( $msg )->isDisabled() ) {
3386 $wgOut->wrapWikiMsg( "<div class='editpage-head-copywarn'>\n$1\n</div>",
3387 'editpage-head-copy-warn' );
3392 * Give a chance for site and per-namespace customizations of
3393 * terms of service summary link that might exist separately
3394 * from the copyright notice.
3396 * This will display between the save button and the edit tools,
3397 * so should remain short!
3399 protected function showTosSummary() {
3400 $msg = 'editpage-tos-summary';
3401 Hooks
::run( 'EditPageTosSummary', [ $this->mTitle
, &$msg ] );
3402 if ( !wfMessage( $msg )->isDisabled() ) {
3404 $wgOut->addHTML( '<div class="mw-tos-summary">' );
3405 $wgOut->addWikiMsg( $msg );
3406 $wgOut->addHTML( '</div>' );
3410 protected function showEditTools() {
3412 $wgOut->addHTML( '<div class="mw-editTools">' .
3413 wfMessage( 'edittools' )->inContentLanguage()->parse() .
3418 * Get the copyright warning
3420 * Renamed to getCopyrightWarning(), old name kept around for backwards compatibility
3423 protected function getCopywarn() {
3424 return self
::getCopyrightWarning( $this->mTitle
);
3428 * Get the copyright warning, by default returns wikitext
3430 * @param Title $title
3431 * @param string $format Output format, valid values are any function of a Message object
3434 public static function getCopyrightWarning( $title, $format = 'plain' ) {
3435 global $wgRightsText;
3436 if ( $wgRightsText ) {
3437 $copywarnMsg = [ 'copyrightwarning',
3438 '[[' . wfMessage( 'copyrightpage' )->inContentLanguage()->text() . ']]',
3441 $copywarnMsg = [ 'copyrightwarning2',
3442 '[[' . wfMessage( 'copyrightpage' )->inContentLanguage()->text() . ']]' ];
3444 // Allow for site and per-namespace customization of contribution/copyright notice.
3445 Hooks
::run( 'EditPageCopyrightWarning', [ $title, &$copywarnMsg ] );
3447 return "<div id=\"editpage-copywarn\">\n" .
3448 call_user_func_array( 'wfMessage', $copywarnMsg )->$format() . "\n</div>";
3452 * Get the Limit report for page previews
3455 * @param ParserOutput $output ParserOutput object from the parse
3456 * @return string HTML
3458 public static function getPreviewLimitReport( $output ) {
3459 if ( !$output ||
!$output->getLimitReportData() ) {
3463 return ResourceLoader
::makeInlineScript(
3464 ResourceLoader
::makeConfigSetScript(
3465 [ 'wgPageParseReport' => $output->getLimitReportData() ],
3471 protected function showStandardInputs( &$tabindex = 2 ) {
3473 $wgOut->addHTML( "<div class='editOptions'>\n" );
3475 if ( $this->section
!= 'new' ) {
3476 $this->showSummaryInput( false, $this->summary
);
3477 $wgOut->addHTML( $this->getSummaryPreview( false, $this->summary
) );
3480 $checkboxes = $this->getCheckboxes( $tabindex,
3481 [ 'minor' => $this->minoredit
, 'watch' => $this->watchthis
] );
3482 $wgOut->addHTML( "<div class='editCheckboxes'>" . implode( $checkboxes, "\n" ) . "</div>\n" );
3484 // Show copyright warning.
3485 $wgOut->addWikiText( $this->getCopywarn() );
3486 $wgOut->addHTML( $this->editFormTextAfterWarn
);
3488 $wgOut->addHTML( "<div class='editButtons'>\n" );
3489 $wgOut->addHTML( implode( $this->getEditButtons( $tabindex ), "\n" ) . "\n" );
3491 $cancel = $this->getCancelLink();
3492 if ( $cancel !== '' ) {
3493 $cancel .= Html
::element( 'span',
3494 [ 'class' => 'mw-editButtons-pipe-separator' ],
3495 wfMessage( 'pipe-separator' )->text() );
3498 $message = wfMessage( 'edithelppage' )->inContentLanguage()->text();
3499 $edithelpurl = Skin
::makeInternalOrExternalUrl( $message );
3501 'target' => 'helpwindow',
3502 'href' => $edithelpurl,
3504 $edithelp = Html
::linkButton( wfMessage( 'edithelp' )->text(),
3505 $attrs, [ 'mw-ui-quiet' ] ) .
3506 wfMessage( 'word-separator' )->escaped() .
3507 wfMessage( 'newwindow' )->parse();
3509 $wgOut->addHTML( " <span class='cancelLink'>{$cancel}</span>\n" );
3510 $wgOut->addHTML( " <span class='editHelp'>{$edithelp}</span>\n" );
3511 $wgOut->addHTML( "</div><!-- editButtons -->\n" );
3513 Hooks
::run( 'EditPage::showStandardInputs:options', [ $this, $wgOut, &$tabindex ] );
3515 $wgOut->addHTML( "</div><!-- editOptions -->\n" );
3519 * Show an edit conflict. textbox1 is already shown in showEditForm().
3520 * If you want to use another entry point to this function, be careful.
3522 protected function showConflict() {
3525 if ( Hooks
::run( 'EditPageBeforeConflictDiff', [ &$this, &$wgOut ] ) ) {
3526 $stats = $wgOut->getContext()->getStats();
3527 $stats->increment( 'edit.failures.conflict' );
3528 // Only include 'standard' namespaces to avoid creating unknown numbers of statsd metrics
3530 $this->mTitle
->getNamespace() >= NS_MAIN
&&
3531 $this->mTitle
->getNamespace() <= NS_CATEGORY_TALK
3533 $stats->increment( 'edit.failures.conflict.byNamespaceId.' . $this->mTitle
->getNamespace() );
3536 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
3538 $content1 = $this->toEditContent( $this->textbox1
);
3539 $content2 = $this->toEditContent( $this->textbox2
);
3541 $handler = ContentHandler
::getForModelID( $this->contentModel
);
3542 $de = $handler->createDifferenceEngine( $this->mArticle
->getContext() );
3543 $de->setContent( $content2, $content1 );
3545 wfMessage( 'yourtext' )->parse(),
3546 wfMessage( 'storedversion' )->text()
3549 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
3550 $this->showTextbox2();
3557 public function getCancelLink() {
3559 if ( !$this->isConflict
&& $this->oldid
> 0 ) {
3560 $cancelParams['oldid'] = $this->oldid
;
3561 } elseif ( $this->getContextTitle()->isRedirect() ) {
3562 $cancelParams['redirect'] = 'no';
3564 $attrs = [ 'id' => 'mw-editform-cancel' ];
3566 return Linker
::linkKnown(
3567 $this->getContextTitle(),
3568 wfMessage( 'cancel' )->parse(),
3569 Html
::buttonAttributes( $attrs, [ 'mw-ui-quiet' ] ),
3575 * Returns the URL to use in the form's action attribute.
3576 * This is used by EditPage subclasses when simply customizing the action
3577 * variable in the constructor is not enough. This can be used when the
3578 * EditPage lives inside of a Special page rather than a custom page action.
3580 * @param Title $title Title object for which is being edited (where we go to for &action= links)
3583 protected function getActionURL( Title
$title ) {
3584 return $title->getLocalURL( [ 'action' => $this->action
] );
3588 * Check if a page was deleted while the user was editing it, before submit.
3589 * Note that we rely on the logging table, which hasn't been always there,
3590 * but that doesn't matter, because this only applies to brand new
3594 protected function wasDeletedSinceLastEdit() {
3595 if ( $this->deletedSinceEdit
!== null ) {
3596 return $this->deletedSinceEdit
;
3599 $this->deletedSinceEdit
= false;
3601 if ( !$this->mTitle
->exists() && $this->mTitle
->isDeletedQuick() ) {
3602 $this->lastDelete
= $this->getLastDelete();
3603 if ( $this->lastDelete
) {
3604 $deleteTime = wfTimestamp( TS_MW
, $this->lastDelete
->log_timestamp
);
3605 if ( $deleteTime > $this->starttime
) {
3606 $this->deletedSinceEdit
= true;
3611 return $this->deletedSinceEdit
;
3615 * @return bool|stdClass
3617 protected function getLastDelete() {
3618 $dbr = wfGetDB( DB_SLAVE
);
3619 $data = $dbr->selectRow(
3620 [ 'logging', 'user' ],
3633 'log_namespace' => $this->mTitle
->getNamespace(),
3634 'log_title' => $this->mTitle
->getDBkey(),
3635 'log_type' => 'delete',
3636 'log_action' => 'delete',
3640 [ 'LIMIT' => 1, 'ORDER BY' => 'log_timestamp DESC' ]
3642 // Quick paranoid permission checks...
3643 if ( is_object( $data ) ) {
3644 if ( $data->log_deleted
& LogPage
::DELETED_USER
) {
3645 $data->user_name
= wfMessage( 'rev-deleted-user' )->escaped();
3648 if ( $data->log_deleted
& LogPage
::DELETED_COMMENT
) {
3649 $data->log_comment
= wfMessage( 'rev-deleted-comment' )->escaped();
3657 * Get the rendered text for previewing.
3658 * @throws MWException
3661 function getPreviewText() {
3662 global $wgOut, $wgRawHtml, $wgLang;
3663 global $wgAllowUserCss, $wgAllowUserJs;
3665 $stats = $wgOut->getContext()->getStats();
3667 if ( $wgRawHtml && !$this->mTokenOk
) {
3668 // Could be an offsite preview attempt. This is very unsafe if
3669 // HTML is enabled, as it could be an attack.
3671 if ( $this->textbox1
!== '' ) {
3672 // Do not put big scary notice, if previewing the empty
3673 // string, which happens when you initially edit
3674 // a category page, due to automatic preview-on-open.
3675 $parsedNote = $wgOut->parse( "<div class='previewnote'>" .
3676 wfMessage( 'session_fail_preview_html' )->text() . "</div>", true, /* interface */true );
3678 $stats->increment( 'edit.failures.session_loss' );
3685 $content = $this->toEditContent( $this->textbox1
);
3689 'AlternateEditPreview',
3690 [ $this, &$content, &$previewHTML, &$this->mParserOutput
] )
3692 return $previewHTML;
3695 # provide a anchor link to the editform
3696 $continueEditing = '<span class="mw-continue-editing">' .
3697 '[[#' . self
::EDITFORM_ID
. '|' . $wgLang->getArrow() . ' ' .
3698 wfMessage( 'continue-editing' )->text() . ']]</span>';
3699 if ( $this->mTriedSave
&& !$this->mTokenOk
) {
3700 if ( $this->mTokenOkExceptSuffix
) {
3701 $note = wfMessage( 'token_suffix_mismatch' )->plain();
3702 $stats->increment( 'edit.failures.bad_token' );
3704 $note = wfMessage( 'session_fail_preview' )->plain();
3705 $stats->increment( 'edit.failures.session_loss' );
3707 } elseif ( $this->incompleteForm
) {
3708 $note = wfMessage( 'edit_form_incomplete' )->plain();
3709 if ( $this->mTriedSave
) {
3710 $stats->increment( 'edit.failures.incomplete_form' );
3713 $note = wfMessage( 'previewnote' )->plain() . ' ' . $continueEditing;
3716 # don't parse non-wikitext pages, show message about preview
3717 if ( $this->mTitle
->isCssJsSubpage() ||
$this->mTitle
->isCssOrJsPage() ) {
3718 if ( $this->mTitle
->isCssJsSubpage() ) {
3720 } elseif ( $this->mTitle
->isCssOrJsPage() ) {
3726 if ( $content->getModel() == CONTENT_MODEL_CSS
) {
3728 if ( $level === 'user' && !$wgAllowUserCss ) {
3731 } elseif ( $content->getModel() == CONTENT_MODEL_JAVASCRIPT
) {
3733 if ( $level === 'user' && !$wgAllowUserJs ) {
3740 # Used messages to make sure grep find them:
3741 # Messages: usercsspreview, userjspreview, sitecsspreview, sitejspreview
3742 if ( $level && $format ) {
3743 $note = "<div id='mw-{$level}{$format}preview'>" .
3744 wfMessage( "{$level}{$format}preview" )->text() .
3745 ' ' . $continueEditing . "</div>";
3749 # If we're adding a comment, we need to show the
3750 # summary as the headline
3751 if ( $this->section
=== "new" && $this->summary
!== "" ) {
3752 $content = $content->addSectionHeader( $this->summary
);
3755 $hook_args = [ $this, &$content ];
3756 ContentHandler
::runLegacyHooks( 'EditPageGetPreviewText', $hook_args );
3757 Hooks
::run( 'EditPageGetPreviewContent', $hook_args );
3759 $parserResult = $this->doPreviewParse( $content );
3760 $parserOutput = $parserResult['parserOutput'];
3761 $previewHTML = $parserResult['html'];
3762 $this->mParserOutput
= $parserOutput;
3763 $wgOut->addParserOutputMetadata( $parserOutput );
3765 if ( count( $parserOutput->getWarnings() ) ) {
3766 $note .= "\n\n" . implode( "\n\n", $parserOutput->getWarnings() );
3769 } catch ( MWContentSerializationException
$ex ) {
3771 'content-failed-to-parse',
3772 $this->contentModel
,
3773 $this->contentFormat
,
3776 $note .= "\n\n" . $m->parse();
3780 if ( $this->isConflict
) {
3781 $conflict = '<h2 id="mw-previewconflict">'
3782 . wfMessage( 'previewconflict' )->escaped() . "</h2>\n";
3784 $conflict = '<hr />';
3787 $previewhead = "<div class='previewnote'>\n" .
3788 '<h2 id="mw-previewheader">' . wfMessage( 'preview' )->escaped() . "</h2>" .
3789 $wgOut->parse( $note, true, /* interface */true ) . $conflict . "</div>\n";
3791 $pageViewLang = $this->mTitle
->getPageViewLanguage();
3792 $attribs = [ 'lang' => $pageViewLang->getHtmlCode(), 'dir' => $pageViewLang->getDir(),
3793 'class' => 'mw-content-' . $pageViewLang->getDir() ];
3794 $previewHTML = Html
::rawElement( 'div', $attribs, $previewHTML );
3796 return $previewhead . $previewHTML . $this->previewTextAfterContent
;
3800 * Get parser options for a preview
3801 * @return ParserOptions
3803 protected function getPreviewParserOptions() {
3804 $parserOptions = $this->page
->makeParserOptions( $this->mArticle
->getContext() );
3805 $parserOptions->setIsPreview( true );
3806 $parserOptions->setIsSectionPreview( !is_null( $this->section
) && $this->section
!== '' );
3807 $parserOptions->enableLimitReport();
3808 return $parserOptions;
3812 * Parse the page for a preview. Subclasses may override this class, in order
3813 * to parse with different options, or to otherwise modify the preview HTML.
3815 * @param Content $content The page content
3816 * @return array with keys:
3817 * - parserOutput: The ParserOutput object
3818 * - html: The HTML to be displayed
3820 protected function doPreviewParse( Content
$content ) {
3822 $parserOptions = $this->getPreviewParserOptions();
3823 $pstContent = $content->preSaveTransform( $this->mTitle
, $wgUser, $parserOptions );
3824 $scopedCallback = $parserOptions->setupFakeRevision(
3825 $this->mTitle
, $pstContent, $wgUser );
3826 $parserOutput = $pstContent->getParserOutput( $this->mTitle
, null, $parserOptions );
3827 ScopedCallback
::consume( $scopedCallback );
3828 $parserOutput->setEditSectionTokens( false ); // no section edit links
3830 'parserOutput' => $parserOutput,
3831 'html' => $parserOutput->getText() ];
3837 function getTemplates() {
3838 if ( $this->preview ||
$this->section
!= '' ) {
3840 if ( !isset( $this->mParserOutput
) ) {
3843 foreach ( $this->mParserOutput
->getTemplates() as $ns => $template ) {
3844 foreach ( array_keys( $template ) as $dbk ) {
3845 $templates[] = Title
::makeTitle( $ns, $dbk );
3850 return $this->mTitle
->getTemplateLinksFrom();
3855 * Shows a bulletin board style toolbar for common editing functions.
3856 * It can be disabled in the user preferences.
3858 * @param Title $title Title object for the page being edited (optional)
3861 static function getEditToolbar( $title = null ) {
3862 global $wgContLang, $wgOut;
3863 global $wgEnableUploads, $wgForeignFileRepos;
3865 $imagesAvailable = $wgEnableUploads ||
count( $wgForeignFileRepos );
3866 $showSignature = true;
3868 $showSignature = MWNamespace
::wantSignatures( $title->getNamespace() );
3872 * $toolarray is an array of arrays each of which includes the
3873 * opening tag, the closing tag, optionally a sample text that is
3874 * inserted between the two when no selection is highlighted
3875 * and. The tip text is shown when the user moves the mouse
3878 * Images are defined in ResourceLoaderEditToolbarModule.
3882 'id' => 'mw-editbutton-bold',
3884 'close' => '\'\'\'',
3885 'sample' => wfMessage( 'bold_sample' )->text(),
3886 'tip' => wfMessage( 'bold_tip' )->text(),
3889 'id' => 'mw-editbutton-italic',
3892 'sample' => wfMessage( 'italic_sample' )->text(),
3893 'tip' => wfMessage( 'italic_tip' )->text(),
3896 'id' => 'mw-editbutton-link',
3899 'sample' => wfMessage( 'link_sample' )->text(),
3900 'tip' => wfMessage( 'link_tip' )->text(),
3903 'id' => 'mw-editbutton-extlink',
3906 'sample' => wfMessage( 'extlink_sample' )->text(),
3907 'tip' => wfMessage( 'extlink_tip' )->text(),
3910 'id' => 'mw-editbutton-headline',
3913 'sample' => wfMessage( 'headline_sample' )->text(),
3914 'tip' => wfMessage( 'headline_tip' )->text(),
3916 $imagesAvailable ?
[
3917 'id' => 'mw-editbutton-image',
3918 'open' => '[[' . $wgContLang->getNsText( NS_FILE
) . ':',
3920 'sample' => wfMessage( 'image_sample' )->text(),
3921 'tip' => wfMessage( 'image_tip' )->text(),
3923 $imagesAvailable ?
[
3924 'id' => 'mw-editbutton-media',
3925 'open' => '[[' . $wgContLang->getNsText( NS_MEDIA
) . ':',
3927 'sample' => wfMessage( 'media_sample' )->text(),
3928 'tip' => wfMessage( 'media_tip' )->text(),
3931 'id' => 'mw-editbutton-nowiki',
3932 'open' => "<nowiki>",
3933 'close' => "</nowiki>",
3934 'sample' => wfMessage( 'nowiki_sample' )->text(),
3935 'tip' => wfMessage( 'nowiki_tip' )->text(),
3938 'id' => 'mw-editbutton-signature',
3939 'open' => wfMessage( 'sig-text', '~~~~' )->inContentLanguage()->text(),
3942 'tip' => wfMessage( 'sig_tip' )->text(),
3945 'id' => 'mw-editbutton-hr',
3946 'open' => "\n----\n",
3949 'tip' => wfMessage( 'hr_tip' )->text(),
3953 $script = 'mw.loader.using("mediawiki.toolbar", function () {';
3954 foreach ( $toolarray as $tool ) {
3960 // Images are defined in ResourceLoaderEditToolbarModule
3962 // Note that we use the tip both for the ALT tag and the TITLE tag of the image.
3963 // Older browsers show a "speedtip" type message only for ALT.
3964 // Ideally these should be different, realistically they
3965 // probably don't need to be.
3973 $script .= Xml
::encodeJsCall(
3974 'mw.toolbar.addButton',
3976 ResourceLoader
::inDebugMode()
3981 $wgOut->addScript( ResourceLoader
::makeInlineScript( $script ) );
3983 $toolbar = '<div id="toolbar"></div>';
3985 Hooks
::run( 'EditPageBeforeEditToolbar', [ &$toolbar ] );
3991 * Returns an array of html code of the following checkboxes:
3994 * @param int $tabindex Current tabindex
3995 * @param array $checked Array of checkbox => bool, where bool indicates the checked
3996 * status of the checkbox
4000 public function getCheckboxes( &$tabindex, $checked ) {
4001 global $wgUser, $wgUseMediaWikiUIEverywhere;
4005 // don't show the minor edit checkbox if it's a new page or section
4006 if ( !$this->isNew
) {
4007 $checkboxes['minor'] = '';
4008 $minorLabel = wfMessage( 'minoredit' )->parse();
4009 if ( $wgUser->isAllowed( 'minoredit' ) ) {
4011 'tabindex' => ++
$tabindex,
4012 'accesskey' => wfMessage( 'accesskey-minoredit' )->text(),
4013 'id' => 'wpMinoredit',
4016 Xml
::check( 'wpMinoredit', $checked['minor'], $attribs ) .
4017 " <label for='wpMinoredit' id='mw-editpage-minoredit'" .
4018 Xml
::expandAttributes( [ 'title' => Linker
::titleAttrib( 'minoredit', 'withaccess' ) ] ) .
4019 ">{$minorLabel}</label>";
4021 if ( $wgUseMediaWikiUIEverywhere ) {
4022 $checkboxes['minor'] = Html
::openElement( 'div', [ 'class' => 'mw-ui-checkbox' ] ) .
4024 Html
::closeElement( 'div' );
4026 $checkboxes['minor'] = $minorEditHtml;
4031 $watchLabel = wfMessage( 'watchthis' )->parse();
4032 $checkboxes['watch'] = '';
4033 if ( $wgUser->isLoggedIn() ) {
4035 'tabindex' => ++
$tabindex,
4036 'accesskey' => wfMessage( 'accesskey-watch' )->text(),
4037 'id' => 'wpWatchthis',
4040 Xml
::check( 'wpWatchthis', $checked['watch'], $attribs ) .
4041 " <label for='wpWatchthis' id='mw-editpage-watch'" .
4042 Xml
::expandAttributes( [ 'title' => Linker
::titleAttrib( 'watch', 'withaccess' ) ] ) .
4043 ">{$watchLabel}</label>";
4044 if ( $wgUseMediaWikiUIEverywhere ) {
4045 $checkboxes['watch'] = Html
::openElement( 'div', [ 'class' => 'mw-ui-checkbox' ] ) .
4047 Html
::closeElement( 'div' );
4049 $checkboxes['watch'] = $watchThisHtml;
4052 Hooks
::run( 'EditPageBeforeEditChecks', [ &$this, &$checkboxes, &$tabindex ] );
4057 * Returns an array of html code of the following buttons:
4058 * save, diff, preview and live
4060 * @param int $tabindex Current tabindex
4064 public function getEditButtons( &$tabindex ) {
4067 $labelAsPublish = $this->mArticle
->getContext()->getConfig()->get( 'EditButtonPublishNotSave' );
4068 if ( $labelAsPublish ) {
4069 $buttonLabelKey = $this->isNew ?
'publishpage' : 'publishchanges';
4071 $buttonLabelKey = $this->isNew ?
'savearticle' : 'savechanges';
4073 $buttonLabel = wfMessage( $buttonLabelKey )->text();
4077 'tabindex' => ++
$tabindex,
4078 ] + Linker
::tooltipAndAccesskeyAttribs( 'save' );
4079 $buttons['save'] = Html
::submitButton( $buttonLabel, $attribs, [ 'mw-ui-constructive' ] );
4081 ++
$tabindex; // use the same for preview and live preview
4083 'id' => 'wpPreview',
4084 'name' => 'wpPreview',
4085 'tabindex' => $tabindex,
4086 ] + Linker
::tooltipAndAccesskeyAttribs( 'preview' );
4087 $buttons['preview'] = Html
::submitButton( wfMessage( 'showpreview' )->text(),
4089 $buttons['live'] = '';
4094 'tabindex' => ++
$tabindex,
4095 ] + Linker
::tooltipAndAccesskeyAttribs( 'diff' );
4096 $buttons['diff'] = Html
::submitButton( wfMessage( 'showdiff' )->text(),
4099 Hooks
::run( 'EditPageBeforeEditButtons', [ &$this, &$buttons, &$tabindex ] );
4104 * Creates a basic error page which informs the user that
4105 * they have attempted to edit a nonexistent section.
4107 function noSuchSectionPage() {
4110 $wgOut->prepareErrorPage( wfMessage( 'nosuchsectiontitle' ) );
4112 $res = wfMessage( 'nosuchsectiontext', $this->section
)->parseAsBlock();
4113 Hooks
::run( 'EditPageNoSuchSection', [ &$this, &$res ] );
4114 $wgOut->addHTML( $res );
4116 $wgOut->returnToMain( false, $this->mTitle
);
4120 * Show "your edit contains spam" page with your diff and text
4122 * @param string|array|bool $match Text (or array of texts) which triggered one or more filters
4124 public function spamPageWithContent( $match = false ) {
4125 global $wgOut, $wgLang;
4126 $this->textbox2
= $this->textbox1
;
4128 if ( is_array( $match ) ) {
4129 $match = $wgLang->listToText( $match );
4131 $wgOut->prepareErrorPage( wfMessage( 'spamprotectiontitle' ) );
4133 $wgOut->addHTML( '<div id="spamprotected">' );
4134 $wgOut->addWikiMsg( 'spamprotectiontext' );
4136 $wgOut->addWikiMsg( 'spamprotectionmatch', wfEscapeWikiText( $match ) );
4138 $wgOut->addHTML( '</div>' );
4140 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
4143 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
4144 $this->showTextbox2();
4146 $wgOut->addReturnTo( $this->getContextTitle(), [ 'action' => 'edit' ] );
4150 * Check if the browser is on a blacklist of user-agents known to
4151 * mangle UTF-8 data on form submission. Returns true if Unicode
4152 * should make it through, false if it's known to be a problem.
4155 private function checkUnicodeCompliantBrowser() {
4156 global $wgBrowserBlackList, $wgRequest;
4158 $currentbrowser = $wgRequest->getHeader( 'User-Agent' );
4159 if ( $currentbrowser === false ) {
4160 // No User-Agent header sent? Trust it by default...
4164 foreach ( $wgBrowserBlackList as $browser ) {
4165 if ( preg_match( $browser, $currentbrowser ) ) {
4173 * Filter an input field through a Unicode de-armoring process if it
4174 * came from an old browser with known broken Unicode editing issues.
4176 * @param WebRequest $request
4177 * @param string $field
4180 protected function safeUnicodeInput( $request, $field ) {
4181 $text = rtrim( $request->getText( $field ) );
4182 return $request->getBool( 'safemode' )
4183 ?
$this->unmakeSafe( $text )
4188 * Filter an output field through a Unicode armoring process if it is
4189 * going to an old browser with known broken Unicode editing issues.
4191 * @param string $text
4194 protected function safeUnicodeOutput( $text ) {
4195 return $this->checkUnicodeCompliantBrowser()
4197 : $this->makesafe( $text );
4201 * A number of web browsers are known to corrupt non-ASCII characters
4202 * in a UTF-8 text editing environment. To protect against this,
4203 * detected browsers will be served an armored version of the text,
4204 * with non-ASCII chars converted to numeric HTML character references.
4206 * Preexisting such character references will have a 0 added to them
4207 * to ensure that round-trips do not alter the original data.
4209 * @param string $invalue
4212 private function makeSafe( $invalue ) {
4213 // Armor existing references for reversibility.
4214 $invalue = strtr( $invalue, [ "&#x" => "�" ] );
4219 $valueLength = strlen( $invalue );
4220 for ( $i = 0; $i < $valueLength; $i++
) {
4221 $bytevalue = ord( $invalue[$i] );
4222 if ( $bytevalue <= 0x7F ) { // 0xxx xxxx
4223 $result .= chr( $bytevalue );
4225 } elseif ( $bytevalue <= 0xBF ) { // 10xx xxxx
4226 $working = $working << 6;
4227 $working +
= ( $bytevalue & 0x3F );
4229 if ( $bytesleft <= 0 ) {
4230 $result .= "&#x" . strtoupper( dechex( $working ) ) . ";";
4232 } elseif ( $bytevalue <= 0xDF ) { // 110x xxxx
4233 $working = $bytevalue & 0x1F;
4235 } elseif ( $bytevalue <= 0xEF ) { // 1110 xxxx
4236 $working = $bytevalue & 0x0F;
4238 } else { // 1111 0xxx
4239 $working = $bytevalue & 0x07;
4247 * Reverse the previously applied transliteration of non-ASCII characters
4248 * back to UTF-8. Used to protect data from corruption by broken web browsers
4249 * as listed in $wgBrowserBlackList.
4251 * @param string $invalue
4254 private function unmakeSafe( $invalue ) {
4256 $valueLength = strlen( $invalue );
4257 for ( $i = 0; $i < $valueLength; $i++
) {
4258 if ( ( substr( $invalue, $i, 3 ) == "&#x" ) && ( $invalue[$i +
3] != '0' ) ) {
4262 $hexstring .= $invalue[$i];
4264 } while ( ctype_xdigit( $invalue[$i] ) && ( $i < strlen( $invalue ) ) );
4266 // Do some sanity checks. These aren't needed for reversibility,
4267 // but should help keep the breakage down if the editor
4268 // breaks one of the entities whilst editing.
4269 if ( ( substr( $invalue, $i, 1 ) == ";" ) && ( strlen( $hexstring ) <= 6 ) ) {
4270 $codepoint = hexdec( $hexstring );
4271 $result .= UtfNormal\Utils
::codepointToUtf8( $codepoint );
4273 $result .= "&#x" . $hexstring . substr( $invalue, $i, 1 );
4276 $result .= substr( $invalue, $i, 1 );
4279 // reverse the transform that we made for reversibility reasons.
4280 return strtr( $result, [ "�" => "&#x" ] );