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
24 * The edit page/HTML interface (split from Article)
25 * The actual database and text munging is still in Article,
26 * but it should get easier to call those from alternate
29 * EditPage cares about two distinct titles:
30 * $this->mContextTitle is the page that forms submit to, links point to,
31 * redirects go to, etc. $this->mTitle (as well as $mArticle) is the
32 * page in the database that is actually being edited. These are
33 * usually the same, but they are now allowed to be different.
35 * Surgeon General's Warning: prolonged exposure to this class is known to cause
36 * headaches, which may be fatal.
40 * Status: Article successfully updated
42 const AS_SUCCESS_UPDATE
= 200;
45 * Status: Article successfully created
47 const AS_SUCCESS_NEW_ARTICLE
= 201;
50 * Status: Article update aborted by a hook function
52 const AS_HOOK_ERROR
= 210;
55 * Status: A hook function returned an error
57 const AS_HOOK_ERROR_EXPECTED
= 212;
60 * Status: User is blocked from editing this page
62 const AS_BLOCKED_PAGE_FOR_USER
= 215;
65 * Status: Content too big (> $wgMaxArticleSize)
67 const AS_CONTENT_TOO_BIG
= 216;
70 * Status: this anonymous user is not allowed to edit this page
72 const AS_READ_ONLY_PAGE_ANON
= 218;
75 * Status: this logged in user is not allowed to edit this page
77 const AS_READ_ONLY_PAGE_LOGGED
= 219;
80 * Status: wiki is in readonly mode (wfReadOnly() == true)
82 const AS_READ_ONLY_PAGE
= 220;
85 * Status: rate limiter for action 'edit' was tripped
87 const AS_RATE_LIMITED
= 221;
90 * Status: article was deleted while editing and param wpRecreate == false or form
93 const AS_ARTICLE_WAS_DELETED
= 222;
96 * Status: user tried to create this page, but is not allowed to do that
97 * ( Title->userCan('create') == false )
99 const AS_NO_CREATE_PERMISSION
= 223;
102 * Status: user tried to create a blank page and wpIgnoreBlankArticle == false
104 const AS_BLANK_ARTICLE
= 224;
107 * Status: (non-resolvable) edit conflict
109 const AS_CONFLICT_DETECTED
= 225;
112 * Status: no edit summary given and the user has forceeditsummary set and the user is not
113 * editing in his own userspace or talkspace and wpIgnoreBlankSummary == false
115 const AS_SUMMARY_NEEDED
= 226;
118 * Status: user tried to create a new section without content
120 const AS_TEXTBOX_EMPTY
= 228;
123 * Status: article is too big (> $wgMaxArticleSize), after merging in the new section
125 const AS_MAX_ARTICLE_SIZE_EXCEEDED
= 229;
128 * Status: WikiPage::doEdit() was unsuccessful
133 * Status: summary contained spam according to one of the regexes in $wgSummarySpamRegex
135 const AS_SPAM_ERROR
= 232;
138 * Status: anonymous user is not allowed to upload (User::isAllowed('upload') == false)
140 const AS_IMAGE_REDIRECT_ANON
= 233;
143 * Status: logged in user is not allowed to upload (User::isAllowed('upload') == false)
145 const AS_IMAGE_REDIRECT_LOGGED
= 234;
148 * Status: user tried to modify the content model, but is not allowed to do that
149 * ( User::isAllowed('editcontentmodel') == false )
151 const AS_NO_CHANGE_CONTENT_MODEL
= 235;
154 * Status: user tried to create self-redirect (redirect to the same article) and
155 * wpIgnoreSelfRedirect == false
157 const AS_SELF_REDIRECT
= 236;
160 * Status: an error relating to change tagging. Look at the message key for
163 const AS_CHANGE_TAG_ERROR
= 237;
166 * Status: can't parse content
168 const AS_PARSE_ERROR
= 240;
171 * Status: when changing the content model is disallowed due to
172 * $wgContentHandlerUseDB being false
174 const AS_CANNOT_USE_CUSTOM_MODEL
= 241;
177 * HTML id and name for the beginning of the edit form.
179 const EDITFORM_ID
= 'editform';
182 * Prefix of key for cookie used to pass post-edit state.
183 * The revision id edited is added after this
185 const POST_EDIT_COOKIE_KEY_PREFIX
= 'PostEditRevision';
188 * Duration of PostEdit cookie, in seconds.
189 * The cookie will be removed instantly if the JavaScript runs.
191 * Otherwise, though, we don't want the cookies to accumulate.
192 * RFC 2109 ( https://www.ietf.org/rfc/rfc2109.txt ) specifies a possible
193 * limit of only 20 cookies per domain. This still applies at least to some
194 * versions of IE without full updates:
195 * https://blogs.msdn.com/b/ieinternals/archive/2009/08/20/wininet-ie-cookie-internals-faq.aspx
197 * A value of 20 minutes should be enough to take into account slow loads and minor
198 * clock skew while still avoiding cookie accumulation when JavaScript is turned off.
200 const POST_EDIT_COOKIE_DURATION
= 1200;
210 /** @var null|Title */
211 private $mContextTitle = null;
214 public $action = 'submit';
217 public $isConflict = false;
220 public $isCssJsSubpage = false;
223 public $isCssSubpage = false;
226 public $isJsSubpage = false;
229 public $isWrongCaseCssJsPage = false;
231 /** @var bool New page or new section */
232 public $isNew = false;
235 public $deletedSinceEdit;
243 /** @var bool|stdClass */
247 public $mTokenOk = false;
250 public $mTokenOkExceptSuffix = false;
253 public $mTriedSave = false;
256 public $incompleteForm = false;
259 public $tooBig = false;
262 public $kblength = false;
265 public $missingComment = false;
268 public $missingSummary = false;
271 public $allowBlankSummary = false;
274 protected $blankArticle = false;
277 protected $allowBlankArticle = false;
280 protected $selfRedirect = false;
283 protected $allowSelfRedirect = false;
286 public $autoSumm = '';
289 public $hookError = '';
291 /** @var ParserOutput */
292 public $mParserOutput;
294 /** @var bool Has a summary been preset using GET parameter &summary= ? */
295 public $hasPresetSummary = false;
298 public $mBaseRevision = false;
301 public $mShowSummaryField = true;
306 public $save = false;
309 public $preview = false;
312 public $diff = false;
315 public $minoredit = false;
318 public $watchthis = false;
321 public $recreate = false;
324 public $textbox1 = '';
327 public $textbox2 = '';
330 public $summary = '';
333 public $nosummary = false;
336 public $edittime = '';
339 public $section = '';
342 public $sectiontitle = '';
345 public $starttime = '';
351 public $parentRevId = 0;
354 public $editintro = '';
357 public $scrolltop = null;
362 /** @var null|string */
363 public $contentModel = null;
365 /** @var null|string */
366 public $contentFormat = null;
368 /** @var null|array */
369 private $changeTags = null;
371 # Placeholders for text injection by hooks (must be HTML)
372 # extensions should take care to _append_ to the present value
374 /** @var string Before even the preview */
375 public $editFormPageTop = '';
376 public $editFormTextTop = '';
377 public $editFormTextBeforeContent = '';
378 public $editFormTextAfterWarn = '';
379 public $editFormTextAfterTools = '';
380 public $editFormTextBottom = '';
381 public $editFormTextAfterContent = '';
382 public $previewTextAfterContent = '';
383 public $mPreloadContent = null;
385 /* $didSave should be set to true whenever an article was successfully altered. */
386 public $didSave = false;
387 public $undidRev = 0;
389 public $suppressIntro = false;
395 * @var bool Set in ApiEditPage, based on ContentHandler::allowsDirectApiEditing
397 private $enableApiEditOverride = false;
400 * @param Article $article
402 public function __construct( Article
$article ) {
403 $this->mArticle
= $article;
404 $this->page
= $article->getPage(); // model object
405 $this->mTitle
= $article->getTitle();
407 $this->contentModel
= $this->mTitle
->getContentModel();
409 $handler = ContentHandler
::getForModelID( $this->contentModel
);
410 $this->contentFormat
= $handler->getDefaultFormat();
416 public function getArticle() {
417 return $this->mArticle
;
424 public function getTitle() {
425 return $this->mTitle
;
429 * Set the context Title object
431 * @param Title|null $title Title object or null
433 public function setContextTitle( $title ) {
434 $this->mContextTitle
= $title;
438 * Get the context title object.
439 * If not set, $wgTitle will be returned. This behavior might change in
440 * the future to return $this->mTitle instead.
444 public function getContextTitle() {
445 if ( is_null( $this->mContextTitle
) ) {
449 return $this->mContextTitle
;
454 * Returns if the given content model is editable.
456 * @param string $modelId The ID of the content model to test. Use CONTENT_MODEL_XXX constants.
458 * @throws MWException If $modelId has no known handler
460 public function isSupportedContentModel( $modelId ) {
461 return $this->enableApiEditOverride
=== true ||
462 ContentHandler
::getForModelID( $modelId )->supportsDirectEditing();
466 * Allow editing of content that supports API direct editing, but not general
467 * direct editing. Set to false by default.
469 * @param bool $enableOverride
471 public function setApiEditOverride( $enableOverride ) {
472 $this->enableApiEditOverride
= $enableOverride;
480 * This is the function that gets called for "action=edit". It
481 * sets up various member variables, then passes execution to
482 * another function, usually showEditForm()
484 * The edit form is self-submitting, so that when things like
485 * preview and edit conflicts occur, we get the same form back
486 * with the extra stuff added. Only when the final submission
487 * is made and all is well do we actually save and redirect to
488 * the newly-edited page.
491 global $wgOut, $wgRequest, $wgUser;
492 // Allow extensions to modify/prevent this form or submission
493 if ( !Hooks
::run( 'AlternateEdit', [ $this ] ) ) {
497 wfDebug( __METHOD__
. ": enter\n" );
499 // If they used redlink=1 and the page exists, redirect to the main article
500 if ( $wgRequest->getBool( 'redlink' ) && $this->mTitle
->exists() ) {
501 $wgOut->redirect( $this->mTitle
->getFullURL() );
505 $this->importFormData( $wgRequest );
506 $this->firsttime
= false;
508 if ( wfReadOnly() && $this->save
) {
511 $this->preview
= true;
515 $this->formtype
= 'save';
516 } elseif ( $this->preview
) {
517 $this->formtype
= 'preview';
518 } elseif ( $this->diff
) {
519 $this->formtype
= 'diff';
520 } else { # First time through
521 $this->firsttime
= true;
522 if ( $this->previewOnOpen() ) {
523 $this->formtype
= 'preview';
525 $this->formtype
= 'initial';
529 $permErrors = $this->getEditPermissionErrors( $this->save ?
'secure' : 'full' );
531 wfDebug( __METHOD__
. ": User can't edit\n" );
532 // Auto-block user's IP if the account was "hard" blocked
533 if ( !wfReadOnly() ) {
535 DeferredUpdates
::addCallableUpdate( function () use ( $user ) {
536 $user->spreadAnyEditBlock();
539 $this->displayPermissionsError( $permErrors );
544 $revision = $this->mArticle
->getRevisionFetched();
545 // Disallow editing revisions with content models different from the current one
546 if ( $revision && $revision->getContentModel() !== $this->contentModel
) {
547 $this->displayViewSourcePage(
548 $this->getContentObject(),
550 'contentmodelediterror',
551 $revision->getContentModel(),
558 $this->isConflict
= false;
559 // css / js subpages of user pages get a special treatment
560 $this->isCssJsSubpage
= $this->mTitle
->isCssJsSubpage();
561 $this->isCssSubpage
= $this->mTitle
->isCssSubpage();
562 $this->isJsSubpage
= $this->mTitle
->isJsSubpage();
563 // @todo FIXME: Silly assignment.
564 $this->isWrongCaseCssJsPage
= $this->isWrongCaseCssJsPage();
566 # Show applicable editing introductions
567 if ( $this->formtype
== 'initial' ||
$this->firsttime
) {
571 # Attempt submission here. This will check for edit conflicts,
572 # and redundantly check for locked database, blocked IPs, etc.
573 # that edit() already checked just in case someone tries to sneak
574 # in the back door with a hand-edited submission URL.
576 if ( 'save' == $this->formtype
) {
577 $resultDetails = null;
578 $status = $this->attemptSave( $resultDetails );
579 if ( !$this->handleStatus( $status, $resultDetails ) ) {
584 # First time through: get contents, set time for conflict
586 if ( 'initial' == $this->formtype ||
$this->firsttime
) {
587 if ( $this->initialiseForm() === false ) {
588 $this->noSuchSectionPage();
592 if ( !$this->mTitle
->getArticleID() ) {
593 Hooks
::run( 'EditFormPreloadText', [ &$this->textbox1
, &$this->mTitle
] );
595 Hooks
::run( 'EditFormInitialText', [ $this ] );
600 $this->showEditForm();
604 * @param string $rigor Same format as Title::getUserPermissionErrors()
607 protected function getEditPermissionErrors( $rigor = 'secure' ) {
610 $permErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $wgUser, $rigor );
611 # Can this title be created?
612 if ( !$this->mTitle
->exists() ) {
613 $permErrors = array_merge(
616 $this->mTitle
->getUserPermissionsErrors( 'create', $wgUser, $rigor ),
621 # Ignore some permissions errors when a user is just previewing/viewing diffs
623 foreach ( $permErrors as $error ) {
624 if ( ( $this->preview ||
$this->diff
)
625 && ( $error[0] == 'blockedtext' ||
$error[0] == 'autoblockedtext' )
630 $permErrors = wfArrayDiff2( $permErrors, $remove );
636 * Display a permissions error page, like OutputPage::showPermissionsErrorPage(),
637 * but with the following differences:
638 * - If redlink=1, the user will be redirected to the page
639 * - If there is content to display or the error occurs while either saving,
640 * previewing or showing the difference, it will be a
641 * "View source for ..." page displaying the source code after the error message.
644 * @param array $permErrors Array of permissions errors, as returned by
645 * Title::getUserPermissionsErrors().
646 * @throws PermissionsError
648 protected function displayPermissionsError( array $permErrors ) {
649 global $wgRequest, $wgOut;
651 if ( $wgRequest->getBool( 'redlink' ) ) {
652 // The edit page was reached via a red link.
653 // Redirect to the article page and let them click the edit tab if
654 // they really want a permission error.
655 $wgOut->redirect( $this->mTitle
->getFullURL() );
659 $content = $this->getContentObject();
661 # Use the normal message if there's nothing to display
662 if ( $this->firsttime
&& ( !$content ||
$content->isEmpty() ) ) {
663 $action = $this->mTitle
->exists() ?
'edit' :
664 ( $this->mTitle
->isTalkPage() ?
'createtalk' : 'createpage' );
665 throw new PermissionsError( $action, $permErrors );
668 $this->displayViewSourcePage(
670 $wgOut->formatPermissionsErrorMessage( $permErrors, 'edit' )
675 * Display a read-only View Source page
676 * @param Content $content content object
677 * @param string $errorMessage additional wikitext error message to display
679 protected function displayViewSourcePage( Content
$content, $errorMessage = '' ) {
682 Hooks
::run( 'EditPage::showReadOnlyForm:initial', [ $this, &$wgOut ] );
684 $wgOut->setRobotPolicy( 'noindex,nofollow' );
685 $wgOut->setPageTitle( wfMessage(
687 $this->getContextTitle()->getPrefixedText()
689 $wgOut->addBacklinkSubtitle( $this->getContextTitle() );
690 $wgOut->addHTML( $this->editFormPageTop
);
691 $wgOut->addHTML( $this->editFormTextTop
);
693 if ( $errorMessage !== '' ) {
694 $wgOut->addWikiText( $errorMessage );
695 $wgOut->addHTML( "<hr />\n" );
698 # If the user made changes, preserve them when showing the markup
699 # (This happens when a user is blocked during edit, for instance)
700 if ( !$this->firsttime
) {
701 $text = $this->textbox1
;
702 $wgOut->addWikiMsg( 'viewyourtext' );
705 $text = $this->toEditText( $content );
706 } catch ( MWException
$e ) {
707 # Serialize using the default format if the content model is not supported
708 # (e.g. for an old revision with a different model)
709 $text = $content->serialize();
711 $wgOut->addWikiMsg( 'viewsourcetext' );
714 $wgOut->addHTML( $this->editFormTextBeforeContent
);
715 $this->showTextbox( $text, 'wpTextbox1', [ 'readonly' ] );
716 $wgOut->addHTML( $this->editFormTextAfterContent
);
718 $wgOut->addHTML( Html
::rawElement( 'div', [ 'class' => 'templatesUsed' ],
719 Linker
::formatTemplates( $this->getTemplates() ) ) );
721 $wgOut->addModules( 'mediawiki.action.edit.collapsibleFooter' );
723 $wgOut->addHTML( $this->editFormTextBottom
);
724 if ( $this->mTitle
->exists() ) {
725 $wgOut->returnToMain( null, $this->mTitle
);
730 * Should we show a preview when the edit form is first shown?
734 protected function previewOnOpen() {
735 global $wgRequest, $wgUser, $wgPreviewOnOpenNamespaces;
736 if ( $wgRequest->getVal( 'preview' ) == 'yes' ) {
737 // Explicit override from request
739 } elseif ( $wgRequest->getVal( 'preview' ) == 'no' ) {
740 // Explicit override from request
742 } elseif ( $this->section
== 'new' ) {
743 // Nothing *to* preview for new sections
745 } elseif ( ( $wgRequest->getVal( 'preload' ) !== null ||
$this->mTitle
->exists() )
746 && $wgUser->getOption( 'previewonfirst' )
748 // Standard preference behavior
750 } elseif ( !$this->mTitle
->exists()
751 && isset( $wgPreviewOnOpenNamespaces[$this->mTitle
->getNamespace()] )
752 && $wgPreviewOnOpenNamespaces[$this->mTitle
->getNamespace()]
754 // Categories are special
762 * Checks whether the user entered a skin name in uppercase,
763 * e.g. "User:Example/Monobook.css" instead of "monobook.css"
767 protected function isWrongCaseCssJsPage() {
768 if ( $this->mTitle
->isCssJsSubpage() ) {
769 $name = $this->mTitle
->getSkinFromCssJsSubpage();
770 $skins = array_merge(
771 array_keys( Skin
::getSkinNames() ),
774 return !in_array( $name, $skins )
775 && in_array( strtolower( $name ), $skins );
782 * Returns whether section editing is supported for the current page.
783 * Subclasses may override this to replace the default behavior, which is
784 * to check ContentHandler::supportsSections.
786 * @return bool True if this edit page supports sections, false otherwise.
788 protected function isSectionEditSupported() {
789 $contentHandler = ContentHandler
::getForTitle( $this->mTitle
);
790 return $contentHandler->supportsSections();
794 * This function collects the form data and uses it to populate various member variables.
795 * @param WebRequest $request
796 * @throws ErrorPageError
798 function importFormData( &$request ) {
799 global $wgContLang, $wgUser;
801 # Section edit can come from either the form or a link
802 $this->section
= $request->getVal( 'wpSection', $request->getVal( 'section' ) );
804 if ( $this->section
!== null && $this->section
!== '' && !$this->isSectionEditSupported() ) {
805 throw new ErrorPageError( 'sectioneditnotsupported-title', 'sectioneditnotsupported-text' );
808 $this->isNew
= !$this->mTitle
->exists() ||
$this->section
== 'new';
810 if ( $request->wasPosted() ) {
811 # These fields need to be checked for encoding.
812 # Also remove trailing whitespace, but don't remove _initial_
813 # whitespace from the text boxes. This may be significant formatting.
814 $this->textbox1
= $this->safeUnicodeInput( $request, 'wpTextbox1' );
815 if ( !$request->getCheck( 'wpTextbox2' ) ) {
816 // Skip this if wpTextbox2 has input, it indicates that we came
817 // from a conflict page with raw page text, not a custom form
818 // modified by subclasses
819 $textbox1 = $this->importContentFormData( $request );
820 if ( $textbox1 !== null ) {
821 $this->textbox1
= $textbox1;
825 # Truncate for whole multibyte characters
826 $this->summary
= $wgContLang->truncate( $request->getText( 'wpSummary' ), 255 );
828 # If the summary consists of a heading, e.g. '==Foobar==', extract the title from the
829 # header syntax, e.g. 'Foobar'. This is mainly an issue when we are using wpSummary for
831 $this->summary
= preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->summary
);
833 # Treat sectiontitle the same way as summary.
834 # Note that wpSectionTitle is not yet a part of the actual edit form, as wpSummary is
835 # currently doing double duty as both edit summary and section title. Right now this
836 # is just to allow API edits to work around this limitation, but this should be
837 # incorporated into the actual edit form when EditPage is rewritten (Bugs 18654, 26312).
838 $this->sectiontitle
= $wgContLang->truncate( $request->getText( 'wpSectionTitle' ), 255 );
839 $this->sectiontitle
= preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->sectiontitle
);
841 $this->edittime
= $request->getVal( 'wpEdittime' );
842 $this->starttime
= $request->getVal( 'wpStarttime' );
844 $undidRev = $request->getInt( 'wpUndidRevision' );
846 $this->undidRev
= $undidRev;
849 $this->scrolltop
= $request->getIntOrNull( 'wpScrolltop' );
851 if ( $this->textbox1
=== '' && $request->getVal( 'wpTextbox1' ) === null ) {
852 // wpTextbox1 field is missing, possibly due to being "too big"
853 // according to some filter rules such as Suhosin's setting for
854 // suhosin.request.max_value_length (d'oh)
855 $this->incompleteForm
= true;
857 // If we receive the last parameter of the request, we can fairly
858 // claim the POST request has not been truncated.
860 // TODO: softened the check for cutover. Once we determine
861 // that it is safe, we should complete the transition by
862 // removing the "edittime" clause.
863 $this->incompleteForm
= ( !$request->getVal( 'wpUltimateParam' )
864 && is_null( $this->edittime
) );
866 if ( $this->incompleteForm
) {
867 # If the form is incomplete, force to preview.
868 wfDebug( __METHOD__
. ": Form data appears to be incomplete\n" );
869 wfDebug( "POST DATA: " . var_export( $_POST, true ) . "\n" );
870 $this->preview
= true;
872 $this->preview
= $request->getCheck( 'wpPreview' );
873 $this->diff
= $request->getCheck( 'wpDiff' );
875 // Remember whether a save was requested, so we can indicate
876 // if we forced preview due to session failure.
877 $this->mTriedSave
= !$this->preview
;
879 if ( $this->tokenOk( $request ) ) {
880 # Some browsers will not report any submit button
881 # if the user hits enter in the comment box.
882 # The unmarked state will be assumed to be a save,
883 # if the form seems otherwise complete.
884 wfDebug( __METHOD__
. ": Passed token check.\n" );
885 } elseif ( $this->diff
) {
886 # Failed token check, but only requested "Show Changes".
887 wfDebug( __METHOD__
. ": Failed token check; Show Changes requested.\n" );
889 # Page might be a hack attempt posted from
890 # an external site. Preview instead of saving.
891 wfDebug( __METHOD__
. ": Failed token check; forcing preview\n" );
892 $this->preview
= true;
895 $this->save
= !$this->preview
&& !$this->diff
;
896 if ( !preg_match( '/^\d{14}$/', $this->edittime
) ) {
897 $this->edittime
= null;
900 if ( !preg_match( '/^\d{14}$/', $this->starttime
) ) {
901 $this->starttime
= null;
904 $this->recreate
= $request->getCheck( 'wpRecreate' );
906 $this->minoredit
= $request->getCheck( 'wpMinoredit' );
907 $this->watchthis
= $request->getCheck( 'wpWatchthis' );
909 # Don't force edit summaries when a user is editing their own user or talk page
910 if ( ( $this->mTitle
->mNamespace
== NS_USER ||
$this->mTitle
->mNamespace
== NS_USER_TALK
)
911 && $this->mTitle
->getText() == $wgUser->getName()
913 $this->allowBlankSummary
= true;
915 $this->allowBlankSummary
= $request->getBool( 'wpIgnoreBlankSummary' )
916 ||
!$wgUser->getOption( 'forceeditsummary' );
919 $this->autoSumm
= $request->getText( 'wpAutoSummary' );
921 $this->allowBlankArticle
= $request->getBool( 'wpIgnoreBlankArticle' );
922 $this->allowSelfRedirect
= $request->getBool( 'wpIgnoreSelfRedirect' );
924 $changeTags = $request->getVal( 'wpChangeTags' );
925 if ( is_null( $changeTags ) ||
$changeTags === '' ) {
926 $this->changeTags
= [];
928 $this->changeTags
= array_filter( array_map( 'trim', explode( ',',
932 # Not a posted form? Start with nothing.
933 wfDebug( __METHOD__
. ": Not a posted form.\n" );
934 $this->textbox1
= '';
936 $this->sectiontitle
= '';
937 $this->edittime
= '';
938 $this->starttime
= wfTimestampNow();
940 $this->preview
= false;
943 $this->minoredit
= false;
944 // Watch may be overridden by request parameters
945 $this->watchthis
= $request->getBool( 'watchthis', false );
946 $this->recreate
= false;
948 // When creating a new section, we can preload a section title by passing it as the
949 // preloadtitle parameter in the URL (Bug 13100)
950 if ( $this->section
== 'new' && $request->getVal( 'preloadtitle' ) ) {
951 $this->sectiontitle
= $request->getVal( 'preloadtitle' );
952 // Once wpSummary isn't being use for setting section titles, we should delete this.
953 $this->summary
= $request->getVal( 'preloadtitle' );
954 } elseif ( $this->section
!= 'new' && $request->getVal( 'summary' ) ) {
955 $this->summary
= $request->getText( 'summary' );
956 if ( $this->summary
!== '' ) {
957 $this->hasPresetSummary
= true;
961 if ( $request->getVal( 'minor' ) ) {
962 $this->minoredit
= true;
966 $this->oldid
= $request->getInt( 'oldid' );
967 $this->parentRevId
= $request->getInt( 'parentRevId' );
969 $this->bot
= $request->getBool( 'bot', true );
970 $this->nosummary
= $request->getBool( 'nosummary' );
972 // May be overridden by revision.
973 $this->contentModel
= $request->getText( 'model', $this->contentModel
);
974 // May be overridden by revision.
975 $this->contentFormat
= $request->getText( 'format', $this->contentFormat
);
977 if ( !ContentHandler
::getForModelID( $this->contentModel
)
978 ->isSupportedFormat( $this->contentFormat
)
980 throw new ErrorPageError(
981 'editpage-notsupportedcontentformat-title',
982 'editpage-notsupportedcontentformat-text',
983 [ $this->contentFormat
, ContentHandler
::getLocalizedName( $this->contentModel
) ]
988 * @todo Check if the desired model is allowed in this namespace, and if
989 * a transition from the page's current model to the new model is
993 $this->editintro
= $request->getText( 'editintro',
994 // Custom edit intro for new sections
995 $this->section
=== 'new' ?
'MediaWiki:addsection-editintro' : '' );
997 // Allow extensions to modify form data
998 Hooks
::run( 'EditPage::importFormData', [ $this, $request ] );
1003 * Subpage overridable method for extracting the page content data from the
1004 * posted form to be placed in $this->textbox1, if using customized input
1005 * this method should be overridden and return the page text that will be used
1006 * for saving, preview parsing and so on...
1008 * @param WebRequest $request
1009 * @return string|null
1011 protected function importContentFormData( &$request ) {
1012 return; // Don't do anything, EditPage already extracted wpTextbox1
1016 * Initialise form fields in the object
1017 * Called on the first invocation, e.g. when a user clicks an edit link
1018 * @return bool If the requested section is valid
1020 function initialiseForm() {
1022 $this->edittime
= $this->page
->getTimestamp();
1024 $content = $this->getContentObject( false ); # TODO: track content object?!
1025 if ( $content === false ) {
1028 $this->textbox1
= $this->toEditText( $content );
1030 // activate checkboxes if user wants them to be always active
1031 # Sort out the "watch" checkbox
1032 if ( $wgUser->getOption( 'watchdefault' ) ) {
1034 $this->watchthis
= true;
1035 } elseif ( $wgUser->getOption( 'watchcreations' ) && !$this->mTitle
->exists() ) {
1037 $this->watchthis
= true;
1038 } elseif ( $wgUser->isWatched( $this->mTitle
) ) {
1040 $this->watchthis
= true;
1042 if ( $wgUser->getOption( 'minordefault' ) && !$this->isNew
) {
1043 $this->minoredit
= true;
1045 if ( $this->textbox1
=== false ) {
1052 * @param Content|null $def_content The default value to return
1054 * @return Content|null Content on success, $def_content for invalid sections
1058 protected function getContentObject( $def_content = null ) {
1059 global $wgOut, $wgRequest, $wgUser, $wgContLang;
1063 // For message page not locally set, use the i18n message.
1064 // For other non-existent articles, use preload text if any.
1065 if ( !$this->mTitle
->exists() ||
$this->section
== 'new' ) {
1066 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
&& $this->section
!= 'new' ) {
1067 # If this is a system message, get the default text.
1068 $msg = $this->mTitle
->getDefaultMessageText();
1070 $content = $this->toEditContent( $msg );
1072 if ( $content === false ) {
1073 # If requested, preload some text.
1074 $preload = $wgRequest->getVal( 'preload',
1075 // Custom preload text for new sections
1076 $this->section
=== 'new' ?
'MediaWiki:addsection-preload' : '' );
1077 $params = $wgRequest->getArray( 'preloadparams', [] );
1079 $content = $this->getPreloadedContent( $preload, $params );
1081 // For existing pages, get text based on "undo" or section parameters.
1083 if ( $this->section
!= '' ) {
1084 // Get section edit text (returns $def_text for invalid sections)
1085 $orig = $this->getOriginalContent( $wgUser );
1086 $content = $orig ?
$orig->getSection( $this->section
) : null;
1089 $content = $def_content;
1092 $undoafter = $wgRequest->getInt( 'undoafter' );
1093 $undo = $wgRequest->getInt( 'undo' );
1095 if ( $undo > 0 && $undoafter > 0 ) {
1096 $undorev = Revision
::newFromId( $undo );
1097 $oldrev = Revision
::newFromId( $undoafter );
1099 # Sanity check, make sure it's the right page,
1100 # the revisions exist and they were not deleted.
1101 # Otherwise, $content will be left as-is.
1102 if ( !is_null( $undorev ) && !is_null( $oldrev ) &&
1103 !$undorev->isDeleted( Revision
::DELETED_TEXT
) &&
1104 !$oldrev->isDeleted( Revision
::DELETED_TEXT
)
1106 $content = $this->page
->getUndoContent( $undorev, $oldrev );
1108 if ( $content === false ) {
1109 # Warn the user that something went wrong
1110 $undoMsg = 'failure';
1112 $oldContent = $this->page
->getContent( Revision
::RAW
);
1113 $popts = ParserOptions
::newFromUserAndLang( $wgUser, $wgContLang );
1114 $newContent = $content->preSaveTransform( $this->mTitle
, $wgUser, $popts );
1116 if ( $newContent->equals( $oldContent ) ) {
1117 # Tell the user that the undo results in no change,
1118 # i.e. the revisions were already undone.
1119 $undoMsg = 'nochange';
1122 # Inform the user of our success and set an automatic edit summary
1123 $undoMsg = 'success';
1125 # If we just undid one rev, use an autosummary
1126 $firstrev = $oldrev->getNext();
1127 if ( $firstrev && $firstrev->getId() == $undo ) {
1128 $userText = $undorev->getUserText();
1129 if ( $userText === '' ) {
1130 $undoSummary = wfMessage(
1131 'undo-summary-username-hidden',
1133 )->inContentLanguage()->text();
1135 $undoSummary = wfMessage(
1139 )->inContentLanguage()->text();
1141 if ( $this->summary
=== '' ) {
1142 $this->summary
= $undoSummary;
1144 $this->summary
= $undoSummary . wfMessage( 'colon-separator' )
1145 ->inContentLanguage()->text() . $this->summary
;
1147 $this->undidRev
= $undo;
1149 $this->formtype
= 'diff';
1153 // Failed basic sanity checks.
1154 // Older revisions may have been removed since the link
1155 // was created, or we may simply have got bogus input.
1159 // Messages: undo-success, undo-failure, undo-norev, undo-nochange
1160 $class = ( $undoMsg == 'success' ?
'' : 'error ' ) . "mw-undo-{$undoMsg}";
1161 $this->editFormPageTop
.= $wgOut->parse( "<div class=\"{$class}\">" .
1162 wfMessage( 'undo-' . $undoMsg )->plain() . '</div>', true, /* interface */true );
1165 if ( $content === false ) {
1166 $content = $this->getOriginalContent( $wgUser );
1175 * Get the content of the wanted revision, without section extraction.
1177 * The result of this function can be used to compare user's input with
1178 * section replaced in its context (using WikiPage::replaceSectionAtRev())
1179 * to the original text of the edit.
1181 * This differs from Article::getContent() that when a missing revision is
1182 * encountered the result will be null and not the
1183 * 'missing-revision' message.
1186 * @param User $user The user to get the revision for
1187 * @return Content|null
1189 private function getOriginalContent( User
$user ) {
1190 if ( $this->section
== 'new' ) {
1191 return $this->getCurrentContent();
1193 $revision = $this->mArticle
->getRevisionFetched();
1194 if ( $revision === null ) {
1195 if ( !$this->contentModel
) {
1196 $this->contentModel
= $this->getTitle()->getContentModel();
1198 $handler = ContentHandler
::getForModelID( $this->contentModel
);
1200 return $handler->makeEmptyContent();
1202 $content = $revision->getContent( Revision
::FOR_THIS_USER
, $user );
1207 * Get the edit's parent revision ID
1209 * The "parent" revision is the ancestor that should be recorded in this
1210 * page's revision history. It is either the revision ID of the in-memory
1211 * article content, or in the case of a 3-way merge in order to rebase
1212 * across a recoverable edit conflict, the ID of the newer revision to
1213 * which we have rebased this page.
1216 * @return int Revision ID
1218 public function getParentRevId() {
1219 if ( $this->parentRevId
) {
1220 return $this->parentRevId
;
1222 return $this->mArticle
->getRevIdFetched();
1227 * Get the current content of the page. This is basically similar to
1228 * WikiPage::getContent( Revision::RAW ) except that when the page doesn't exist an empty
1229 * content object is returned instead of null.
1234 protected function getCurrentContent() {
1235 $rev = $this->page
->getRevision();
1236 $content = $rev ?
$rev->getContent( Revision
::RAW
) : null;
1238 if ( $content === false ||
$content === null ) {
1239 if ( !$this->contentModel
) {
1240 $this->contentModel
= $this->getTitle()->getContentModel();
1242 $handler = ContentHandler
::getForModelID( $this->contentModel
);
1244 return $handler->makeEmptyContent();
1246 # nasty side-effect, but needed for consistency
1247 $this->contentModel
= $rev->getContentModel();
1248 $this->contentFormat
= $rev->getContentFormat();
1255 * Use this method before edit() to preload some content into the edit box
1257 * @param Content $content
1261 public function setPreloadedContent( Content
$content ) {
1262 $this->mPreloadContent
= $content;
1266 * Get the contents to be preloaded into the box, either set by
1267 * an earlier setPreloadText() or by loading the given page.
1269 * @param string $preload Representing the title to preload from.
1270 * @param array $params Parameters to use (interface-message style) in the preloaded text
1276 protected function getPreloadedContent( $preload, $params = [] ) {
1279 if ( !empty( $this->mPreloadContent
) ) {
1280 return $this->mPreloadContent
;
1283 $handler = ContentHandler
::getForTitle( $this->getTitle() );
1285 if ( $preload === '' ) {
1286 return $handler->makeEmptyContent();
1289 $title = Title
::newFromText( $preload );
1290 # Check for existence to avoid getting MediaWiki:Noarticletext
1291 if ( $title === null ||
!$title->exists() ||
!$title->userCan( 'read', $wgUser ) ) {
1292 // TODO: somehow show a warning to the user!
1293 return $handler->makeEmptyContent();
1296 $page = WikiPage
::factory( $title );
1297 if ( $page->isRedirect() ) {
1298 $title = $page->getRedirectTarget();
1300 if ( $title === null ||
!$title->exists() ||
!$title->userCan( 'read', $wgUser ) ) {
1301 // TODO: somehow show a warning to the user!
1302 return $handler->makeEmptyContent();
1304 $page = WikiPage
::factory( $title );
1307 $parserOptions = ParserOptions
::newFromUser( $wgUser );
1308 $content = $page->getContent( Revision
::RAW
);
1311 // TODO: somehow show a warning to the user!
1312 return $handler->makeEmptyContent();
1315 if ( $content->getModel() !== $handler->getModelID() ) {
1316 $converted = $content->convert( $handler->getModelID() );
1318 if ( !$converted ) {
1319 // TODO: somehow show a warning to the user!
1320 wfDebug( "Attempt to preload incompatible content: " .
1321 "can't convert " . $content->getModel() .
1322 " to " . $handler->getModelID() );
1324 return $handler->makeEmptyContent();
1327 $content = $converted;
1330 return $content->preloadTransform( $title, $parserOptions, $params );
1334 * Make sure the form isn't faking a user's credentials.
1336 * @param WebRequest $request
1340 function tokenOk( &$request ) {
1342 $token = $request->getVal( 'wpEditToken' );
1343 $this->mTokenOk
= $wgUser->matchEditToken( $token );
1344 $this->mTokenOkExceptSuffix
= $wgUser->matchEditTokenNoSuffix( $token );
1345 return $this->mTokenOk
;
1349 * Sets post-edit cookie indicating the user just saved a particular revision.
1351 * This uses a temporary cookie for each revision ID so separate saves will never
1352 * interfere with each other.
1354 * The cookie is deleted in the mediawiki.action.view.postEdit JS module after
1355 * the redirect. It must be clearable by JavaScript code, so it must not be
1356 * marked HttpOnly. The JavaScript code converts the cookie to a wgPostEdit config
1359 * If the variable were set on the server, it would be cached, which is unwanted
1360 * since the post-edit state should only apply to the load right after the save.
1362 * @param int $statusValue The status value (to check for new article status)
1364 protected function setPostEditCookie( $statusValue ) {
1365 $revisionId = $this->page
->getLatest();
1366 $postEditKey = self
::POST_EDIT_COOKIE_KEY_PREFIX
. $revisionId;
1369 if ( $statusValue == self
::AS_SUCCESS_NEW_ARTICLE
) {
1371 } elseif ( $this->oldid
) {
1375 $response = RequestContext
::getMain()->getRequest()->response();
1376 $response->setCookie( $postEditKey, $val, time() + self
::POST_EDIT_COOKIE_DURATION
, [
1377 'httpOnly' => false,
1382 * Attempt submission
1383 * @param array $resultDetails See docs for $result in internalAttemptSave
1384 * @throws UserBlockedError|ReadOnlyError|ThrottledError|PermissionsError
1385 * @return Status The resulting status object.
1387 public function attemptSave( &$resultDetails = false ) {
1390 # Allow bots to exempt some edits from bot flagging
1391 $bot = $wgUser->isAllowed( 'bot' ) && $this->bot
;
1392 $status = $this->internalAttemptSave( $resultDetails, $bot );
1394 Hooks
::run( 'EditPage::attemptSave:after', [ $this, $status, $resultDetails ] );
1400 * Handle status, such as after attempt save
1402 * @param Status $status
1403 * @param array|bool $resultDetails
1405 * @throws ErrorPageError
1406 * @return bool False, if output is done, true if rest of the form should be displayed
1408 private function handleStatus( Status
$status, $resultDetails ) {
1409 global $wgUser, $wgOut;
1412 * @todo FIXME: once the interface for internalAttemptSave() is made
1413 * nicer, this should use the message in $status
1415 if ( $status->value
== self
::AS_SUCCESS_UPDATE
1416 ||
$status->value
== self
::AS_SUCCESS_NEW_ARTICLE
1418 $this->didSave
= true;
1419 if ( !$resultDetails['nullEdit'] ) {
1420 $this->setPostEditCookie( $status->value
);
1424 // "wpExtraQueryRedirect" is a hidden input to modify
1425 // after save URL and is not used by actual edit form
1426 $request = RequestContext
::getMain()->getRequest();
1427 $extraQueryRedirect = $request->getVal( 'wpExtraQueryRedirect' );
1429 switch ( $status->value
) {
1430 case self
::AS_HOOK_ERROR_EXPECTED
:
1431 case self
::AS_CONTENT_TOO_BIG
:
1432 case self
::AS_ARTICLE_WAS_DELETED
:
1433 case self
::AS_CONFLICT_DETECTED
:
1434 case self
::AS_SUMMARY_NEEDED
:
1435 case self
::AS_TEXTBOX_EMPTY
:
1436 case self
::AS_MAX_ARTICLE_SIZE_EXCEEDED
:
1438 case self
::AS_BLANK_ARTICLE
:
1439 case self
::AS_SELF_REDIRECT
:
1442 case self
::AS_HOOK_ERROR
:
1445 case self
::AS_CANNOT_USE_CUSTOM_MODEL
:
1446 case self
::AS_PARSE_ERROR
:
1447 $wgOut->addWikiText( '<div class="error">' . $status->getWikiText() . '</div>' );
1450 case self
::AS_SUCCESS_NEW_ARTICLE
:
1451 $query = $resultDetails['redirect'] ?
'redirect=no' : '';
1452 if ( $extraQueryRedirect ) {
1453 if ( $query === '' ) {
1454 $query = $extraQueryRedirect;
1456 $query = $query . '&' . $extraQueryRedirect;
1459 $anchor = isset( $resultDetails['sectionanchor'] ) ?
$resultDetails['sectionanchor'] : '';
1460 $wgOut->redirect( $this->mTitle
->getFullURL( $query ) . $anchor );
1463 case self
::AS_SUCCESS_UPDATE
:
1465 $sectionanchor = $resultDetails['sectionanchor'];
1467 // Give extensions a chance to modify URL query on update
1469 'ArticleUpdateBeforeRedirect',
1470 [ $this->mArticle
, &$sectionanchor, &$extraQuery ]
1473 if ( $resultDetails['redirect'] ) {
1474 if ( $extraQuery == '' ) {
1475 $extraQuery = 'redirect=no';
1477 $extraQuery = 'redirect=no&' . $extraQuery;
1480 if ( $extraQueryRedirect ) {
1481 if ( $extraQuery === '' ) {
1482 $extraQuery = $extraQueryRedirect;
1484 $extraQuery = $extraQuery . '&' . $extraQueryRedirect;
1488 $wgOut->redirect( $this->mTitle
->getFullURL( $extraQuery ) . $sectionanchor );
1491 case self
::AS_SPAM_ERROR
:
1492 $this->spamPageWithContent( $resultDetails['spam'] );
1495 case self
::AS_BLOCKED_PAGE_FOR_USER
:
1496 throw new UserBlockedError( $wgUser->getBlock() );
1498 case self
::AS_IMAGE_REDIRECT_ANON
:
1499 case self
::AS_IMAGE_REDIRECT_LOGGED
:
1500 throw new PermissionsError( 'upload' );
1502 case self
::AS_READ_ONLY_PAGE_ANON
:
1503 case self
::AS_READ_ONLY_PAGE_LOGGED
:
1504 throw new PermissionsError( 'edit' );
1506 case self
::AS_READ_ONLY_PAGE
:
1507 throw new ReadOnlyError
;
1509 case self
::AS_RATE_LIMITED
:
1510 throw new ThrottledError();
1512 case self
::AS_NO_CREATE_PERMISSION
:
1513 $permission = $this->mTitle
->isTalkPage() ?
'createtalk' : 'createpage';
1514 throw new PermissionsError( $permission );
1516 case self
::AS_NO_CHANGE_CONTENT_MODEL
:
1517 throw new PermissionsError( 'editcontentmodel' );
1520 // We don't recognize $status->value. The only way that can happen
1521 // is if an extension hook aborted from inside ArticleSave.
1522 // Render the status object into $this->hookError
1523 // FIXME this sucks, we should just use the Status object throughout
1524 $this->hookError
= '<div class="error">' . $status->getWikiText() .
1531 * Run hooks that can filter edits just before they get saved.
1533 * @param Content $content The Content to filter.
1534 * @param Status $status For reporting the outcome to the caller
1535 * @param User $user The user performing the edit
1539 protected function runPostMergeFilters( Content
$content, Status
$status, User
$user ) {
1540 // Run old style post-section-merge edit filter
1541 if ( !ContentHandler
::runLegacyHooks( 'EditFilterMerged',
1542 [ $this, $content, &$this->hookError
, $this->summary
] )
1544 # Error messages etc. could be handled within the hook...
1545 $status->fatal( 'hookaborted' );
1546 $status->value
= self
::AS_HOOK_ERROR
;
1548 } elseif ( $this->hookError
!= '' ) {
1549 # ...or the hook could be expecting us to produce an error
1550 $status->fatal( 'hookaborted' );
1551 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1555 // Run new style post-section-merge edit filter
1556 if ( !Hooks
::run( 'EditFilterMergedContent',
1557 [ $this->mArticle
->getContext(), $content, $status, $this->summary
,
1558 $user, $this->minoredit
] )
1560 # Error messages etc. could be handled within the hook...
1561 if ( $status->isGood() ) {
1562 $status->fatal( 'hookaborted' );
1563 // Not setting $this->hookError here is a hack to allow the hook
1564 // to cause a return to the edit page without $this->hookError
1565 // being set. This is used by ConfirmEdit to display a captcha
1566 // without any error message cruft.
1568 $this->hookError
= $status->getWikiText();
1570 // Use the existing $status->value if the hook set it
1571 if ( !$status->value
) {
1572 $status->value
= self
::AS_HOOK_ERROR
;
1575 } elseif ( !$status->isOK() ) {
1576 # ...or the hook could be expecting us to produce an error
1577 // FIXME this sucks, we should just use the Status object throughout
1578 $this->hookError
= $status->getWikiText();
1579 $status->fatal( 'hookaborted' );
1580 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1588 * Return the summary to be used for a new section.
1590 * @param string $sectionanchor Set to the section anchor text
1593 private function newSectionSummary( &$sectionanchor = null ) {
1596 if ( $this->sectiontitle
!== '' ) {
1597 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $this->sectiontitle
);
1598 // If no edit summary was specified, create one automatically from the section
1599 // title and have it link to the new section. Otherwise, respect the summary as
1601 if ( $this->summary
=== '' ) {
1602 $cleanSectionTitle = $wgParser->stripSectionName( $this->sectiontitle
);
1603 return wfMessage( 'newsectionsummary' )
1604 ->rawParams( $cleanSectionTitle )->inContentLanguage()->text();
1606 } elseif ( $this->summary
!== '' ) {
1607 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $this->summary
);
1608 # This is a new section, so create a link to the new section
1609 # in the revision summary.
1610 $cleanSummary = $wgParser->stripSectionName( $this->summary
);
1611 return wfMessage( 'newsectionsummary' )
1612 ->rawParams( $cleanSummary )->inContentLanguage()->text();
1614 return $this->summary
;
1618 * Attempt submission (no UI)
1620 * @param array $result Array to add statuses to, currently with the
1622 * - spam (string): Spam string from content if any spam is detected by
1624 * - sectionanchor (string): Section anchor for a section save.
1625 * - nullEdit (boolean): Set if doEditContent is OK. True if null edit,
1627 * - redirect (bool): Set if doEditContent is OK. True if resulting
1628 * revision is a redirect.
1629 * @param bool $bot True if edit is being made under the bot right.
1631 * @return Status Status object, possibly with a message, but always with
1632 * one of the AS_* constants in $status->value,
1634 * @todo FIXME: This interface is TERRIBLE, but hard to get rid of due to
1635 * various error display idiosyncrasies. There are also lots of cases
1636 * where error metadata is set in the object and retrieved later instead
1637 * of being returned, e.g. AS_CONTENT_TOO_BIG and
1638 * AS_BLOCKED_PAGE_FOR_USER. All that stuff needs to be cleaned up some
1641 function internalAttemptSave( &$result, $bot = false ) {
1642 global $wgUser, $wgRequest, $wgParser, $wgMaxArticleSize;
1643 global $wgContentHandlerUseDB;
1645 $status = Status
::newGood();
1647 if ( !Hooks
::run( 'EditPage::attemptSave', [ $this ] ) ) {
1648 wfDebug( "Hook 'EditPage::attemptSave' aborted article saving\n" );
1649 $status->fatal( 'hookaborted' );
1650 $status->value
= self
::AS_HOOK_ERROR
;
1654 $spam = $wgRequest->getText( 'wpAntispam' );
1655 if ( $spam !== '' ) {
1658 $wgUser->getName() .
1660 $this->mTitle
->getPrefixedText() .
1661 '" submitted bogus field "' .
1665 $status->fatal( 'spamprotectionmatch', false );
1666 $status->value
= self
::AS_SPAM_ERROR
;
1671 # Construct Content object
1672 $textbox_content = $this->toEditContent( $this->textbox1
);
1673 } catch ( MWContentSerializationException
$ex ) {
1675 'content-failed-to-parse',
1676 $this->contentModel
,
1677 $this->contentFormat
,
1680 $status->value
= self
::AS_PARSE_ERROR
;
1684 # Check image redirect
1685 if ( $this->mTitle
->getNamespace() == NS_FILE
&&
1686 $textbox_content->isRedirect() &&
1687 !$wgUser->isAllowed( 'upload' )
1689 $code = $wgUser->isAnon() ? self
::AS_IMAGE_REDIRECT_ANON
: self
::AS_IMAGE_REDIRECT_LOGGED
;
1690 $status->setResult( false, $code );
1696 $match = self
::matchSummarySpamRegex( $this->summary
);
1697 if ( $match === false && $this->section
== 'new' ) {
1698 # $wgSpamRegex is enforced on this new heading/summary because, unlike
1699 # regular summaries, it is added to the actual wikitext.
1700 if ( $this->sectiontitle
!== '' ) {
1701 # This branch is taken when the API is used with the 'sectiontitle' parameter.
1702 $match = self
::matchSpamRegex( $this->sectiontitle
);
1704 # This branch is taken when the "Add Topic" user interface is used, or the API
1705 # is used with the 'summary' parameter.
1706 $match = self
::matchSpamRegex( $this->summary
);
1709 if ( $match === false ) {
1710 $match = self
::matchSpamRegex( $this->textbox1
);
1712 if ( $match !== false ) {
1713 $result['spam'] = $match;
1714 $ip = $wgRequest->getIP();
1715 $pdbk = $this->mTitle
->getPrefixedDBkey();
1716 $match = str_replace( "\n", '', $match );
1717 wfDebugLog( 'SpamRegex', "$ip spam regex hit [[$pdbk]]: \"$match\"" );
1718 $status->fatal( 'spamprotectionmatch', $match );
1719 $status->value
= self
::AS_SPAM_ERROR
;
1724 [ $this, $this->textbox1
, $this->section
, &$this->hookError
, $this->summary
] )
1726 # Error messages etc. could be handled within the hook...
1727 $status->fatal( 'hookaborted' );
1728 $status->value
= self
::AS_HOOK_ERROR
;
1730 } elseif ( $this->hookError
!= '' ) {
1731 # ...or the hook could be expecting us to produce an error
1732 $status->fatal( 'hookaborted' );
1733 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1737 if ( $wgUser->isBlockedFrom( $this->mTitle
, false ) ) {
1738 // Auto-block user's IP if the account was "hard" blocked
1739 if ( !wfReadOnly() ) {
1740 $wgUser->spreadAnyEditBlock();
1742 # Check block state against master, thus 'false'.
1743 $status->setResult( false, self
::AS_BLOCKED_PAGE_FOR_USER
);
1747 $this->kblength
= (int)( strlen( $this->textbox1
) / 1024 );
1748 if ( $this->kblength
> $wgMaxArticleSize ) {
1749 // Error will be displayed by showEditForm()
1750 $this->tooBig
= true;
1751 $status->setResult( false, self
::AS_CONTENT_TOO_BIG
);
1755 if ( !$wgUser->isAllowed( 'edit' ) ) {
1756 if ( $wgUser->isAnon() ) {
1757 $status->setResult( false, self
::AS_READ_ONLY_PAGE_ANON
);
1760 $status->fatal( 'readonlytext' );
1761 $status->value
= self
::AS_READ_ONLY_PAGE_LOGGED
;
1766 $changingContentModel = false;
1767 if ( $this->contentModel
!== $this->mTitle
->getContentModel() ) {
1768 if ( !$wgContentHandlerUseDB ) {
1769 $status->fatal( 'editpage-cannot-use-custom-model' );
1770 $status->value
= self
::AS_CANNOT_USE_CUSTOM_MODEL
;
1772 } elseif ( !$wgUser->isAllowed( 'editcontentmodel' ) ) {
1773 $status->setResult( false, self
::AS_NO_CHANGE_CONTENT_MODEL
);
1777 $changingContentModel = true;
1778 $oldContentModel = $this->mTitle
->getContentModel();
1781 if ( $this->changeTags
) {
1782 $changeTagsStatus = ChangeTags
::canAddTagsAccompanyingChange(
1783 $this->changeTags
, $wgUser );
1784 if ( !$changeTagsStatus->isOK() ) {
1785 $changeTagsStatus->value
= self
::AS_CHANGE_TAG_ERROR
;
1786 return $changeTagsStatus;
1790 if ( wfReadOnly() ) {
1791 $status->fatal( 'readonlytext' );
1792 $status->value
= self
::AS_READ_ONLY_PAGE
;
1795 if ( $wgUser->pingLimiter() ||
$wgUser->pingLimiter( 'linkpurge', 0 ) ) {
1796 $status->fatal( 'actionthrottledtext' );
1797 $status->value
= self
::AS_RATE_LIMITED
;
1801 # If the article has been deleted while editing, don't save it without
1803 if ( $this->wasDeletedSinceLastEdit() && !$this->recreate
) {
1804 $status->setResult( false, self
::AS_ARTICLE_WAS_DELETED
);
1808 # Load the page data from the master. If anything changes in the meantime,
1809 # we detect it by using page_latest like a token in a 1 try compare-and-swap.
1810 $this->page
->loadPageData( 'fromdbmaster' );
1811 $new = !$this->page
->exists();
1814 // Late check for create permission, just in case *PARANOIA*
1815 if ( !$this->mTitle
->userCan( 'create', $wgUser ) ) {
1816 $status->fatal( 'nocreatetext' );
1817 $status->value
= self
::AS_NO_CREATE_PERMISSION
;
1818 wfDebug( __METHOD__
. ": no create permission\n" );
1822 // Don't save a new page if it's blank or if it's a MediaWiki:
1823 // message with content equivalent to default (allow empty pages
1824 // in this case to disable messages, see bug 50124)
1825 $defaultMessageText = $this->mTitle
->getDefaultMessageText();
1826 if ( $this->mTitle
->getNamespace() === NS_MEDIAWIKI
&& $defaultMessageText !== false ) {
1827 $defaultText = $defaultMessageText;
1832 if ( !$this->allowBlankArticle
&& $this->textbox1
=== $defaultText ) {
1833 $this->blankArticle
= true;
1834 $status->fatal( 'blankarticle' );
1835 $status->setResult( false, self
::AS_BLANK_ARTICLE
);
1839 if ( !$this->runPostMergeFilters( $textbox_content, $status, $wgUser ) ) {
1843 $content = $textbox_content;
1845 $result['sectionanchor'] = '';
1846 if ( $this->section
== 'new' ) {
1847 if ( $this->sectiontitle
!== '' ) {
1848 // Insert the section title above the content.
1849 $content = $content->addSectionHeader( $this->sectiontitle
);
1850 } elseif ( $this->summary
!== '' ) {
1851 // Insert the section title above the content.
1852 $content = $content->addSectionHeader( $this->summary
);
1854 $this->summary
= $this->newSectionSummary( $result['sectionanchor'] );
1857 $status->value
= self
::AS_SUCCESS_NEW_ARTICLE
;
1861 # Article exists. Check for edit conflict.
1863 $this->page
->clear(); # Force reload of dates, etc.
1864 $timestamp = $this->page
->getTimestamp();
1866 wfDebug( "timestamp: {$timestamp}, edittime: {$this->edittime}\n" );
1868 if ( $timestamp != $this->edittime
) {
1869 $this->isConflict
= true;
1870 if ( $this->section
== 'new' ) {
1871 if ( $this->page
->getUserText() == $wgUser->getName() &&
1872 $this->page
->getComment() == $this->newSectionSummary()
1874 // Probably a duplicate submission of a new comment.
1875 // This can happen when CDN resends a request after
1876 // a timeout but the first one actually went through.
1878 . ": duplicate new section submission; trigger edit conflict!\n" );
1880 // New comment; suppress conflict.
1881 $this->isConflict
= false;
1882 wfDebug( __METHOD__
. ": conflict suppressed; new section\n" );
1884 } elseif ( $this->section
== ''
1885 && Revision
::userWasLastToEdit(
1886 DB_MASTER
, $this->mTitle
->getArticleID(),
1887 $wgUser->getId(), $this->edittime
1890 # Suppress edit conflict with self, except for section edits where merging is required.
1891 wfDebug( __METHOD__
. ": Suppressing edit conflict, same user.\n" );
1892 $this->isConflict
= false;
1896 // If sectiontitle is set, use it, otherwise use the summary as the section title.
1897 if ( $this->sectiontitle
!== '' ) {
1898 $sectionTitle = $this->sectiontitle
;
1900 $sectionTitle = $this->summary
;
1905 if ( $this->isConflict
) {
1907 . ": conflict! getting section '{$this->section}' for time '{$this->edittime}'"
1908 . " (article time '{$timestamp}')\n" );
1910 $content = $this->page
->replaceSectionContent(
1917 wfDebug( __METHOD__
. ": getting section '{$this->section}'\n" );
1918 $content = $this->page
->replaceSectionContent(
1925 if ( is_null( $content ) ) {
1926 wfDebug( __METHOD__
. ": activating conflict; section replace failed.\n" );
1927 $this->isConflict
= true;
1928 $content = $textbox_content; // do not try to merge here!
1929 } elseif ( $this->isConflict
) {
1931 if ( $this->mergeChangesIntoContent( $content ) ) {
1932 // Successful merge! Maybe we should tell the user the good news?
1933 $this->isConflict
= false;
1934 wfDebug( __METHOD__
. ": Suppressing edit conflict, successful merge.\n" );
1936 $this->section
= '';
1937 $this->textbox1
= ContentHandler
::getContentText( $content );
1938 wfDebug( __METHOD__
. ": Keeping edit conflict, failed merge.\n" );
1942 if ( $this->isConflict
) {
1943 $status->setResult( false, self
::AS_CONFLICT_DETECTED
);
1947 if ( !$this->runPostMergeFilters( $content, $status, $wgUser ) ) {
1951 if ( $this->section
== 'new' ) {
1952 // Handle the user preference to force summaries here
1953 if ( !$this->allowBlankSummary
&& trim( $this->summary
) == '' ) {
1954 $this->missingSummary
= true;
1955 $status->fatal( 'missingsummary' ); // or 'missingcommentheader' if $section == 'new'. Blegh
1956 $status->value
= self
::AS_SUMMARY_NEEDED
;
1960 // Do not allow the user to post an empty comment
1961 if ( $this->textbox1
== '' ) {
1962 $this->missingComment
= true;
1963 $status->fatal( 'missingcommenttext' );
1964 $status->value
= self
::AS_TEXTBOX_EMPTY
;
1967 } elseif ( !$this->allowBlankSummary
1968 && !$content->equals( $this->getOriginalContent( $wgUser ) )
1969 && !$content->isRedirect()
1970 && md5( $this->summary
) == $this->autoSumm
1972 $this->missingSummary
= true;
1973 $status->fatal( 'missingsummary' );
1974 $status->value
= self
::AS_SUMMARY_NEEDED
;
1979 $sectionanchor = '';
1980 if ( $this->section
== 'new' ) {
1981 $this->summary
= $this->newSectionSummary( $sectionanchor );
1982 } elseif ( $this->section
!= '' ) {
1983 # Try to get a section anchor from the section source, redirect
1984 # to edited section if header found.
1985 # XXX: Might be better to integrate this into Article::replaceSectionAtRev
1986 # for duplicate heading checking and maybe parsing.
1987 $hasmatch = preg_match( "/^ *([=]{1,6})(.*?)(\\1) *\\n/i", $this->textbox1
, $matches );
1988 # We can't deal with anchors, includes, html etc in the header for now,
1989 # headline would need to be parsed to improve this.
1990 if ( $hasmatch && strlen( $matches[2] ) > 0 ) {
1991 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $matches[2] );
1994 $result['sectionanchor'] = $sectionanchor;
1996 // Save errors may fall down to the edit form, but we've now
1997 // merged the section into full text. Clear the section field
1998 // so that later submission of conflict forms won't try to
1999 // replace that into a duplicated mess.
2000 $this->textbox1
= $this->toEditText( $content );
2001 $this->section
= '';
2003 $status->value
= self
::AS_SUCCESS_UPDATE
;
2006 if ( !$this->allowSelfRedirect
2007 && $content->isRedirect()
2008 && $content->getRedirectTarget()->equals( $this->getTitle() )
2010 // If the page already redirects to itself, don't warn.
2011 $currentTarget = $this->getCurrentContent()->getRedirectTarget();
2012 if ( !$currentTarget ||
!$currentTarget->equals( $this->getTitle() ) ) {
2013 $this->selfRedirect
= true;
2014 $status->fatal( 'selfredirect' );
2015 $status->value
= self
::AS_SELF_REDIRECT
;
2020 // Check for length errors again now that the section is merged in
2021 $this->kblength
= (int)( strlen( $this->toEditText( $content ) ) / 1024 );
2022 if ( $this->kblength
> $wgMaxArticleSize ) {
2023 $this->tooBig
= true;
2024 $status->setResult( false, self
::AS_MAX_ARTICLE_SIZE_EXCEEDED
);
2028 $flags = EDIT_AUTOSUMMARY |
2029 ( $new ? EDIT_NEW
: EDIT_UPDATE
) |
2030 ( ( $this->minoredit
&& !$this->isNew
) ? EDIT_MINOR
: 0 ) |
2031 ( $bot ? EDIT_FORCE_BOT
: 0 );
2033 $doEditStatus = $this->page
->doEditContent(
2039 $content->getDefaultFormat(),
2043 if ( !$doEditStatus->isOK() ) {
2044 // Failure from doEdit()
2045 // Show the edit conflict page for certain recognized errors from doEdit(),
2046 // but don't show it for errors from extension hooks
2047 $errors = $doEditStatus->getErrorsArray();
2048 if ( in_array( $errors[0][0],
2049 [ 'edit-gone-missing', 'edit-conflict', 'edit-already-exists' ] )
2051 $this->isConflict
= true;
2052 // Destroys data doEdit() put in $status->value but who cares
2053 $doEditStatus->value
= self
::AS_END
;
2055 return $doEditStatus;
2058 $result['nullEdit'] = $doEditStatus->hasMessage( 'edit-no-change' );
2059 if ( $result['nullEdit'] ) {
2060 // We don't know if it was a null edit until now, so increment here
2061 $wgUser->pingLimiter( 'linkpurge' );
2063 $result['redirect'] = $content->isRedirect();
2065 $this->updateWatchlist();
2067 // If the content model changed, add a log entry
2068 if ( $changingContentModel ) {
2069 $this->addContentModelChangeLogEntry(
2071 $new ?
false : $oldContentModel,
2072 $this->contentModel
,
2082 * @param string|false $oldModel false if the page is being newly created
2083 * @param string $newModel
2084 * @param string $reason
2086 protected function addContentModelChangeLogEntry( User
$user, $oldModel, $newModel, $reason ) {
2087 $new = $oldModel === false;
2088 $log = new ManualLogEntry( 'contentmodel', $new ?
'new' : 'change' );
2089 $log->setPerformer( $user );
2090 $log->setTarget( $this->mTitle
);
2091 $log->setComment( $reason );
2092 $log->setParameters( [
2093 '4::oldmodel' => $oldModel,
2094 '5::newmodel' => $newModel
2096 $logid = $log->insert();
2097 $log->publish( $logid );
2101 * Register the change of watch status
2103 protected function updateWatchlist() {
2106 if ( !$wgUser->isLoggedIn() ) {
2111 $title = $this->mTitle
;
2112 $watch = $this->watchthis
;
2113 // Do this in its own transaction to reduce contention...
2114 DeferredUpdates
::addCallableUpdate( function () use ( $user, $title, $watch ) {
2115 if ( $watch == $user->isWatched( $title, User
::IGNORE_USER_RIGHTS
) ) {
2116 return; // nothing to change
2118 WatchAction
::doWatchOrUnwatch( $watch, $title, $user );
2123 * Attempts to do 3-way merge of edit content with a base revision
2124 * and current content, in case of edit conflict, in whichever way appropriate
2125 * for the content type.
2129 * @param Content $editContent
2133 private function mergeChangesIntoContent( &$editContent ) {
2135 $db = wfGetDB( DB_MASTER
);
2137 // This is the revision the editor started from
2138 $baseRevision = $this->getBaseRevision();
2139 $baseContent = $baseRevision ?
$baseRevision->getContent() : null;
2141 if ( is_null( $baseContent ) ) {
2145 // The current state, we want to merge updates into it
2146 $currentRevision = Revision
::loadFromTitle( $db, $this->mTitle
);
2147 $currentContent = $currentRevision ?
$currentRevision->getContent() : null;
2149 if ( is_null( $currentContent ) ) {
2153 $handler = ContentHandler
::getForModelID( $baseContent->getModel() );
2155 $result = $handler->merge3( $baseContent, $editContent, $currentContent );
2158 $editContent = $result;
2159 // Update parentRevId to what we just merged.
2160 $this->parentRevId
= $currentRevision->getId();
2168 * @note: this method is very poorly named. If the user opened the form with ?oldid=X,
2169 * one might think of X as the "base revision", which is NOT what this returns.
2170 * @return Revision Current version when the edit was started
2172 function getBaseRevision() {
2173 if ( !$this->mBaseRevision
) {
2174 $db = wfGetDB( DB_MASTER
);
2175 $this->mBaseRevision
= Revision
::loadFromTimestamp(
2176 $db, $this->mTitle
, $this->edittime
);
2178 return $this->mBaseRevision
;
2182 * Check given input text against $wgSpamRegex, and return the text of the first match.
2184 * @param string $text
2186 * @return string|bool Matching string or false
2188 public static function matchSpamRegex( $text ) {
2189 global $wgSpamRegex;
2190 // For back compatibility, $wgSpamRegex may be a single string or an array of regexes.
2191 $regexes = (array)$wgSpamRegex;
2192 return self
::matchSpamRegexInternal( $text, $regexes );
2196 * Check given input text against $wgSummarySpamRegex, and return the text of the first match.
2198 * @param string $text
2200 * @return string|bool Matching string or false
2202 public static function matchSummarySpamRegex( $text ) {
2203 global $wgSummarySpamRegex;
2204 $regexes = (array)$wgSummarySpamRegex;
2205 return self
::matchSpamRegexInternal( $text, $regexes );
2209 * @param string $text
2210 * @param array $regexes
2211 * @return bool|string
2213 protected static function matchSpamRegexInternal( $text, $regexes ) {
2214 foreach ( $regexes as $regex ) {
2216 if ( preg_match( $regex, $text, $matches ) ) {
2223 function setHeaders() {
2224 global $wgOut, $wgUser, $wgAjaxEditStash;
2226 $wgOut->addModules( 'mediawiki.action.edit' );
2227 $wgOut->addModuleStyles( 'mediawiki.action.edit.styles' );
2229 if ( $wgUser->getOption( 'showtoolbar' ) ) {
2230 // The addition of default buttons is handled by getEditToolbar() which
2231 // has its own dependency on this module. The call here ensures the module
2232 // is loaded in time (it has position "top") for other modules to register
2233 // buttons (e.g. extensions, gadgets, user scripts).
2234 $wgOut->addModules( 'mediawiki.toolbar' );
2237 if ( $wgUser->getOption( 'uselivepreview' ) ) {
2238 $wgOut->addModules( 'mediawiki.action.edit.preview' );
2241 if ( $wgUser->getOption( 'useeditwarning' ) ) {
2242 $wgOut->addModules( 'mediawiki.action.edit.editWarning' );
2245 if ( $wgAjaxEditStash ) {
2246 $wgOut->addModules( 'mediawiki.action.edit.stash' );
2249 # Enabled article-related sidebar, toplinks, etc.
2250 $wgOut->setArticleRelated( true );
2252 $contextTitle = $this->getContextTitle();
2253 if ( $this->isConflict
) {
2254 $msg = 'editconflict';
2255 } elseif ( $contextTitle->exists() && $this->section
!= '' ) {
2256 $msg = $this->section
== 'new' ?
'editingcomment' : 'editingsection';
2258 $msg = $contextTitle->exists()
2259 ||
( $contextTitle->getNamespace() == NS_MEDIAWIKI
2260 && $contextTitle->getDefaultMessageText() !== false
2266 # Use the title defined by DISPLAYTITLE magic word when present
2267 # NOTE: getDisplayTitle() returns HTML while getPrefixedText() returns plain text.
2268 # setPageTitle() treats the input as wikitext, which should be safe in either case.
2269 $displayTitle = isset( $this->mParserOutput
) ?
$this->mParserOutput
->getDisplayTitle() : false;
2270 if ( $displayTitle === false ) {
2271 $displayTitle = $contextTitle->getPrefixedText();
2273 $wgOut->setPageTitle( wfMessage( $msg, $displayTitle ) );
2274 # Transmit the name of the message to JavaScript for live preview
2275 # Keep Resources.php/mediawiki.action.edit.preview in sync with the possible keys
2276 $wgOut->addJsConfigVars( 'wgEditMessage', $msg );
2280 * Show all applicable editing introductions
2282 protected function showIntro() {
2283 global $wgOut, $wgUser;
2284 if ( $this->suppressIntro
) {
2288 $namespace = $this->mTitle
->getNamespace();
2290 if ( $namespace == NS_MEDIAWIKI
) {
2291 # Show a warning if editing an interface message
2292 $wgOut->wrapWikiMsg( "<div class='mw-editinginterface'>\n$1\n</div>", 'editinginterface' );
2293 # If this is a default message (but not css or js),
2294 # show a hint that it is translatable on translatewiki.net
2295 if ( !$this->mTitle
->hasContentModel( CONTENT_MODEL_CSS
)
2296 && !$this->mTitle
->hasContentModel( CONTENT_MODEL_JAVASCRIPT
)
2298 $defaultMessageText = $this->mTitle
->getDefaultMessageText();
2299 if ( $defaultMessageText !== false ) {
2300 $wgOut->wrapWikiMsg( "<div class='mw-translateinterface'>\n$1\n</div>",
2301 'translateinterface' );
2304 } elseif ( $namespace == NS_FILE
) {
2305 # Show a hint to shared repo
2306 $file = wfFindFile( $this->mTitle
);
2307 if ( $file && !$file->isLocal() ) {
2308 $descUrl = $file->getDescriptionUrl();
2309 # there must be a description url to show a hint to shared repo
2311 if ( !$this->mTitle
->exists() ) {
2312 $wgOut->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-create\">\n$1\n</div>", [
2313 'sharedupload-desc-create', $file->getRepo()->getDisplayName(), $descUrl
2316 $wgOut->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-edit\">\n$1\n</div>", [
2317 'sharedupload-desc-edit', $file->getRepo()->getDisplayName(), $descUrl
2324 # Show a warning message when someone creates/edits a user (talk) page but the user does not exist
2325 # Show log extract when the user is currently blocked
2326 if ( $namespace == NS_USER ||
$namespace == NS_USER_TALK
) {
2327 $username = explode( '/', $this->mTitle
->getText(), 2 )[0];
2328 $user = User
::newFromName( $username, false /* allow IP users*/ );
2329 $ip = User
::isIP( $username );
2330 $block = Block
::newFromTarget( $user, $user );
2331 if ( !( $user && $user->isLoggedIn() ) && !$ip ) { # User does not exist
2332 $wgOut->wrapWikiMsg( "<div class=\"mw-userpage-userdoesnotexist error\">\n$1\n</div>",
2333 [ 'userpage-userdoesnotexist', wfEscapeWikiText( $username ) ] );
2334 } elseif ( !is_null( $block ) && $block->getType() != Block
::TYPE_AUTO
) {
2335 # Show log extract if the user is currently blocked
2336 LogEventsList
::showLogExtract(
2339 MWNamespace
::getCanonicalName( NS_USER
) . ':' . $block->getTarget(),
2343 'showIfEmpty' => false,
2345 'blocked-notice-logextract',
2346 $user->getName() # Support GENDER in notice
2352 # Try to add a custom edit intro, or use the standard one if this is not possible.
2353 if ( !$this->showCustomIntro() && !$this->mTitle
->exists() ) {
2354 $helpLink = wfExpandUrl( Skin
::makeInternalOrExternalUrl(
2355 wfMessage( 'helppage' )->inContentLanguage()->text()
2357 if ( $wgUser->isLoggedIn() ) {
2358 $wgOut->wrapWikiMsg(
2359 // Suppress the external link icon, consider the help url an internal one
2360 "<div class=\"mw-newarticletext plainlinks\">\n$1\n</div>",
2367 $wgOut->wrapWikiMsg(
2368 // Suppress the external link icon, consider the help url an internal one
2369 "<div class=\"mw-newarticletextanon plainlinks\">\n$1\n</div>",
2371 'newarticletextanon',
2377 # Give a notice if the user is editing a deleted/moved page...
2378 if ( !$this->mTitle
->exists() ) {
2379 LogEventsList
::showLogExtract( $wgOut, [ 'delete', 'move' ], $this->mTitle
,
2383 'conds' => [ "log_action != 'revision'" ],
2384 'showIfEmpty' => false,
2385 'msgKey' => [ 'recreate-moveddeleted-warn' ]
2392 * Attempt to show a custom editing introduction, if supplied
2396 protected function showCustomIntro() {
2397 if ( $this->editintro
) {
2398 $title = Title
::newFromText( $this->editintro
);
2399 if ( $title instanceof Title
&& $title->exists() && $title->userCan( 'read' ) ) {
2401 // Added using template syntax, to take <noinclude>'s into account.
2402 $wgOut->addWikiTextTitleTidy(
2403 '<div class="mw-editintro">{{:' . $title->getFullText() . '}}</div>',
2413 * Gets an editable textual representation of $content.
2414 * The textual representation can be turned by into a Content object by the
2415 * toEditContent() method.
2417 * If $content is null or false or a string, $content is returned unchanged.
2419 * If the given Content object is not of a type that can be edited using
2420 * the text base EditPage, an exception will be raised. Set
2421 * $this->allowNonTextContent to true to allow editing of non-textual
2424 * @param Content|null|bool|string $content
2425 * @return string The editable text form of the content.
2427 * @throws MWException If $content is not an instance of TextContent and
2428 * $this->allowNonTextContent is not true.
2430 protected function toEditText( $content ) {
2431 if ( $content === null ||
$content === false ||
is_string( $content ) ) {
2435 if ( !$this->isSupportedContentModel( $content->getModel() ) ) {
2436 throw new MWException( 'This content model is not supported: '
2437 . ContentHandler
::getLocalizedName( $content->getModel() ) );
2440 return $content->serialize( $this->contentFormat
);
2444 * Turns the given text into a Content object by unserializing it.
2446 * If the resulting Content object is not of a type that can be edited using
2447 * the text base EditPage, an exception will be raised. Set
2448 * $this->allowNonTextContent to true to allow editing of non-textual
2451 * @param string|null|bool $text Text to unserialize
2452 * @return Content The content object created from $text. If $text was false
2453 * or null, false resp. null will be returned instead.
2455 * @throws MWException If unserializing the text results in a Content
2456 * object that is not an instance of TextContent and
2457 * $this->allowNonTextContent is not true.
2459 protected function toEditContent( $text ) {
2460 if ( $text === false ||
$text === null ) {
2464 $content = ContentHandler
::makeContent( $text, $this->getTitle(),
2465 $this->contentModel
, $this->contentFormat
);
2467 if ( !$this->isSupportedContentModel( $content->getModel() ) ) {
2468 throw new MWException( 'This content model is not supported: '
2469 . ContentHandler
::getLocalizedName( $content->getModel() ) );
2476 * Send the edit form and related headers to $wgOut
2477 * @param callable|null $formCallback That takes an OutputPage parameter; will be called
2478 * during form output near the top, for captchas and the like.
2480 * The $formCallback parameter is deprecated since MediaWiki 1.25. Please
2481 * use the EditPage::showEditForm:fields hook instead.
2483 function showEditForm( $formCallback = null ) {
2484 global $wgOut, $wgUser;
2486 # need to parse the preview early so that we know which templates are used,
2487 # otherwise users with "show preview after edit box" will get a blank list
2488 # we parse this near the beginning so that setHeaders can do the title
2489 # setting work instead of leaving it in getPreviewText
2490 $previewOutput = '';
2491 if ( $this->formtype
== 'preview' ) {
2492 $previewOutput = $this->getPreviewText();
2495 Hooks
::run( 'EditPage::showEditForm:initial', [ &$this, &$wgOut ] );
2497 $this->setHeaders();
2499 if ( $this->showHeader() === false ) {
2503 $wgOut->addHTML( $this->editFormPageTop
);
2505 if ( $wgUser->getOption( 'previewontop' ) ) {
2506 $this->displayPreviewArea( $previewOutput, true );
2509 $wgOut->addHTML( $this->editFormTextTop
);
2511 $showToolbar = true;
2512 if ( $this->wasDeletedSinceLastEdit() ) {
2513 if ( $this->formtype
== 'save' ) {
2514 // Hide the toolbar and edit area, user can click preview to get it back
2515 // Add an confirmation checkbox and explanation.
2516 $showToolbar = false;
2518 $wgOut->wrapWikiMsg( "<div class='error mw-deleted-while-editing'>\n$1\n</div>",
2519 'deletedwhileediting' );
2523 // @todo add EditForm plugin interface and use it here!
2524 // search for textarea1 and textares2, and allow EditForm to override all uses.
2525 $wgOut->addHTML( Html
::openElement(
2528 'id' => self
::EDITFORM_ID
,
2529 'name' => self
::EDITFORM_ID
,
2531 'action' => $this->getActionURL( $this->getContextTitle() ),
2532 'enctype' => 'multipart/form-data'
2536 if ( is_callable( $formCallback ) ) {
2537 wfWarn( 'The $formCallback parameter to ' . __METHOD__
. 'is deprecated' );
2538 call_user_func_array( $formCallback, [ &$wgOut ] );
2541 // Add an empty field to trip up spambots
2543 Xml
::openElement( 'div', [ 'id' => 'antispam-container', 'style' => 'display: none;' ] )
2546 [ 'for' => 'wpAntispam' ],
2547 wfMessage( 'simpleantispam-label' )->parse()
2553 'name' => 'wpAntispam',
2554 'id' => 'wpAntispam',
2558 . Xml
::closeElement( 'div' )
2561 Hooks
::run( 'EditPage::showEditForm:fields', [ &$this, &$wgOut ] );
2563 // Put these up at the top to ensure they aren't lost on early form submission
2564 $this->showFormBeforeText();
2566 if ( $this->wasDeletedSinceLastEdit() && 'save' == $this->formtype
) {
2567 $username = $this->lastDelete
->user_name
;
2568 $comment = $this->lastDelete
->log_comment
;
2570 // It is better to not parse the comment at all than to have templates expanded in the middle
2571 // TODO: can the checkLabel be moved outside of the div so that wrapWikiMsg could be used?
2572 $key = $comment === ''
2573 ?
'confirmrecreate-noreason'
2574 : 'confirmrecreate';
2576 '<div class="mw-confirm-recreate">' .
2577 wfMessage( $key, $username, "<nowiki>$comment</nowiki>" )->parse() .
2578 Xml
::checkLabel( wfMessage( 'recreate' )->text(), 'wpRecreate', 'wpRecreate', false,
2579 [ 'title' => Linker
::titleAttrib( 'recreate' ), 'tabindex' => 1, 'id' => 'wpRecreate' ]
2585 # When the summary is hidden, also hide them on preview/show changes
2586 if ( $this->nosummary
) {
2587 $wgOut->addHTML( Html
::hidden( 'nosummary', true ) );
2590 # If a blank edit summary was previously provided, and the appropriate
2591 # user preference is active, pass a hidden tag as wpIgnoreBlankSummary. This will stop the
2592 # user being bounced back more than once in the event that a summary
2595 # For a bit more sophisticated detection of blank summaries, hash the
2596 # automatic one and pass that in the hidden field wpAutoSummary.
2597 if ( $this->missingSummary ||
( $this->section
== 'new' && $this->nosummary
) ) {
2598 $wgOut->addHTML( Html
::hidden( 'wpIgnoreBlankSummary', true ) );
2601 if ( $this->undidRev
) {
2602 $wgOut->addHTML( Html
::hidden( 'wpUndidRevision', $this->undidRev
) );
2605 if ( $this->selfRedirect
) {
2606 $wgOut->addHTML( Html
::hidden( 'wpIgnoreSelfRedirect', true ) );
2609 if ( $this->hasPresetSummary
) {
2610 // If a summary has been preset using &summary= we don't want to prompt for
2611 // a different summary. Only prompt for a summary if the summary is blanked.
2613 $this->autoSumm
= md5( '' );
2616 $autosumm = $this->autoSumm ?
$this->autoSumm
: md5( $this->summary
);
2617 $wgOut->addHTML( Html
::hidden( 'wpAutoSummary', $autosumm ) );
2619 $wgOut->addHTML( Html
::hidden( 'oldid', $this->oldid
) );
2620 $wgOut->addHTML( Html
::hidden( 'parentRevId', $this->getParentRevId() ) );
2622 $wgOut->addHTML( Html
::hidden( 'format', $this->contentFormat
) );
2623 $wgOut->addHTML( Html
::hidden( 'model', $this->contentModel
) );
2625 if ( $this->section
== 'new' ) {
2626 $this->showSummaryInput( true, $this->summary
);
2627 $wgOut->addHTML( $this->getSummaryPreview( true, $this->summary
) );
2630 $wgOut->addHTML( $this->editFormTextBeforeContent
);
2632 if ( !$this->isCssJsSubpage
&& $showToolbar && $wgUser->getOption( 'showtoolbar' ) ) {
2633 $wgOut->addHTML( EditPage
::getEditToolbar( $this->mTitle
) );
2636 if ( $this->blankArticle
) {
2637 $wgOut->addHTML( Html
::hidden( 'wpIgnoreBlankArticle', true ) );
2640 if ( $this->isConflict
) {
2641 // In an edit conflict bypass the overridable content form method
2642 // and fallback to the raw wpTextbox1 since editconflicts can't be
2643 // resolved between page source edits and custom ui edits using the
2645 $this->textbox2
= $this->textbox1
;
2647 $content = $this->getCurrentContent();
2648 $this->textbox1
= $this->toEditText( $content );
2650 $this->showTextbox1();
2652 $this->showContentForm();
2655 $wgOut->addHTML( $this->editFormTextAfterContent
);
2657 $this->showStandardInputs();
2659 $this->showFormAfterText();
2661 $this->showTosSummary();
2663 $this->showEditTools();
2665 $wgOut->addHTML( $this->editFormTextAfterTools
. "\n" );
2667 $wgOut->addHTML( Html
::rawElement( 'div', [ 'class' => 'templatesUsed' ],
2668 Linker
::formatTemplates( $this->getTemplates(), $this->preview
, $this->section
!= '' ) ) );
2670 $wgOut->addHTML( Html
::rawElement( 'div', [ 'class' => 'hiddencats' ],
2671 Linker
::formatHiddenCategories( $this->page
->getHiddenCategories() ) ) );
2673 $wgOut->addHTML( Html
::rawElement( 'div', [ 'class' => 'limitreport' ],
2674 self
::getPreviewLimitReport( $this->mParserOutput
) ) );
2676 $wgOut->addModules( 'mediawiki.action.edit.collapsibleFooter' );
2678 if ( $this->isConflict
) {
2680 $this->showConflict();
2681 } catch ( MWContentSerializationException
$ex ) {
2682 // this can't really happen, but be nice if it does.
2684 'content-failed-to-parse',
2685 $this->contentModel
,
2686 $this->contentFormat
,
2689 $wgOut->addWikiText( '<div class="error">' . $msg->text() . '</div>' );
2693 // Marker for detecting truncated form data. This must be the last
2694 // parameter sent in order to be of use, so do not move me.
2695 $wgOut->addHTML( Html
::hidden( 'wpUltimateParam', true ) );
2696 $wgOut->addHTML( $this->editFormTextBottom
. "\n</form>\n" );
2698 if ( !$wgUser->getOption( 'previewontop' ) ) {
2699 $this->displayPreviewArea( $previewOutput, false );
2705 * Extract the section title from current section text, if any.
2707 * @param string $text
2708 * @return string|bool String or false
2710 public static function extractSectionTitle( $text ) {
2711 preg_match( "/^(=+)(.+)\\1\\s*(\n|$)/i", $text, $matches );
2712 if ( !empty( $matches[2] ) ) {
2714 return $wgParser->stripSectionName( trim( $matches[2] ) );
2723 protected function showHeader() {
2724 global $wgOut, $wgUser, $wgMaxArticleSize, $wgLang;
2725 global $wgAllowUserCss, $wgAllowUserJs;
2727 if ( $this->mTitle
->isTalkPage() ) {
2728 $wgOut->addWikiMsg( 'talkpagetext' );
2732 $editNotices = $this->mTitle
->getEditNotices( $this->oldid
);
2733 if ( count( $editNotices ) ) {
2734 $wgOut->addHTML( implode( "\n", $editNotices ) );
2736 $msg = wfMessage( 'editnotice-notext' );
2737 if ( !$msg->isDisabled() ) {
2739 '<div class="mw-editnotice-notext">'
2740 . $msg->parseAsBlock()
2746 if ( $this->isConflict
) {
2747 $wgOut->wrapWikiMsg( "<div class='mw-explainconflict'>\n$1\n</div>", 'explainconflict' );
2748 $this->edittime
= $this->page
->getTimestamp();
2750 if ( $this->section
!= '' && !$this->isSectionEditSupported() ) {
2751 // We use $this->section to much before this and getVal('wgSection') directly in other places
2752 // at this point we can't reset $this->section to '' to fallback to non-section editing.
2753 // Someone is welcome to try refactoring though
2754 $wgOut->showErrorPage( 'sectioneditnotsupported-title', 'sectioneditnotsupported-text' );
2758 if ( $this->section
!= '' && $this->section
!= 'new' ) {
2759 if ( !$this->summary
&& !$this->preview
&& !$this->diff
) {
2760 $sectionTitle = self
::extractSectionTitle( $this->textbox1
); // FIXME: use Content object
2761 if ( $sectionTitle !== false ) {
2762 $this->summary
= "/* $sectionTitle */ ";
2767 if ( $this->missingComment
) {
2768 $wgOut->wrapWikiMsg( "<div id='mw-missingcommenttext'>\n$1\n</div>", 'missingcommenttext' );
2771 if ( $this->missingSummary
&& $this->section
!= 'new' ) {
2772 $wgOut->wrapWikiMsg( "<div id='mw-missingsummary'>\n$1\n</div>", 'missingsummary' );
2775 if ( $this->missingSummary
&& $this->section
== 'new' ) {
2776 $wgOut->wrapWikiMsg( "<div id='mw-missingcommentheader'>\n$1\n</div>", 'missingcommentheader' );
2779 if ( $this->blankArticle
) {
2780 $wgOut->wrapWikiMsg( "<div id='mw-blankarticle'>\n$1\n</div>", 'blankarticle' );
2783 if ( $this->selfRedirect
) {
2784 $wgOut->wrapWikiMsg( "<div id='mw-selfredirect'>\n$1\n</div>", 'selfredirect' );
2787 if ( $this->hookError
!== '' ) {
2788 $wgOut->addWikiText( $this->hookError
);
2791 if ( !$this->checkUnicodeCompliantBrowser() ) {
2792 $wgOut->addWikiMsg( 'nonunicodebrowser' );
2795 if ( $this->section
!= 'new' ) {
2796 $revision = $this->mArticle
->getRevisionFetched();
2798 // Let sysop know that this will make private content public if saved
2800 if ( !$revision->userCan( Revision
::DELETED_TEXT
, $wgUser ) ) {
2801 $wgOut->wrapWikiMsg(
2802 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
2803 'rev-deleted-text-permission'
2805 } elseif ( $revision->isDeleted( Revision
::DELETED_TEXT
) ) {
2806 $wgOut->wrapWikiMsg(
2807 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
2808 'rev-deleted-text-view'
2812 if ( !$revision->isCurrent() ) {
2813 $this->mArticle
->setOldSubtitle( $revision->getId() );
2814 $wgOut->addWikiMsg( 'editingold' );
2816 } elseif ( $this->mTitle
->exists() ) {
2817 // Something went wrong
2819 $wgOut->wrapWikiMsg( "<div class='errorbox'>\n$1\n</div>\n",
2820 [ 'missing-revision', $this->oldid
] );
2825 if ( wfReadOnly() ) {
2826 $wgOut->wrapWikiMsg(
2827 "<div id=\"mw-read-only-warning\">\n$1\n</div>",
2828 [ 'readonlywarning', wfReadOnlyReason() ]
2830 } elseif ( $wgUser->isAnon() ) {
2831 if ( $this->formtype
!= 'preview' ) {
2832 $wgOut->wrapWikiMsg(
2833 "<div id='mw-anon-edit-warning' class='warningbox'>\n$1\n</div>",
2834 [ 'anoneditwarning',
2836 '{{fullurl:Special:UserLogin|returnto={{FULLPAGENAMEE}}}}',
2838 '{{fullurl:Special:UserLogin/signup|returnto={{FULLPAGENAMEE}}}}' ]
2841 $wgOut->wrapWikiMsg( "<div id=\"mw-anon-preview-warning\">\n$1</div>",
2842 'anonpreviewwarning'
2846 if ( $this->isCssJsSubpage
) {
2847 # Check the skin exists
2848 if ( $this->isWrongCaseCssJsPage
) {
2849 $wgOut->wrapWikiMsg(
2850 "<div class='error' id='mw-userinvalidcssjstitle'>\n$1\n</div>",
2851 [ 'userinvalidcssjstitle', $this->mTitle
->getSkinFromCssJsSubpage() ]
2854 if ( $this->getTitle()->isSubpageOf( $wgUser->getUserPage() ) ) {
2855 if ( $this->formtype
!== 'preview' ) {
2856 if ( $this->isCssSubpage
&& $wgAllowUserCss ) {
2857 $wgOut->wrapWikiMsg(
2858 "<div id='mw-usercssyoucanpreview'>\n$1\n</div>",
2859 [ 'usercssyoucanpreview' ]
2863 if ( $this->isJsSubpage
&& $wgAllowUserJs ) {
2864 $wgOut->wrapWikiMsg(
2865 "<div id='mw-userjsyoucanpreview'>\n$1\n</div>",
2866 [ 'userjsyoucanpreview' ]
2874 if ( $this->mTitle
->isProtected( 'edit' ) &&
2875 MWNamespace
::getRestrictionLevels( $this->mTitle
->getNamespace() ) !== [ '' ]
2877 # Is the title semi-protected?
2878 if ( $this->mTitle
->isSemiProtected() ) {
2879 $noticeMsg = 'semiprotectedpagewarning';
2881 # Then it must be protected based on static groups (regular)
2882 $noticeMsg = 'protectedpagewarning';
2884 LogEventsList
::showLogExtract( $wgOut, 'protect', $this->mTitle
, '',
2885 [ 'lim' => 1, 'msgKey' => [ $noticeMsg ] ] );
2887 if ( $this->mTitle
->isCascadeProtected() ) {
2888 # Is this page under cascading protection from some source pages?
2889 /** @var Title[] $cascadeSources */
2890 list( $cascadeSources, /* $restrictions */ ) = $this->mTitle
->getCascadeProtectionSources();
2891 $notice = "<div class='mw-cascadeprotectedwarning'>\n$1\n";
2892 $cascadeSourcesCount = count( $cascadeSources );
2893 if ( $cascadeSourcesCount > 0 ) {
2894 # Explain, and list the titles responsible
2895 foreach ( $cascadeSources as $page ) {
2896 $notice .= '* [[:' . $page->getPrefixedText() . "]]\n";
2899 $notice .= '</div>';
2900 $wgOut->wrapWikiMsg( $notice, [ 'cascadeprotectedwarning', $cascadeSourcesCount ] );
2902 if ( !$this->mTitle
->exists() && $this->mTitle
->getRestrictions( 'create' ) ) {
2903 LogEventsList
::showLogExtract( $wgOut, 'protect', $this->mTitle
, '',
2905 'showIfEmpty' => false,
2906 'msgKey' => [ 'titleprotectedwarning' ],
2907 'wrap' => "<div class=\"mw-titleprotectedwarning\">\n$1</div>" ] );
2910 if ( $this->kblength
=== false ) {
2911 $this->kblength
= (int)( strlen( $this->textbox1
) / 1024 );
2914 if ( $this->tooBig ||
$this->kblength
> $wgMaxArticleSize ) {
2915 $wgOut->wrapWikiMsg( "<div class='error' id='mw-edit-longpageerror'>\n$1\n</div>",
2918 $wgLang->formatNum( $this->kblength
),
2919 $wgLang->formatNum( $wgMaxArticleSize )
2923 if ( !wfMessage( 'longpage-hint' )->isDisabled() ) {
2924 $wgOut->wrapWikiMsg( "<div id='mw-edit-longpage-hint'>\n$1\n</div>",
2927 $wgLang->formatSize( strlen( $this->textbox1
) ),
2928 strlen( $this->textbox1
)
2933 # Add header copyright warning
2934 $this->showHeaderCopyrightWarning();
2940 * Standard summary input and label (wgSummary), abstracted so EditPage
2941 * subclasses may reorganize the form.
2942 * Note that you do not need to worry about the label's for=, it will be
2943 * inferred by the id given to the input. You can remove them both by
2944 * passing array( 'id' => false ) to $userInputAttrs.
2946 * @param string $summary The value of the summary input
2947 * @param string $labelText The html to place inside the label
2948 * @param array $inputAttrs Array of attrs to use on the input
2949 * @param array $spanLabelAttrs Array of attrs to use on the span inside the label
2951 * @return array An array in the format array( $label, $input )
2953 function getSummaryInput( $summary = "", $labelText = null,
2954 $inputAttrs = null, $spanLabelAttrs = null
2956 // Note: the maxlength is overridden in JS to 255 and to make it use UTF-8 bytes, not characters.
2957 $inputAttrs = ( is_array( $inputAttrs ) ?
$inputAttrs : [] ) +
[
2958 'id' => 'wpSummary',
2959 'maxlength' => '200',
2962 'spellcheck' => 'true',
2963 ] + Linker
::tooltipAndAccesskeyAttribs( 'summary' );
2965 $spanLabelAttrs = ( is_array( $spanLabelAttrs ) ?
$spanLabelAttrs : [] ) +
[
2966 'class' => $this->missingSummary ?
'mw-summarymissed' : 'mw-summary',
2967 'id' => "wpSummaryLabel"
2974 $inputAttrs['id'] ?
[ 'for' => $inputAttrs['id'] ] : null,
2977 $label = Xml
::tags( 'span', $spanLabelAttrs, $label );
2980 $input = Html
::input( 'wpSummary', $summary, 'text', $inputAttrs );
2982 return [ $label, $input ];
2986 * @param bool $isSubjectPreview True if this is the section subject/title
2987 * up top, or false if this is the comment summary
2988 * down below the textarea
2989 * @param string $summary The text of the summary to display
2991 protected function showSummaryInput( $isSubjectPreview, $summary = "" ) {
2992 global $wgOut, $wgContLang;
2993 # Add a class if 'missingsummary' is triggered to allow styling of the summary line
2994 $summaryClass = $this->missingSummary ?
'mw-summarymissed' : 'mw-summary';
2995 if ( $isSubjectPreview ) {
2996 if ( $this->nosummary
) {
3000 if ( !$this->mShowSummaryField
) {
3004 $summary = $wgContLang->recodeForEdit( $summary );
3005 $labelText = wfMessage( $isSubjectPreview ?
'subject' : 'summary' )->parse();
3006 list( $label, $input ) = $this->getSummaryInput(
3009 [ 'class' => $summaryClass ],
3012 $wgOut->addHTML( "{$label} {$input}" );
3016 * @param bool $isSubjectPreview True if this is the section subject/title
3017 * up top, or false if this is the comment summary
3018 * down below the textarea
3019 * @param string $summary The text of the summary to display
3022 protected function getSummaryPreview( $isSubjectPreview, $summary = "" ) {
3023 // avoid spaces in preview, gets always trimmed on save
3024 $summary = trim( $summary );
3025 if ( !$summary ||
( !$this->preview
&& !$this->diff
) ) {
3031 if ( $isSubjectPreview ) {
3032 $summary = wfMessage( 'newsectionsummary' )->rawParams( $wgParser->stripSectionName( $summary ) )
3033 ->inContentLanguage()->text();
3036 $message = $isSubjectPreview ?
'subject-preview' : 'summary-preview';
3038 $summary = wfMessage( $message )->parse()
3039 . Linker
::commentBlock( $summary, $this->mTitle
, $isSubjectPreview );
3040 return Xml
::tags( 'div', [ 'class' => 'mw-summary-preview' ], $summary );
3043 protected function showFormBeforeText() {
3045 $section = htmlspecialchars( $this->section
);
3046 $wgOut->addHTML( <<<HTML
3047 <input type='hidden' value="{$section}" name="wpSection"/>
3048 <input type='hidden' value="{$this->starttime}" name="wpStarttime" />
3049 <input type='hidden' value="{$this->edittime}" name="wpEdittime" />
3050 <input type='hidden' value="{$this->scrolltop}" name="wpScrolltop" id="wpScrolltop" />
3054 if ( !$this->checkUnicodeCompliantBrowser() ) {
3055 $wgOut->addHTML( Html
::hidden( 'safemode', '1' ) );
3059 protected function showFormAfterText() {
3060 global $wgOut, $wgUser;
3062 * To make it harder for someone to slip a user a page
3063 * which submits an edit form to the wiki without their
3064 * knowledge, a random token is associated with the login
3065 * session. If it's not passed back with the submission,
3066 * we won't save the page, or render user JavaScript and
3069 * For anon editors, who may not have a session, we just
3070 * include the constant suffix to prevent editing from
3071 * broken text-mangling proxies.
3073 $wgOut->addHTML( "\n" . Html
::hidden( "wpEditToken", $wgUser->getEditToken() ) . "\n" );
3077 * Subpage overridable method for printing the form for page content editing
3078 * By default this simply outputs wpTextbox1
3079 * Subclasses can override this to provide a custom UI for editing;
3080 * be it a form, or simply wpTextbox1 with a modified content that will be
3081 * reverse modified when extracted from the post data.
3082 * Note that this is basically the inverse for importContentFormData
3084 protected function showContentForm() {
3085 $this->showTextbox1();
3089 * Method to output wpTextbox1
3090 * The $textoverride method can be used by subclasses overriding showContentForm
3091 * to pass back to this method.
3093 * @param array $customAttribs Array of html attributes to use in the textarea
3094 * @param string $textoverride Optional text to override $this->textarea1 with
3096 protected function showTextbox1( $customAttribs = null, $textoverride = null ) {
3097 if ( $this->wasDeletedSinceLastEdit() && $this->formtype
== 'save' ) {
3098 $attribs = [ 'style' => 'display:none;' ];
3100 $classes = []; // Textarea CSS
3101 if ( $this->mTitle
->isProtected( 'edit' ) &&
3102 MWNamespace
::getRestrictionLevels( $this->mTitle
->getNamespace() ) !== [ '' ]
3104 # Is the title semi-protected?
3105 if ( $this->mTitle
->isSemiProtected() ) {
3106 $classes[] = 'mw-textarea-sprotected';
3108 # Then it must be protected based on static groups (regular)
3109 $classes[] = 'mw-textarea-protected';
3111 # Is the title cascade-protected?
3112 if ( $this->mTitle
->isCascadeProtected() ) {
3113 $classes[] = 'mw-textarea-cprotected';
3117 $attribs = [ 'tabindex' => 1 ];
3119 if ( is_array( $customAttribs ) ) {
3120 $attribs +
= $customAttribs;
3123 if ( count( $classes ) ) {
3124 if ( isset( $attribs['class'] ) ) {
3125 $classes[] = $attribs['class'];
3127 $attribs['class'] = implode( ' ', $classes );
3132 $textoverride !== null ?
$textoverride : $this->textbox1
,
3138 protected function showTextbox2() {
3139 $this->showTextbox( $this->textbox2
, 'wpTextbox2', [ 'tabindex' => 6, 'readonly' ] );
3142 protected function showTextbox( $text, $name, $customAttribs = [] ) {
3143 global $wgOut, $wgUser;
3145 $wikitext = $this->safeUnicodeOutput( $text );
3146 if ( strval( $wikitext ) !== '' ) {
3147 // Ensure there's a newline at the end, otherwise adding lines
3149 // But don't add a newline if the ext is empty, or Firefox in XHTML
3150 // mode will show an extra newline. A bit annoying.
3154 $attribs = $customAttribs +
[
3157 'cols' => $wgUser->getIntOption( 'cols' ),
3158 'rows' => $wgUser->getIntOption( 'rows' ),
3159 // Avoid PHP notices when appending preferences
3160 // (appending allows customAttribs['style'] to still work).
3164 $pageLang = $this->mTitle
->getPageLanguage();
3165 $attribs['lang'] = $pageLang->getHtmlCode();
3166 $attribs['dir'] = $pageLang->getDir();
3168 $wgOut->addHTML( Html
::textarea( $name, $wikitext, $attribs ) );
3171 protected function displayPreviewArea( $previewOutput, $isOnTop = false ) {
3175 $classes[] = 'ontop';
3178 $attribs = [ 'id' => 'wikiPreview', 'class' => implode( ' ', $classes ) ];
3180 if ( $this->formtype
!= 'preview' ) {
3181 $attribs['style'] = 'display: none;';
3184 $wgOut->addHTML( Xml
::openElement( 'div', $attribs ) );
3186 if ( $this->formtype
== 'preview' ) {
3187 $this->showPreview( $previewOutput );
3189 // Empty content container for LivePreview
3190 $pageViewLang = $this->mTitle
->getPageViewLanguage();
3191 $attribs = [ 'lang' => $pageViewLang->getHtmlCode(), 'dir' => $pageViewLang->getDir(),
3192 'class' => 'mw-content-' . $pageViewLang->getDir() ];
3193 $wgOut->addHTML( Html
::rawElement( 'div', $attribs ) );
3196 $wgOut->addHTML( '</div>' );
3198 if ( $this->formtype
== 'diff' ) {
3201 } catch ( MWContentSerializationException
$ex ) {
3203 'content-failed-to-parse',
3204 $this->contentModel
,
3205 $this->contentFormat
,
3208 $wgOut->addWikiText( '<div class="error">' . $msg->text() . '</div>' );
3214 * Append preview output to $wgOut.
3215 * Includes category rendering if this is a category page.
3217 * @param string $text The HTML to be output for the preview.
3219 protected function showPreview( $text ) {
3221 if ( $this->mTitle
->getNamespace() == NS_CATEGORY
) {
3222 $this->mArticle
->openShowCategory();
3224 # This hook seems slightly odd here, but makes things more
3225 # consistent for extensions.
3226 Hooks
::run( 'OutputPageBeforeHTML', [ &$wgOut, &$text ] );
3227 $wgOut->addHTML( $text );
3228 if ( $this->mTitle
->getNamespace() == NS_CATEGORY
) {
3229 $this->mArticle
->closeShowCategory();
3234 * Get a diff between the current contents of the edit box and the
3235 * version of the page we're editing from.
3237 * If this is a section edit, we'll replace the section as for final
3238 * save and then make a comparison.
3240 function showDiff() {
3241 global $wgUser, $wgContLang, $wgOut;
3243 $oldtitlemsg = 'currentrev';
3244 # if message does not exist, show diff against the preloaded default
3245 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
&& !$this->mTitle
->exists() ) {
3246 $oldtext = $this->mTitle
->getDefaultMessageText();
3247 if ( $oldtext !== false ) {
3248 $oldtitlemsg = 'defaultmessagetext';
3249 $oldContent = $this->toEditContent( $oldtext );
3254 $oldContent = $this->getCurrentContent();
3257 $textboxContent = $this->toEditContent( $this->textbox1
);
3259 $newContent = $this->page
->replaceSectionContent(
3260 $this->section
, $textboxContent,
3261 $this->summary
, $this->edittime
);
3263 if ( $newContent ) {
3264 ContentHandler
::runLegacyHooks( 'EditPageGetDiffText', [ $this, &$newContent ] );
3265 Hooks
::run( 'EditPageGetDiffContent', [ $this, &$newContent ] );
3267 $popts = ParserOptions
::newFromUserAndLang( $wgUser, $wgContLang );
3268 $newContent = $newContent->preSaveTransform( $this->mTitle
, $wgUser, $popts );
3271 if ( ( $oldContent && !$oldContent->isEmpty() ) ||
( $newContent && !$newContent->isEmpty() ) ) {
3272 $oldtitle = wfMessage( $oldtitlemsg )->parse();
3273 $newtitle = wfMessage( 'yourtext' )->parse();
3275 if ( !$oldContent ) {
3276 $oldContent = $newContent->getContentHandler()->makeEmptyContent();
3279 if ( !$newContent ) {
3280 $newContent = $oldContent->getContentHandler()->makeEmptyContent();
3283 $de = $oldContent->getContentHandler()->createDifferenceEngine( $this->mArticle
->getContext() );
3284 $de->setContent( $oldContent, $newContent );
3286 $difftext = $de->getDiff( $oldtitle, $newtitle );
3287 $de->showDiffStyle();
3292 $wgOut->addHTML( '<div id="wikiDiff">' . $difftext . '</div>' );
3296 * Show the header copyright warning.
3298 protected function showHeaderCopyrightWarning() {
3299 $msg = 'editpage-head-copy-warn';
3300 if ( !wfMessage( $msg )->isDisabled() ) {
3302 $wgOut->wrapWikiMsg( "<div class='editpage-head-copywarn'>\n$1\n</div>",
3303 'editpage-head-copy-warn' );
3308 * Give a chance for site and per-namespace customizations of
3309 * terms of service summary link that might exist separately
3310 * from the copyright notice.
3312 * This will display between the save button and the edit tools,
3313 * so should remain short!
3315 protected function showTosSummary() {
3316 $msg = 'editpage-tos-summary';
3317 Hooks
::run( 'EditPageTosSummary', [ $this->mTitle
, &$msg ] );
3318 if ( !wfMessage( $msg )->isDisabled() ) {
3320 $wgOut->addHTML( '<div class="mw-tos-summary">' );
3321 $wgOut->addWikiMsg( $msg );
3322 $wgOut->addHTML( '</div>' );
3326 protected function showEditTools() {
3328 $wgOut->addHTML( '<div class="mw-editTools">' .
3329 wfMessage( 'edittools' )->inContentLanguage()->parse() .
3334 * Get the copyright warning
3336 * Renamed to getCopyrightWarning(), old name kept around for backwards compatibility
3339 protected function getCopywarn() {
3340 return self
::getCopyrightWarning( $this->mTitle
);
3344 * Get the copyright warning, by default returns wikitext
3346 * @param Title $title
3347 * @param string $format Output format, valid values are any function of a Message object
3350 public static function getCopyrightWarning( $title, $format = 'plain' ) {
3351 global $wgRightsText;
3352 if ( $wgRightsText ) {
3353 $copywarnMsg = [ 'copyrightwarning',
3354 '[[' . wfMessage( 'copyrightpage' )->inContentLanguage()->text() . ']]',
3357 $copywarnMsg = [ 'copyrightwarning2',
3358 '[[' . wfMessage( 'copyrightpage' )->inContentLanguage()->text() . ']]' ];
3360 // Allow for site and per-namespace customization of contribution/copyright notice.
3361 Hooks
::run( 'EditPageCopyrightWarning', [ $title, &$copywarnMsg ] );
3363 return "<div id=\"editpage-copywarn\">\n" .
3364 call_user_func_array( 'wfMessage', $copywarnMsg )->$format() . "\n</div>";
3368 * Get the Limit report for page previews
3371 * @param ParserOutput $output ParserOutput object from the parse
3372 * @return string HTML
3374 public static function getPreviewLimitReport( $output ) {
3375 if ( !$output ||
!$output->getLimitReportData() ) {
3379 $limitReport = Html
::rawElement( 'div', [ 'class' => 'mw-limitReportExplanation' ],
3380 wfMessage( 'limitreport-title' )->parseAsBlock()
3383 // Show/hide animation doesn't work correctly on a table, so wrap it in a div.
3384 $limitReport .= Html
::openElement( 'div', [ 'class' => 'preview-limit-report-wrapper' ] );
3386 $limitReport .= Html
::openElement( 'table', [
3387 'class' => 'preview-limit-report wikitable'
3389 Html
::openElement( 'tbody' );
3391 foreach ( $output->getLimitReportData() as $key => $value ) {
3392 if ( Hooks
::run( 'ParserLimitReportFormat',
3393 [ $key, &$value, &$limitReport, true, true ]
3395 $keyMsg = wfMessage( $key );
3396 $valueMsg = wfMessage( [ "$key-value-html", "$key-value" ] );
3397 if ( !$valueMsg->exists() ) {
3398 $valueMsg = new RawMessage( '$1' );
3400 if ( !$keyMsg->isDisabled() && !$valueMsg->isDisabled() ) {
3401 $limitReport .= Html
::openElement( 'tr' ) .
3402 Html
::rawElement( 'th', null, $keyMsg->parse() ) .
3403 Html
::rawElement( 'td', null, $valueMsg->params( $value )->parse() ) .
3404 Html
::closeElement( 'tr' );
3409 $limitReport .= Html
::closeElement( 'tbody' ) .
3410 Html
::closeElement( 'table' ) .
3411 Html
::closeElement( 'div' );
3413 return $limitReport;
3416 protected function showStandardInputs( &$tabindex = 2 ) {
3418 $wgOut->addHTML( "<div class='editOptions'>\n" );
3420 if ( $this->section
!= 'new' ) {
3421 $this->showSummaryInput( false, $this->summary
);
3422 $wgOut->addHTML( $this->getSummaryPreview( false, $this->summary
) );
3425 $checkboxes = $this->getCheckboxes( $tabindex,
3426 [ 'minor' => $this->minoredit
, 'watch' => $this->watchthis
] );
3427 $wgOut->addHTML( "<div class='editCheckboxes'>" . implode( $checkboxes, "\n" ) . "</div>\n" );
3429 // Show copyright warning.
3430 $wgOut->addWikiText( $this->getCopywarn() );
3431 $wgOut->addHTML( $this->editFormTextAfterWarn
);
3433 $wgOut->addHTML( "<div class='editButtons'>\n" );
3434 $wgOut->addHTML( implode( $this->getEditButtons( $tabindex ), "\n" ) . "\n" );
3436 $cancel = $this->getCancelLink();
3437 if ( $cancel !== '' ) {
3438 $cancel .= Html
::element( 'span',
3439 [ 'class' => 'mw-editButtons-pipe-separator' ],
3440 wfMessage( 'pipe-separator' )->text() );
3443 $message = wfMessage( 'edithelppage' )->inContentLanguage()->text();
3444 $edithelpurl = Skin
::makeInternalOrExternalUrl( $message );
3446 'target' => 'helpwindow',
3447 'href' => $edithelpurl,
3449 $edithelp = Html
::linkButton( wfMessage( 'edithelp' )->text(),
3450 $attrs, [ 'mw-ui-quiet' ] ) .
3451 wfMessage( 'word-separator' )->escaped() .
3452 wfMessage( 'newwindow' )->parse();
3454 $wgOut->addHTML( " <span class='cancelLink'>{$cancel}</span>\n" );
3455 $wgOut->addHTML( " <span class='editHelp'>{$edithelp}</span>\n" );
3456 $wgOut->addHTML( "</div><!-- editButtons -->\n" );
3458 Hooks
::run( 'EditPage::showStandardInputs:options', [ $this, $wgOut, &$tabindex ] );
3460 $wgOut->addHTML( "</div><!-- editOptions -->\n" );
3464 * Show an edit conflict. textbox1 is already shown in showEditForm().
3465 * If you want to use another entry point to this function, be careful.
3467 protected function showConflict() {
3470 if ( Hooks
::run( 'EditPageBeforeConflictDiff', [ &$this, &$wgOut ] ) ) {
3471 $stats = $wgOut->getContext()->getStats();
3472 $stats->increment( 'edit.failures.conflict' );
3474 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
3476 $content1 = $this->toEditContent( $this->textbox1
);
3477 $content2 = $this->toEditContent( $this->textbox2
);
3479 $handler = ContentHandler
::getForModelID( $this->contentModel
);
3480 $de = $handler->createDifferenceEngine( $this->mArticle
->getContext() );
3481 $de->setContent( $content2, $content1 );
3483 wfMessage( 'yourtext' )->parse(),
3484 wfMessage( 'storedversion' )->text()
3487 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
3488 $this->showTextbox2();
3495 public function getCancelLink() {
3497 if ( !$this->isConflict
&& $this->oldid
> 0 ) {
3498 $cancelParams['oldid'] = $this->oldid
;
3500 $attrs = [ 'id' => 'mw-editform-cancel' ];
3502 return Linker
::linkKnown(
3503 $this->getContextTitle(),
3504 wfMessage( 'cancel' )->parse(),
3505 Html
::buttonAttributes( $attrs, [ 'mw-ui-quiet' ] ),
3511 * Returns the URL to use in the form's action attribute.
3512 * This is used by EditPage subclasses when simply customizing the action
3513 * variable in the constructor is not enough. This can be used when the
3514 * EditPage lives inside of a Special page rather than a custom page action.
3516 * @param Title $title Title object for which is being edited (where we go to for &action= links)
3519 protected function getActionURL( Title
$title ) {
3520 return $title->getLocalURL( [ 'action' => $this->action
] );
3524 * Check if a page was deleted while the user was editing it, before submit.
3525 * Note that we rely on the logging table, which hasn't been always there,
3526 * but that doesn't matter, because this only applies to brand new
3530 protected function wasDeletedSinceLastEdit() {
3531 if ( $this->deletedSinceEdit
!== null ) {
3532 return $this->deletedSinceEdit
;
3535 $this->deletedSinceEdit
= false;
3537 if ( !$this->mTitle
->exists() && $this->mTitle
->isDeletedQuick() ) {
3538 $this->lastDelete
= $this->getLastDelete();
3539 if ( $this->lastDelete
) {
3540 $deleteTime = wfTimestamp( TS_MW
, $this->lastDelete
->log_timestamp
);
3541 if ( $deleteTime > $this->starttime
) {
3542 $this->deletedSinceEdit
= true;
3547 return $this->deletedSinceEdit
;
3551 * @return bool|stdClass
3553 protected function getLastDelete() {
3554 $dbr = wfGetDB( DB_SLAVE
);
3555 $data = $dbr->selectRow(
3556 [ 'logging', 'user' ],
3569 'log_namespace' => $this->mTitle
->getNamespace(),
3570 'log_title' => $this->mTitle
->getDBkey(),
3571 'log_type' => 'delete',
3572 'log_action' => 'delete',
3576 [ 'LIMIT' => 1, 'ORDER BY' => 'log_timestamp DESC' ]
3578 // Quick paranoid permission checks...
3579 if ( is_object( $data ) ) {
3580 if ( $data->log_deleted
& LogPage
::DELETED_USER
) {
3581 $data->user_name
= wfMessage( 'rev-deleted-user' )->escaped();
3584 if ( $data->log_deleted
& LogPage
::DELETED_COMMENT
) {
3585 $data->log_comment
= wfMessage( 'rev-deleted-comment' )->escaped();
3593 * Get the rendered text for previewing.
3594 * @throws MWException
3597 function getPreviewText() {
3598 global $wgOut, $wgUser, $wgRawHtml, $wgLang;
3599 global $wgAllowUserCss, $wgAllowUserJs;
3601 $stats = $wgOut->getContext()->getStats();
3603 if ( $wgRawHtml && !$this->mTokenOk
) {
3604 // Could be an offsite preview attempt. This is very unsafe if
3605 // HTML is enabled, as it could be an attack.
3607 if ( $this->textbox1
!== '' ) {
3608 // Do not put big scary notice, if previewing the empty
3609 // string, which happens when you initially edit
3610 // a category page, due to automatic preview-on-open.
3611 $parsedNote = $wgOut->parse( "<div class='previewnote'>" .
3612 wfMessage( 'session_fail_preview_html' )->text() . "</div>", true, /* interface */true );
3614 $stats->increment( 'edit.failures.session_loss' );
3621 $content = $this->toEditContent( $this->textbox1
);
3625 'AlternateEditPreview',
3626 [ $this, &$content, &$previewHTML, &$this->mParserOutput
] )
3628 return $previewHTML;
3631 # provide a anchor link to the editform
3632 $continueEditing = '<span class="mw-continue-editing">' .
3633 '[[#' . self
::EDITFORM_ID
. '|' . $wgLang->getArrow() . ' ' .
3634 wfMessage( 'continue-editing' )->text() . ']]</span>';
3635 if ( $this->mTriedSave
&& !$this->mTokenOk
) {
3636 if ( $this->mTokenOkExceptSuffix
) {
3637 $note = wfMessage( 'token_suffix_mismatch' )->plain();
3638 $stats->increment( 'edit.failures.bad_token' );
3640 $note = wfMessage( 'session_fail_preview' )->plain();
3641 $stats->increment( 'edit.failures.session_loss' );
3643 } elseif ( $this->incompleteForm
) {
3644 $note = wfMessage( 'edit_form_incomplete' )->plain();
3645 if ( $this->mTriedSave
) {
3646 $stats->increment( 'edit.failures.incomplete_form' );
3649 $note = wfMessage( 'previewnote' )->plain() . ' ' . $continueEditing;
3652 $parserOptions = $this->page
->makeParserOptions( $this->mArticle
->getContext() );
3653 $parserOptions->setIsPreview( true );
3654 $parserOptions->setIsSectionPreview( !is_null( $this->section
) && $this->section
!== '' );
3656 # don't parse non-wikitext pages, show message about preview
3657 if ( $this->mTitle
->isCssJsSubpage() ||
$this->mTitle
->isCssOrJsPage() ) {
3658 if ( $this->mTitle
->isCssJsSubpage() ) {
3660 } elseif ( $this->mTitle
->isCssOrJsPage() ) {
3666 if ( $content->getModel() == CONTENT_MODEL_CSS
) {
3668 if ( $level === 'user' && !$wgAllowUserCss ) {
3671 } elseif ( $content->getModel() == CONTENT_MODEL_JAVASCRIPT
) {
3673 if ( $level === 'user' && !$wgAllowUserJs ) {
3680 # Used messages to make sure grep find them:
3681 # Messages: usercsspreview, userjspreview, sitecsspreview, sitejspreview
3682 if ( $level && $format ) {
3683 $note = "<div id='mw-{$level}{$format}preview'>" .
3684 wfMessage( "{$level}{$format}preview" )->text() .
3685 ' ' . $continueEditing . "</div>";
3689 # If we're adding a comment, we need to show the
3690 # summary as the headline
3691 if ( $this->section
=== "new" && $this->summary
!== "" ) {
3692 $content = $content->addSectionHeader( $this->summary
);
3695 $hook_args = [ $this, &$content ];
3696 ContentHandler
::runLegacyHooks( 'EditPageGetPreviewText', $hook_args );
3697 Hooks
::run( 'EditPageGetPreviewContent', $hook_args );
3699 $parserOptions->enableLimitReport();
3701 # For CSS/JS pages, we should have called the ShowRawCssJs hook here.
3702 # But it's now deprecated, so never mind
3704 $pstContent = $content->preSaveTransform( $this->mTitle
, $wgUser, $parserOptions );
3705 $scopedCallback = $parserOptions->setupFakeRevision(
3706 $this->mTitle
, $pstContent, $wgUser );
3707 $parserOutput = $pstContent->getParserOutput( $this->mTitle
, null, $parserOptions );
3709 # Try to stash the edit for the final submission step
3710 # @todo: different date format preferences cause cache misses
3711 ApiStashEdit
::stashEditFromPreview(
3712 $this->getArticle(), $content, $pstContent,
3713 $parserOutput, $parserOptions, $parserOptions, wfTimestampNow()
3716 $parserOutput->setEditSectionTokens( false ); // no section edit links
3717 $previewHTML = $parserOutput->getText();
3718 $this->mParserOutput
= $parserOutput;
3719 $wgOut->addParserOutputMetadata( $parserOutput );
3721 if ( count( $parserOutput->getWarnings() ) ) {
3722 $note .= "\n\n" . implode( "\n\n", $parserOutput->getWarnings() );
3725 ScopedCallback
::consume( $scopedCallback );
3726 } catch ( MWContentSerializationException
$ex ) {
3728 'content-failed-to-parse',
3729 $this->contentModel
,
3730 $this->contentFormat
,
3733 $note .= "\n\n" . $m->parse();
3737 if ( $this->isConflict
) {
3738 $conflict = '<h2 id="mw-previewconflict">'
3739 . wfMessage( 'previewconflict' )->escaped() . "</h2>\n";
3741 $conflict = '<hr />';
3744 $previewhead = "<div class='previewnote'>\n" .
3745 '<h2 id="mw-previewheader">' . wfMessage( 'preview' )->escaped() . "</h2>" .
3746 $wgOut->parse( $note, true, /* interface */true ) . $conflict . "</div>\n";
3748 $pageViewLang = $this->mTitle
->getPageViewLanguage();
3749 $attribs = [ 'lang' => $pageViewLang->getHtmlCode(), 'dir' => $pageViewLang->getDir(),
3750 'class' => 'mw-content-' . $pageViewLang->getDir() ];
3751 $previewHTML = Html
::rawElement( 'div', $attribs, $previewHTML );
3753 return $previewhead . $previewHTML . $this->previewTextAfterContent
;
3759 function getTemplates() {
3760 if ( $this->preview ||
$this->section
!= '' ) {
3762 if ( !isset( $this->mParserOutput
) ) {
3765 foreach ( $this->mParserOutput
->getTemplates() as $ns => $template ) {
3766 foreach ( array_keys( $template ) as $dbk ) {
3767 $templates[] = Title
::makeTitle( $ns, $dbk );
3772 return $this->mTitle
->getTemplateLinksFrom();
3777 * Shows a bulletin board style toolbar for common editing functions.
3778 * It can be disabled in the user preferences.
3780 * @param $title Title object for the page being edited (optional)
3783 static function getEditToolbar( $title = null ) {
3784 global $wgContLang, $wgOut;
3785 global $wgEnableUploads, $wgForeignFileRepos;
3787 $imagesAvailable = $wgEnableUploads ||
count( $wgForeignFileRepos );
3788 $showSignature = true;
3790 $showSignature = MWNamespace
::wantSignatures( $title->getNamespace() );
3794 * $toolarray is an array of arrays each of which includes the
3795 * opening tag, the closing tag, optionally a sample text that is
3796 * inserted between the two when no selection is highlighted
3797 * and. The tip text is shown when the user moves the mouse
3800 * Images are defined in ResourceLoaderEditToolbarModule.
3804 'id' => 'mw-editbutton-bold',
3806 'close' => '\'\'\'',
3807 'sample' => wfMessage( 'bold_sample' )->text(),
3808 'tip' => wfMessage( 'bold_tip' )->text(),
3811 'id' => 'mw-editbutton-italic',
3814 'sample' => wfMessage( 'italic_sample' )->text(),
3815 'tip' => wfMessage( 'italic_tip' )->text(),
3818 'id' => 'mw-editbutton-link',
3821 'sample' => wfMessage( 'link_sample' )->text(),
3822 'tip' => wfMessage( 'link_tip' )->text(),
3825 'id' => 'mw-editbutton-extlink',
3828 'sample' => wfMessage( 'extlink_sample' )->text(),
3829 'tip' => wfMessage( 'extlink_tip' )->text(),
3832 'id' => 'mw-editbutton-headline',
3835 'sample' => wfMessage( 'headline_sample' )->text(),
3836 'tip' => wfMessage( 'headline_tip' )->text(),
3838 $imagesAvailable ?
[
3839 'id' => 'mw-editbutton-image',
3840 'open' => '[[' . $wgContLang->getNsText( NS_FILE
) . ':',
3842 'sample' => wfMessage( 'image_sample' )->text(),
3843 'tip' => wfMessage( 'image_tip' )->text(),
3845 $imagesAvailable ?
[
3846 'id' => 'mw-editbutton-media',
3847 'open' => '[[' . $wgContLang->getNsText( NS_MEDIA
) . ':',
3849 'sample' => wfMessage( 'media_sample' )->text(),
3850 'tip' => wfMessage( 'media_tip' )->text(),
3853 'id' => 'mw-editbutton-nowiki',
3854 'open' => "<nowiki>",
3855 'close' => "</nowiki>",
3856 'sample' => wfMessage( 'nowiki_sample' )->text(),
3857 'tip' => wfMessage( 'nowiki_tip' )->text(),
3860 'id' => 'mw-editbutton-signature',
3864 'tip' => wfMessage( 'sig_tip' )->text(),
3867 'id' => 'mw-editbutton-hr',
3868 'open' => "\n----\n",
3871 'tip' => wfMessage( 'hr_tip' )->text(),
3875 $script = 'mw.loader.using("mediawiki.toolbar", function () {';
3876 foreach ( $toolarray as $tool ) {
3882 // Images are defined in ResourceLoaderEditToolbarModule
3884 // Note that we use the tip both for the ALT tag and the TITLE tag of the image.
3885 // Older browsers show a "speedtip" type message only for ALT.
3886 // Ideally these should be different, realistically they
3887 // probably don't need to be.
3895 $script .= Xml
::encodeJsCall(
3896 'mw.toolbar.addButton',
3898 ResourceLoader
::inDebugMode()
3903 $wgOut->addScript( ResourceLoader
::makeInlineScript( $script ) );
3905 $toolbar = '<div id="toolbar"></div>';
3907 Hooks
::run( 'EditPageBeforeEditToolbar', [ &$toolbar ] );
3913 * Returns an array of html code of the following checkboxes:
3916 * @param int $tabindex Current tabindex
3917 * @param array $checked Array of checkbox => bool, where bool indicates the checked
3918 * status of the checkbox
3922 public function getCheckboxes( &$tabindex, $checked ) {
3923 global $wgUser, $wgUseMediaWikiUIEverywhere;
3927 // don't show the minor edit checkbox if it's a new page or section
3928 if ( !$this->isNew
) {
3929 $checkboxes['minor'] = '';
3930 $minorLabel = wfMessage( 'minoredit' )->parse();
3931 if ( $wgUser->isAllowed( 'minoredit' ) ) {
3933 'tabindex' => ++
$tabindex,
3934 'accesskey' => wfMessage( 'accesskey-minoredit' )->text(),
3935 'id' => 'wpMinoredit',
3938 Xml
::check( 'wpMinoredit', $checked['minor'], $attribs ) .
3939 " <label for='wpMinoredit' id='mw-editpage-minoredit'" .
3940 Xml
::expandAttributes( [ 'title' => Linker
::titleAttrib( 'minoredit', 'withaccess' ) ] ) .
3941 ">{$minorLabel}</label>";
3943 if ( $wgUseMediaWikiUIEverywhere ) {
3944 $checkboxes['minor'] = Html
::openElement( 'div', [ 'class' => 'mw-ui-checkbox' ] ) .
3946 Html
::closeElement( 'div' );
3948 $checkboxes['minor'] = $minorEditHtml;
3953 $watchLabel = wfMessage( 'watchthis' )->parse();
3954 $checkboxes['watch'] = '';
3955 if ( $wgUser->isLoggedIn() ) {
3957 'tabindex' => ++
$tabindex,
3958 'accesskey' => wfMessage( 'accesskey-watch' )->text(),
3959 'id' => 'wpWatchthis',
3962 Xml
::check( 'wpWatchthis', $checked['watch'], $attribs ) .
3963 " <label for='wpWatchthis' id='mw-editpage-watch'" .
3964 Xml
::expandAttributes( [ 'title' => Linker
::titleAttrib( 'watch', 'withaccess' ) ] ) .
3965 ">{$watchLabel}</label>";
3966 if ( $wgUseMediaWikiUIEverywhere ) {
3967 $checkboxes['watch'] = Html
::openElement( 'div', [ 'class' => 'mw-ui-checkbox' ] ) .
3969 Html
::closeElement( 'div' );
3971 $checkboxes['watch'] = $watchThisHtml;
3974 Hooks
::run( 'EditPageBeforeEditChecks', [ &$this, &$checkboxes, &$tabindex ] );
3979 * Returns an array of html code of the following buttons:
3980 * save, diff, preview and live
3982 * @param int $tabindex Current tabindex
3986 public function getEditButtons( &$tabindex ) {
3992 'tabindex' => ++
$tabindex,
3993 ] + Linker
::tooltipAndAccesskeyAttribs( 'save' );
3994 $buttons['save'] = Html
::submitButton( wfMessage( 'savearticle' )->text(),
3995 $attribs, [ 'mw-ui-constructive' ] );
3997 ++
$tabindex; // use the same for preview and live preview
3999 'id' => 'wpPreview',
4000 'name' => 'wpPreview',
4001 'tabindex' => $tabindex,
4002 ] + Linker
::tooltipAndAccesskeyAttribs( 'preview' );
4003 $buttons['preview'] = Html
::submitButton( wfMessage( 'showpreview' )->text(),
4005 $buttons['live'] = '';
4010 'tabindex' => ++
$tabindex,
4011 ] + Linker
::tooltipAndAccesskeyAttribs( 'diff' );
4012 $buttons['diff'] = Html
::submitButton( wfMessage( 'showdiff' )->text(),
4015 Hooks
::run( 'EditPageBeforeEditButtons', [ &$this, &$buttons, &$tabindex ] );
4020 * Creates a basic error page which informs the user that
4021 * they have attempted to edit a nonexistent section.
4023 function noSuchSectionPage() {
4026 $wgOut->prepareErrorPage( wfMessage( 'nosuchsectiontitle' ) );
4028 $res = wfMessage( 'nosuchsectiontext', $this->section
)->parseAsBlock();
4029 Hooks
::run( 'EditPageNoSuchSection', [ &$this, &$res ] );
4030 $wgOut->addHTML( $res );
4032 $wgOut->returnToMain( false, $this->mTitle
);
4036 * Show "your edit contains spam" page with your diff and text
4038 * @param string|array|bool $match Text (or array of texts) which triggered one or more filters
4040 public function spamPageWithContent( $match = false ) {
4041 global $wgOut, $wgLang;
4042 $this->textbox2
= $this->textbox1
;
4044 if ( is_array( $match ) ) {
4045 $match = $wgLang->listToText( $match );
4047 $wgOut->prepareErrorPage( wfMessage( 'spamprotectiontitle' ) );
4049 $wgOut->addHTML( '<div id="spamprotected">' );
4050 $wgOut->addWikiMsg( 'spamprotectiontext' );
4052 $wgOut->addWikiMsg( 'spamprotectionmatch', wfEscapeWikiText( $match ) );
4054 $wgOut->addHTML( '</div>' );
4056 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
4059 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
4060 $this->showTextbox2();
4062 $wgOut->addReturnTo( $this->getContextTitle(), [ 'action' => 'edit' ] );
4066 * Check if the browser is on a blacklist of user-agents known to
4067 * mangle UTF-8 data on form submission. Returns true if Unicode
4068 * should make it through, false if it's known to be a problem.
4071 private function checkUnicodeCompliantBrowser() {
4072 global $wgBrowserBlackList, $wgRequest;
4074 $currentbrowser = $wgRequest->getHeader( 'User-Agent' );
4075 if ( $currentbrowser === false ) {
4076 // No User-Agent header sent? Trust it by default...
4080 foreach ( $wgBrowserBlackList as $browser ) {
4081 if ( preg_match( $browser, $currentbrowser ) ) {
4089 * Filter an input field through a Unicode de-armoring process if it
4090 * came from an old browser with known broken Unicode editing issues.
4092 * @param WebRequest $request
4093 * @param string $field
4096 protected function safeUnicodeInput( $request, $field ) {
4097 $text = rtrim( $request->getText( $field ) );
4098 return $request->getBool( 'safemode' )
4099 ?
$this->unmakeSafe( $text )
4104 * Filter an output field through a Unicode armoring process if it is
4105 * going to an old browser with known broken Unicode editing issues.
4107 * @param string $text
4110 protected function safeUnicodeOutput( $text ) {
4112 $codedText = $wgContLang->recodeForEdit( $text );
4113 return $this->checkUnicodeCompliantBrowser()
4115 : $this->makeSafe( $codedText );
4119 * A number of web browsers are known to corrupt non-ASCII characters
4120 * in a UTF-8 text editing environment. To protect against this,
4121 * detected browsers will be served an armored version of the text,
4122 * with non-ASCII chars converted to numeric HTML character references.
4124 * Preexisting such character references will have a 0 added to them
4125 * to ensure that round-trips do not alter the original data.
4127 * @param string $invalue
4130 private function makeSafe( $invalue ) {
4131 // Armor existing references for reversibility.
4132 $invalue = strtr( $invalue, [ "&#x" => "�" ] );
4137 $valueLength = strlen( $invalue );
4138 for ( $i = 0; $i < $valueLength; $i++
) {
4139 $bytevalue = ord( $invalue[$i] );
4140 if ( $bytevalue <= 0x7F ) { // 0xxx xxxx
4141 $result .= chr( $bytevalue );
4143 } elseif ( $bytevalue <= 0xBF ) { // 10xx xxxx
4144 $working = $working << 6;
4145 $working +
= ( $bytevalue & 0x3F );
4147 if ( $bytesleft <= 0 ) {
4148 $result .= "&#x" . strtoupper( dechex( $working ) ) . ";";
4150 } elseif ( $bytevalue <= 0xDF ) { // 110x xxxx
4151 $working = $bytevalue & 0x1F;
4153 } elseif ( $bytevalue <= 0xEF ) { // 1110 xxxx
4154 $working = $bytevalue & 0x0F;
4156 } else { // 1111 0xxx
4157 $working = $bytevalue & 0x07;
4165 * Reverse the previously applied transliteration of non-ASCII characters
4166 * back to UTF-8. Used to protect data from corruption by broken web browsers
4167 * as listed in $wgBrowserBlackList.
4169 * @param string $invalue
4172 private function unmakeSafe( $invalue ) {
4174 $valueLength = strlen( $invalue );
4175 for ( $i = 0; $i < $valueLength; $i++
) {
4176 if ( ( substr( $invalue, $i, 3 ) == "&#x" ) && ( $invalue[$i +
3] != '0' ) ) {
4180 $hexstring .= $invalue[$i];
4182 } while ( ctype_xdigit( $invalue[$i] ) && ( $i < strlen( $invalue ) ) );
4184 // Do some sanity checks. These aren't needed for reversibility,
4185 // but should help keep the breakage down if the editor
4186 // breaks one of the entities whilst editing.
4187 if ( ( substr( $invalue, $i, 1 ) == ";" ) && ( strlen( $hexstring ) <= 6 ) ) {
4188 $codepoint = hexdec( $hexstring );
4189 $result .= UtfNormal\Utils
::codepointToUtf8( $codepoint );
4191 $result .= "&#x" . $hexstring . substr( $invalue, $i, 1 );
4194 $result .= substr( $invalue, $i, 1 );
4197 // reverse the transform that we made for reversibility reasons.
4198 return strtr( $result, [ "�" => "&#x" ] );