3 * User interface for page editing.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 use MediaWiki\Logger\LoggerFactory
;
26 * The edit page/HTML interface (split from Article)
27 * The actual database and text munging is still in Article,
28 * but it should get easier to call those from alternate
31 * EditPage cares about two distinct titles:
32 * $this->mContextTitle is the page that forms submit to, links point to,
33 * redirects go to, etc. $this->mTitle (as well as $mArticle) is the
34 * page in the database that is actually being edited. These are
35 * usually the same, but they are now allowed to be different.
37 * Surgeon General's Warning: prolonged exposure to this class is known to cause
38 * headaches, which may be fatal.
42 * Status: Article successfully updated
44 const AS_SUCCESS_UPDATE
= 200;
47 * Status: Article successfully created
49 const AS_SUCCESS_NEW_ARTICLE
= 201;
52 * Status: Article update aborted by a hook function
54 const AS_HOOK_ERROR
= 210;
57 * Status: A hook function returned an error
59 const AS_HOOK_ERROR_EXPECTED
= 212;
62 * Status: User is blocked from editing this page
64 const AS_BLOCKED_PAGE_FOR_USER
= 215;
67 * Status: Content too big (> $wgMaxArticleSize)
69 const AS_CONTENT_TOO_BIG
= 216;
72 * Status: this anonymous user is not allowed to edit this page
74 const AS_READ_ONLY_PAGE_ANON
= 218;
77 * Status: this logged in user is not allowed to edit this page
79 const AS_READ_ONLY_PAGE_LOGGED
= 219;
82 * Status: wiki is in readonly mode (wfReadOnly() == true)
84 const AS_READ_ONLY_PAGE
= 220;
87 * Status: rate limiter for action 'edit' was tripped
89 const AS_RATE_LIMITED
= 221;
92 * Status: article was deleted while editing and param wpRecreate == false or form
95 const AS_ARTICLE_WAS_DELETED
= 222;
98 * Status: user tried to create this page, but is not allowed to do that
99 * ( Title->userCan('create') == false )
101 const AS_NO_CREATE_PERMISSION
= 223;
104 * Status: user tried to create a blank page and wpIgnoreBlankArticle == false
106 const AS_BLANK_ARTICLE
= 224;
109 * Status: (non-resolvable) edit conflict
111 const AS_CONFLICT_DETECTED
= 225;
114 * Status: no edit summary given and the user has forceeditsummary set and the user is not
115 * editing in his own userspace or talkspace and wpIgnoreBlankSummary == false
117 const AS_SUMMARY_NEEDED
= 226;
120 * Status: user tried to create a new section without content
122 const AS_TEXTBOX_EMPTY
= 228;
125 * Status: article is too big (> $wgMaxArticleSize), after merging in the new section
127 const AS_MAX_ARTICLE_SIZE_EXCEEDED
= 229;
130 * Status: WikiPage::doEdit() was unsuccessful
135 * Status: summary contained spam according to one of the regexes in $wgSummarySpamRegex
137 const AS_SPAM_ERROR
= 232;
140 * Status: anonymous user is not allowed to upload (User::isAllowed('upload') == false)
142 const AS_IMAGE_REDIRECT_ANON
= 233;
145 * Status: logged in user is not allowed to upload (User::isAllowed('upload') == false)
147 const AS_IMAGE_REDIRECT_LOGGED
= 234;
150 * Status: user tried to modify the content model, but is not allowed to do that
151 * ( User::isAllowed('editcontentmodel') == false )
153 const AS_NO_CHANGE_CONTENT_MODEL
= 235;
156 * Status: user tried to create self-redirect (redirect to the same article) and
157 * wpIgnoreSelfRedirect == false
159 const AS_SELF_REDIRECT
= 236;
162 * Status: an error relating to change tagging. Look at the message key for
165 const AS_CHANGE_TAG_ERROR
= 237;
168 * Status: can't parse content
170 const AS_PARSE_ERROR
= 240;
173 * Status: when changing the content model is disallowed due to
174 * $wgContentHandlerUseDB being false
176 const AS_CANNOT_USE_CUSTOM_MODEL
= 241;
179 * HTML id and name for the beginning of the edit form.
181 const EDITFORM_ID
= 'editform';
184 * Prefix of key for cookie used to pass post-edit state.
185 * The revision id edited is added after this
187 const POST_EDIT_COOKIE_KEY_PREFIX
= 'PostEditRevision';
190 * Duration of PostEdit cookie, in seconds.
191 * The cookie will be removed instantly if the JavaScript runs.
193 * Otherwise, though, we don't want the cookies to accumulate.
194 * RFC 2109 ( https://www.ietf.org/rfc/rfc2109.txt ) specifies a possible
195 * limit of only 20 cookies per domain. This still applies at least to some
196 * versions of IE without full updates:
197 * https://blogs.msdn.com/b/ieinternals/archive/2009/08/20/wininet-ie-cookie-internals-faq.aspx
199 * A value of 20 minutes should be enough to take into account slow loads and minor
200 * clock skew while still avoiding cookie accumulation when JavaScript is turned off.
202 const POST_EDIT_COOKIE_DURATION
= 1200;
212 /** @var null|Title */
213 private $mContextTitle = null;
216 public $action = 'submit';
219 public $isConflict = false;
222 public $isCssJsSubpage = false;
225 public $isCssSubpage = false;
228 public $isJsSubpage = false;
231 public $isWrongCaseCssJsPage = false;
233 /** @var bool New page or new section */
234 public $isNew = false;
237 public $deletedSinceEdit;
245 /** @var bool|stdClass */
249 public $mTokenOk = false;
252 public $mTokenOkExceptSuffix = false;
255 public $mTriedSave = false;
258 public $incompleteForm = false;
261 public $tooBig = false;
264 public $missingComment = false;
267 public $missingSummary = false;
270 public $allowBlankSummary = false;
273 protected $blankArticle = false;
276 protected $allowBlankArticle = false;
279 protected $selfRedirect = false;
282 protected $allowSelfRedirect = false;
285 public $autoSumm = '';
288 public $hookError = '';
290 /** @var ParserOutput */
291 public $mParserOutput;
293 /** @var bool Has a summary been preset using GET parameter &summary= ? */
294 public $hasPresetSummary = false;
297 public $mBaseRevision = false;
300 public $mShowSummaryField = true;
305 public $save = false;
308 public $preview = false;
311 public $diff = false;
314 public $minoredit = false;
317 public $watchthis = false;
320 public $recreate = false;
323 public $textbox1 = '';
326 public $textbox2 = '';
329 public $summary = '';
332 public $nosummary = false;
335 public $edittime = '';
338 private $editRevId = null;
341 public $section = '';
344 public $sectiontitle = '';
347 public $starttime = '';
353 public $parentRevId = 0;
356 public $editintro = '';
359 public $scrolltop = null;
364 /** @var null|string */
365 public $contentModel = null;
367 /** @var null|string */
368 public $contentFormat = null;
370 /** @var null|array */
371 private $changeTags = null;
373 # Placeholders for text injection by hooks (must be HTML)
374 # extensions should take care to _append_ to the present value
376 /** @var string Before even the preview */
377 public $editFormPageTop = '';
378 public $editFormTextTop = '';
379 public $editFormTextBeforeContent = '';
380 public $editFormTextAfterWarn = '';
381 public $editFormTextAfterTools = '';
382 public $editFormTextBottom = '';
383 public $editFormTextAfterContent = '';
384 public $previewTextAfterContent = '';
385 public $mPreloadContent = null;
387 /* $didSave should be set to true whenever an article was successfully altered. */
388 public $didSave = false;
389 public $undidRev = 0;
391 public $suppressIntro = false;
397 protected $contentLength = false;
400 * @var bool Set in ApiEditPage, based on ContentHandler::allowsDirectApiEditing
402 private $enableApiEditOverride = false;
405 * @param Article $article
407 public function __construct( Article
$article ) {
408 $this->mArticle
= $article;
409 $this->page
= $article->getPage(); // model object
410 $this->mTitle
= $article->getTitle();
412 $this->contentModel
= $this->mTitle
->getContentModel();
414 $handler = ContentHandler
::getForModelID( $this->contentModel
);
415 $this->contentFormat
= $handler->getDefaultFormat();
421 public function getArticle() {
422 return $this->mArticle
;
429 public function getTitle() {
430 return $this->mTitle
;
434 * Set the context Title object
436 * @param Title|null $title Title object or null
438 public function setContextTitle( $title ) {
439 $this->mContextTitle
= $title;
443 * Get the context title object.
444 * If not set, $wgTitle will be returned. This behavior might change in
445 * the future to return $this->mTitle instead.
449 public function getContextTitle() {
450 if ( is_null( $this->mContextTitle
) ) {
454 return $this->mContextTitle
;
459 * Returns if the given content model is editable.
461 * @param string $modelId The ID of the content model to test. Use CONTENT_MODEL_XXX constants.
463 * @throws MWException If $modelId has no known handler
465 public function isSupportedContentModel( $modelId ) {
466 return $this->enableApiEditOverride
=== true ||
467 ContentHandler
::getForModelID( $modelId )->supportsDirectEditing();
471 * Allow editing of content that supports API direct editing, but not general
472 * direct editing. Set to false by default.
474 * @param bool $enableOverride
476 public function setApiEditOverride( $enableOverride ) {
477 $this->enableApiEditOverride
= $enableOverride;
485 * This is the function that gets called for "action=edit". It
486 * sets up various member variables, then passes execution to
487 * another function, usually showEditForm()
489 * The edit form is self-submitting, so that when things like
490 * preview and edit conflicts occur, we get the same form back
491 * with the extra stuff added. Only when the final submission
492 * is made and all is well do we actually save and redirect to
493 * the newly-edited page.
496 global $wgOut, $wgRequest, $wgUser;
497 // Allow extensions to modify/prevent this form or submission
498 if ( !Hooks
::run( 'AlternateEdit', [ $this ] ) ) {
502 wfDebug( __METHOD__
. ": enter\n" );
504 // If they used redlink=1 and the page exists, redirect to the main article
505 if ( $wgRequest->getBool( 'redlink' ) && $this->mTitle
->exists() ) {
506 $wgOut->redirect( $this->mTitle
->getFullURL() );
510 $this->importFormData( $wgRequest );
511 $this->firsttime
= false;
513 if ( wfReadOnly() && $this->save
) {
516 $this->preview
= true;
520 $this->formtype
= 'save';
521 } elseif ( $this->preview
) {
522 $this->formtype
= 'preview';
523 } elseif ( $this->diff
) {
524 $this->formtype
= 'diff';
525 } else { # First time through
526 $this->firsttime
= true;
527 if ( $this->previewOnOpen() ) {
528 $this->formtype
= 'preview';
530 $this->formtype
= 'initial';
534 $permErrors = $this->getEditPermissionErrors( $this->save ?
'secure' : 'full' );
536 wfDebug( __METHOD__
. ": User can't edit\n" );
537 // Auto-block user's IP if the account was "hard" blocked
538 if ( !wfReadOnly() ) {
540 DeferredUpdates
::addCallableUpdate( function () use ( $user ) {
541 $user->spreadAnyEditBlock();
544 $this->displayPermissionsError( $permErrors );
549 $revision = $this->mArticle
->getRevisionFetched();
550 // Disallow editing revisions with content models different from the current one
551 if ( $revision && $revision->getContentModel() !== $this->contentModel
) {
552 $this->displayViewSourcePage(
553 $this->getContentObject(),
555 'contentmodelediterror',
556 $revision->getContentModel(),
563 $this->isConflict
= false;
564 // css / js subpages of user pages get a special treatment
565 $this->isCssJsSubpage
= $this->mTitle
->isCssJsSubpage();
566 $this->isCssSubpage
= $this->mTitle
->isCssSubpage();
567 $this->isJsSubpage
= $this->mTitle
->isJsSubpage();
568 // @todo FIXME: Silly assignment.
569 $this->isWrongCaseCssJsPage
= $this->isWrongCaseCssJsPage();
571 # Show applicable editing introductions
572 if ( $this->formtype
== 'initial' ||
$this->firsttime
) {
576 # Attempt submission here. This will check for edit conflicts,
577 # and redundantly check for locked database, blocked IPs, etc.
578 # that edit() already checked just in case someone tries to sneak
579 # in the back door with a hand-edited submission URL.
581 if ( 'save' == $this->formtype
) {
582 $resultDetails = null;
583 $status = $this->attemptSave( $resultDetails );
584 if ( !$this->handleStatus( $status, $resultDetails ) ) {
589 # First time through: get contents, set time for conflict
591 if ( 'initial' == $this->formtype ||
$this->firsttime
) {
592 if ( $this->initialiseForm() === false ) {
593 $this->noSuchSectionPage();
597 if ( !$this->mTitle
->getArticleID() ) {
598 Hooks
::run( 'EditFormPreloadText', [ &$this->textbox1
, &$this->mTitle
] );
600 Hooks
::run( 'EditFormInitialText', [ $this ] );
605 $this->showEditForm();
609 * @param string $rigor Same format as Title::getUserPermissionErrors()
612 protected function getEditPermissionErrors( $rigor = 'secure' ) {
615 $permErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $wgUser, $rigor );
616 # Can this title be created?
617 if ( !$this->mTitle
->exists() ) {
618 $permErrors = array_merge(
621 $this->mTitle
->getUserPermissionsErrors( 'create', $wgUser, $rigor ),
626 # Ignore some permissions errors when a user is just previewing/viewing diffs
628 foreach ( $permErrors as $error ) {
629 if ( ( $this->preview ||
$this->diff
)
630 && ( $error[0] == 'blockedtext' ||
$error[0] == 'autoblockedtext' )
635 $permErrors = wfArrayDiff2( $permErrors, $remove );
641 * Display a permissions error page, like OutputPage::showPermissionsErrorPage(),
642 * but with the following differences:
643 * - If redlink=1, the user will be redirected to the page
644 * - If there is content to display or the error occurs while either saving,
645 * previewing or showing the difference, it will be a
646 * "View source for ..." page displaying the source code after the error message.
649 * @param array $permErrors Array of permissions errors, as returned by
650 * Title::getUserPermissionsErrors().
651 * @throws PermissionsError
653 protected function displayPermissionsError( array $permErrors ) {
654 global $wgRequest, $wgOut;
656 if ( $wgRequest->getBool( 'redlink' ) ) {
657 // The edit page was reached via a red link.
658 // Redirect to the article page and let them click the edit tab if
659 // they really want a permission error.
660 $wgOut->redirect( $this->mTitle
->getFullURL() );
664 $content = $this->getContentObject();
666 # Use the normal message if there's nothing to display
667 if ( $this->firsttime
&& ( !$content ||
$content->isEmpty() ) ) {
668 $action = $this->mTitle
->exists() ?
'edit' :
669 ( $this->mTitle
->isTalkPage() ?
'createtalk' : 'createpage' );
670 throw new PermissionsError( $action, $permErrors );
673 $this->displayViewSourcePage(
675 $wgOut->formatPermissionsErrorMessage( $permErrors, 'edit' )
680 * Display a read-only View Source page
681 * @param Content $content content object
682 * @param string $errorMessage additional wikitext error message to display
684 protected function displayViewSourcePage( Content
$content, $errorMessage = '' ) {
687 Hooks
::run( 'EditPage::showReadOnlyForm:initial', [ $this, &$wgOut ] );
689 $wgOut->setRobotPolicy( 'noindex,nofollow' );
690 $wgOut->setPageTitle( wfMessage(
692 $this->getContextTitle()->getPrefixedText()
694 $wgOut->addBacklinkSubtitle( $this->getContextTitle() );
695 $wgOut->addHTML( $this->editFormPageTop
);
696 $wgOut->addHTML( $this->editFormTextTop
);
698 if ( $errorMessage !== '' ) {
699 $wgOut->addWikiText( $errorMessage );
700 $wgOut->addHTML( "<hr />\n" );
703 # If the user made changes, preserve them when showing the markup
704 # (This happens when a user is blocked during edit, for instance)
705 if ( !$this->firsttime
) {
706 $text = $this->textbox1
;
707 $wgOut->addWikiMsg( 'viewyourtext' );
710 $text = $this->toEditText( $content );
711 } catch ( MWException
$e ) {
712 # Serialize using the default format if the content model is not supported
713 # (e.g. for an old revision with a different model)
714 $text = $content->serialize();
716 $wgOut->addWikiMsg( 'viewsourcetext' );
719 $wgOut->addHTML( $this->editFormTextBeforeContent
);
720 $this->showTextbox( $text, 'wpTextbox1', [ 'readonly' ] );
721 $wgOut->addHTML( $this->editFormTextAfterContent
);
723 $wgOut->addHTML( Html
::rawElement( 'div', [ 'class' => 'templatesUsed' ],
724 Linker
::formatTemplates( $this->getTemplates() ) ) );
726 $wgOut->addModules( 'mediawiki.action.edit.collapsibleFooter' );
728 $wgOut->addHTML( $this->editFormTextBottom
);
729 if ( $this->mTitle
->exists() ) {
730 $wgOut->returnToMain( null, $this->mTitle
);
735 * Should we show a preview when the edit form is first shown?
739 protected function previewOnOpen() {
740 global $wgRequest, $wgUser, $wgPreviewOnOpenNamespaces;
741 if ( $wgRequest->getVal( 'preview' ) == 'yes' ) {
742 // Explicit override from request
744 } elseif ( $wgRequest->getVal( 'preview' ) == 'no' ) {
745 // Explicit override from request
747 } elseif ( $this->section
== 'new' ) {
748 // Nothing *to* preview for new sections
750 } elseif ( ( $wgRequest->getVal( 'preload' ) !== null ||
$this->mTitle
->exists() )
751 && $wgUser->getOption( 'previewonfirst' )
753 // Standard preference behavior
755 } elseif ( !$this->mTitle
->exists()
756 && isset( $wgPreviewOnOpenNamespaces[$this->mTitle
->getNamespace()] )
757 && $wgPreviewOnOpenNamespaces[$this->mTitle
->getNamespace()]
759 // Categories are special
767 * Checks whether the user entered a skin name in uppercase,
768 * e.g. "User:Example/Monobook.css" instead of "monobook.css"
772 protected function isWrongCaseCssJsPage() {
773 if ( $this->mTitle
->isCssJsSubpage() ) {
774 $name = $this->mTitle
->getSkinFromCssJsSubpage();
775 $skins = array_merge(
776 array_keys( Skin
::getSkinNames() ),
779 return !in_array( $name, $skins )
780 && in_array( strtolower( $name ), $skins );
787 * Returns whether section editing is supported for the current page.
788 * Subclasses may override this to replace the default behavior, which is
789 * to check ContentHandler::supportsSections.
791 * @return bool True if this edit page supports sections, false otherwise.
793 protected function isSectionEditSupported() {
794 $contentHandler = ContentHandler
::getForTitle( $this->mTitle
);
795 return $contentHandler->supportsSections();
799 * This function collects the form data and uses it to populate various member variables.
800 * @param WebRequest $request
801 * @throws ErrorPageError
803 function importFormData( &$request ) {
804 global $wgContLang, $wgUser;
806 # Section edit can come from either the form or a link
807 $this->section
= $request->getVal( 'wpSection', $request->getVal( 'section' ) );
809 if ( $this->section
!== null && $this->section
!== '' && !$this->isSectionEditSupported() ) {
810 throw new ErrorPageError( 'sectioneditnotsupported-title', 'sectioneditnotsupported-text' );
813 $this->isNew
= !$this->mTitle
->exists() ||
$this->section
== 'new';
815 if ( $request->wasPosted() ) {
816 # These fields need to be checked for encoding.
817 # Also remove trailing whitespace, but don't remove _initial_
818 # whitespace from the text boxes. This may be significant formatting.
819 $this->textbox1
= $this->safeUnicodeInput( $request, 'wpTextbox1' );
820 if ( !$request->getCheck( 'wpTextbox2' ) ) {
821 // Skip this if wpTextbox2 has input, it indicates that we came
822 // from a conflict page with raw page text, not a custom form
823 // modified by subclasses
824 $textbox1 = $this->importContentFormData( $request );
825 if ( $textbox1 !== null ) {
826 $this->textbox1
= $textbox1;
830 # Truncate for whole multibyte characters
831 $this->summary
= $wgContLang->truncate( $request->getText( 'wpSummary' ), 255 );
833 # If the summary consists of a heading, e.g. '==Foobar==', extract the title from the
834 # header syntax, e.g. 'Foobar'. This is mainly an issue when we are using wpSummary for
836 $this->summary
= preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->summary
);
838 # Treat sectiontitle the same way as summary.
839 # Note that wpSectionTitle is not yet a part of the actual edit form, as wpSummary is
840 # currently doing double duty as both edit summary and section title. Right now this
841 # is just to allow API edits to work around this limitation, but this should be
842 # incorporated into the actual edit form when EditPage is rewritten (Bugs 18654, 26312).
843 $this->sectiontitle
= $wgContLang->truncate( $request->getText( 'wpSectionTitle' ), 255 );
844 $this->sectiontitle
= preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->sectiontitle
);
846 $this->edittime
= $request->getVal( 'wpEdittime' );
847 $this->editRevId
= $request->getIntOrNull( 'editRevId' );
848 $this->starttime
= $request->getVal( 'wpStarttime' );
850 $undidRev = $request->getInt( 'wpUndidRevision' );
852 $this->undidRev
= $undidRev;
855 $this->scrolltop
= $request->getIntOrNull( 'wpScrolltop' );
857 if ( $this->textbox1
=== '' && $request->getVal( 'wpTextbox1' ) === null ) {
858 // wpTextbox1 field is missing, possibly due to being "too big"
859 // according to some filter rules such as Suhosin's setting for
860 // suhosin.request.max_value_length (d'oh)
861 $this->incompleteForm
= true;
863 // If we receive the last parameter of the request, we can fairly
864 // claim the POST request has not been truncated.
866 // TODO: softened the check for cutover. Once we determine
867 // that it is safe, we should complete the transition by
868 // removing the "edittime" clause.
869 $this->incompleteForm
= ( !$request->getVal( 'wpUltimateParam' )
870 && is_null( $this->edittime
) );
872 if ( $this->incompleteForm
) {
873 # If the form is incomplete, force to preview.
874 wfDebug( __METHOD__
. ": Form data appears to be incomplete\n" );
875 wfDebug( "POST DATA: " . var_export( $_POST, true ) . "\n" );
876 $this->preview
= true;
878 $this->preview
= $request->getCheck( 'wpPreview' );
879 $this->diff
= $request->getCheck( 'wpDiff' );
881 // Remember whether a save was requested, so we can indicate
882 // if we forced preview due to session failure.
883 $this->mTriedSave
= !$this->preview
;
885 if ( $this->tokenOk( $request ) ) {
886 # Some browsers will not report any submit button
887 # if the user hits enter in the comment box.
888 # The unmarked state will be assumed to be a save,
889 # if the form seems otherwise complete.
890 wfDebug( __METHOD__
. ": Passed token check.\n" );
891 } elseif ( $this->diff
) {
892 # Failed token check, but only requested "Show Changes".
893 wfDebug( __METHOD__
. ": Failed token check; Show Changes requested.\n" );
895 # Page might be a hack attempt posted from
896 # an external site. Preview instead of saving.
897 wfDebug( __METHOD__
. ": Failed token check; forcing preview\n" );
898 $this->preview
= true;
901 $this->save
= !$this->preview
&& !$this->diff
;
902 if ( !preg_match( '/^\d{14}$/', $this->edittime
) ) {
903 $this->edittime
= null;
906 if ( !preg_match( '/^\d{14}$/', $this->starttime
) ) {
907 $this->starttime
= null;
910 $this->recreate
= $request->getCheck( 'wpRecreate' );
912 $this->minoredit
= $request->getCheck( 'wpMinoredit' );
913 $this->watchthis
= $request->getCheck( 'wpWatchthis' );
915 # Don't force edit summaries when a user is editing their own user or talk page
916 if ( ( $this->mTitle
->mNamespace
== NS_USER ||
$this->mTitle
->mNamespace
== NS_USER_TALK
)
917 && $this->mTitle
->getText() == $wgUser->getName()
919 $this->allowBlankSummary
= true;
921 $this->allowBlankSummary
= $request->getBool( 'wpIgnoreBlankSummary' )
922 ||
!$wgUser->getOption( 'forceeditsummary' );
925 $this->autoSumm
= $request->getText( 'wpAutoSummary' );
927 $this->allowBlankArticle
= $request->getBool( 'wpIgnoreBlankArticle' );
928 $this->allowSelfRedirect
= $request->getBool( 'wpIgnoreSelfRedirect' );
930 $changeTags = $request->getVal( 'wpChangeTags' );
931 if ( is_null( $changeTags ) ||
$changeTags === '' ) {
932 $this->changeTags
= [];
934 $this->changeTags
= array_filter( array_map( 'trim', explode( ',',
938 # Not a posted form? Start with nothing.
939 wfDebug( __METHOD__
. ": Not a posted form.\n" );
940 $this->textbox1
= '';
942 $this->sectiontitle
= '';
943 $this->edittime
= '';
944 $this->editRevId
= null;
945 $this->starttime
= wfTimestampNow();
947 $this->preview
= false;
950 $this->minoredit
= false;
951 // Watch may be overridden by request parameters
952 $this->watchthis
= $request->getBool( 'watchthis', false );
953 $this->recreate
= false;
955 // When creating a new section, we can preload a section title by passing it as the
956 // preloadtitle parameter in the URL (Bug 13100)
957 if ( $this->section
== 'new' && $request->getVal( 'preloadtitle' ) ) {
958 $this->sectiontitle
= $request->getVal( 'preloadtitle' );
959 // Once wpSummary isn't being use for setting section titles, we should delete this.
960 $this->summary
= $request->getVal( 'preloadtitle' );
961 } elseif ( $this->section
!= 'new' && $request->getVal( 'summary' ) ) {
962 $this->summary
= $request->getText( 'summary' );
963 if ( $this->summary
!== '' ) {
964 $this->hasPresetSummary
= true;
968 if ( $request->getVal( 'minor' ) ) {
969 $this->minoredit
= true;
973 $this->oldid
= $request->getInt( 'oldid' );
974 $this->parentRevId
= $request->getInt( 'parentRevId' );
976 $this->bot
= $request->getBool( 'bot', true );
977 $this->nosummary
= $request->getBool( 'nosummary' );
979 // May be overridden by revision.
980 $this->contentModel
= $request->getText( 'model', $this->contentModel
);
981 // May be overridden by revision.
982 $this->contentFormat
= $request->getText( 'format', $this->contentFormat
);
984 if ( !ContentHandler
::getForModelID( $this->contentModel
)
985 ->isSupportedFormat( $this->contentFormat
)
987 throw new ErrorPageError(
988 'editpage-notsupportedcontentformat-title',
989 'editpage-notsupportedcontentformat-text',
990 [ $this->contentFormat
, ContentHandler
::getLocalizedName( $this->contentModel
) ]
995 * @todo Check if the desired model is allowed in this namespace, and if
996 * a transition from the page's current model to the new model is
1000 $this->editintro
= $request->getText( 'editintro',
1001 // Custom edit intro for new sections
1002 $this->section
=== 'new' ?
'MediaWiki:addsection-editintro' : '' );
1004 // Allow extensions to modify form data
1005 Hooks
::run( 'EditPage::importFormData', [ $this, $request ] );
1010 * Subpage overridable method for extracting the page content data from the
1011 * posted form to be placed in $this->textbox1, if using customized input
1012 * this method should be overridden and return the page text that will be used
1013 * for saving, preview parsing and so on...
1015 * @param WebRequest $request
1016 * @return string|null
1018 protected function importContentFormData( &$request ) {
1019 return; // Don't do anything, EditPage already extracted wpTextbox1
1023 * Initialise form fields in the object
1024 * Called on the first invocation, e.g. when a user clicks an edit link
1025 * @return bool If the requested section is valid
1027 function initialiseForm() {
1029 $this->edittime
= $this->page
->getTimestamp();
1030 $this->editRevId
= $this->page
->getLatest();
1032 $content = $this->getContentObject( false ); # TODO: track content object?!
1033 if ( $content === false ) {
1036 $this->textbox1
= $this->toEditText( $content );
1038 // activate checkboxes if user wants them to be always active
1039 # Sort out the "watch" checkbox
1040 if ( $wgUser->getOption( 'watchdefault' ) ) {
1042 $this->watchthis
= true;
1043 } elseif ( $wgUser->getOption( 'watchcreations' ) && !$this->mTitle
->exists() ) {
1045 $this->watchthis
= true;
1046 } elseif ( $wgUser->isWatched( $this->mTitle
) ) {
1048 $this->watchthis
= true;
1050 if ( $wgUser->getOption( 'minordefault' ) && !$this->isNew
) {
1051 $this->minoredit
= true;
1053 if ( $this->textbox1
=== false ) {
1060 * @param Content|null $def_content The default value to return
1062 * @return Content|null Content on success, $def_content for invalid sections
1066 protected function getContentObject( $def_content = null ) {
1067 global $wgOut, $wgRequest, $wgUser, $wgContLang;
1071 // For message page not locally set, use the i18n message.
1072 // For other non-existent articles, use preload text if any.
1073 if ( !$this->mTitle
->exists() ||
$this->section
== 'new' ) {
1074 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
&& $this->section
!= 'new' ) {
1075 # If this is a system message, get the default text.
1076 $msg = $this->mTitle
->getDefaultMessageText();
1078 $content = $this->toEditContent( $msg );
1080 if ( $content === false ) {
1081 # If requested, preload some text.
1082 $preload = $wgRequest->getVal( 'preload',
1083 // Custom preload text for new sections
1084 $this->section
=== 'new' ?
'MediaWiki:addsection-preload' : '' );
1085 $params = $wgRequest->getArray( 'preloadparams', [] );
1087 $content = $this->getPreloadedContent( $preload, $params );
1089 // For existing pages, get text based on "undo" or section parameters.
1091 if ( $this->section
!= '' ) {
1092 // Get section edit text (returns $def_text for invalid sections)
1093 $orig = $this->getOriginalContent( $wgUser );
1094 $content = $orig ?
$orig->getSection( $this->section
) : null;
1097 $content = $def_content;
1100 $undoafter = $wgRequest->getInt( 'undoafter' );
1101 $undo = $wgRequest->getInt( 'undo' );
1103 if ( $undo > 0 && $undoafter > 0 ) {
1104 $undorev = Revision
::newFromId( $undo );
1105 $oldrev = Revision
::newFromId( $undoafter );
1107 # Sanity check, make sure it's the right page,
1108 # the revisions exist and they were not deleted.
1109 # Otherwise, $content will be left as-is.
1110 if ( !is_null( $undorev ) && !is_null( $oldrev ) &&
1111 !$undorev->isDeleted( Revision
::DELETED_TEXT
) &&
1112 !$oldrev->isDeleted( Revision
::DELETED_TEXT
)
1114 $content = $this->page
->getUndoContent( $undorev, $oldrev );
1116 if ( $content === false ) {
1117 # Warn the user that something went wrong
1118 $undoMsg = 'failure';
1120 $oldContent = $this->page
->getContent( Revision
::RAW
);
1121 $popts = ParserOptions
::newFromUserAndLang( $wgUser, $wgContLang );
1122 $newContent = $content->preSaveTransform( $this->mTitle
, $wgUser, $popts );
1124 if ( $newContent->equals( $oldContent ) ) {
1125 # Tell the user that the undo results in no change,
1126 # i.e. the revisions were already undone.
1127 $undoMsg = 'nochange';
1130 # Inform the user of our success and set an automatic edit summary
1131 $undoMsg = 'success';
1133 # If we just undid one rev, use an autosummary
1134 $firstrev = $oldrev->getNext();
1135 if ( $firstrev && $firstrev->getId() == $undo ) {
1136 $userText = $undorev->getUserText();
1137 if ( $userText === '' ) {
1138 $undoSummary = wfMessage(
1139 'undo-summary-username-hidden',
1141 )->inContentLanguage()->text();
1143 $undoSummary = wfMessage(
1147 )->inContentLanguage()->text();
1149 if ( $this->summary
=== '' ) {
1150 $this->summary
= $undoSummary;
1152 $this->summary
= $undoSummary . wfMessage( 'colon-separator' )
1153 ->inContentLanguage()->text() . $this->summary
;
1155 $this->undidRev
= $undo;
1157 $this->formtype
= 'diff';
1161 // Failed basic sanity checks.
1162 // Older revisions may have been removed since the link
1163 // was created, or we may simply have got bogus input.
1167 // Messages: undo-success, undo-failure, undo-norev, undo-nochange
1168 $class = ( $undoMsg == 'success' ?
'' : 'error ' ) . "mw-undo-{$undoMsg}";
1169 $this->editFormPageTop
.= $wgOut->parse( "<div class=\"{$class}\">" .
1170 wfMessage( 'undo-' . $undoMsg )->plain() . '</div>', true, /* interface */true );
1173 if ( $content === false ) {
1174 $content = $this->getOriginalContent( $wgUser );
1183 * Get the content of the wanted revision, without section extraction.
1185 * The result of this function can be used to compare user's input with
1186 * section replaced in its context (using WikiPage::replaceSectionAtRev())
1187 * to the original text of the edit.
1189 * This differs from Article::getContent() that when a missing revision is
1190 * encountered the result will be null and not the
1191 * 'missing-revision' message.
1194 * @param User $user The user to get the revision for
1195 * @return Content|null
1197 private function getOriginalContent( User
$user ) {
1198 if ( $this->section
== 'new' ) {
1199 return $this->getCurrentContent();
1201 $revision = $this->mArticle
->getRevisionFetched();
1202 if ( $revision === null ) {
1203 if ( !$this->contentModel
) {
1204 $this->contentModel
= $this->getTitle()->getContentModel();
1206 $handler = ContentHandler
::getForModelID( $this->contentModel
);
1208 return $handler->makeEmptyContent();
1210 $content = $revision->getContent( Revision
::FOR_THIS_USER
, $user );
1215 * Get the edit's parent revision ID
1217 * The "parent" revision is the ancestor that should be recorded in this
1218 * page's revision history. It is either the revision ID of the in-memory
1219 * article content, or in the case of a 3-way merge in order to rebase
1220 * across a recoverable edit conflict, the ID of the newer revision to
1221 * which we have rebased this page.
1224 * @return int Revision ID
1226 public function getParentRevId() {
1227 if ( $this->parentRevId
) {
1228 return $this->parentRevId
;
1230 return $this->mArticle
->getRevIdFetched();
1235 * Get the current content of the page. This is basically similar to
1236 * WikiPage::getContent( Revision::RAW ) except that when the page doesn't exist an empty
1237 * content object is returned instead of null.
1242 protected function getCurrentContent() {
1243 $rev = $this->page
->getRevision();
1244 $content = $rev ?
$rev->getContent( Revision
::RAW
) : null;
1246 if ( $content === false ||
$content === null ) {
1247 if ( !$this->contentModel
) {
1248 $this->contentModel
= $this->getTitle()->getContentModel();
1250 $handler = ContentHandler
::getForModelID( $this->contentModel
);
1252 return $handler->makeEmptyContent();
1254 // Content models should always be the same since we error
1255 // out if they are different before this point.
1256 $logger = LoggerFactory
::getInstance( 'editpage' );
1257 if ( $this->contentModel
!== $rev->getContentModel() ) {
1258 $logger->warning( "Overriding content model from current edit {prev} to {new}", [
1259 'prev' => $this->contentModel
,
1260 'new' => $rev->getContentModel(),
1261 'title' => $this->getTitle()->getPrefixedDBkey(),
1262 'method' => __METHOD__
1264 $this->contentModel
= $rev->getContentModel();
1267 // Given that the content models should match, the current selected
1268 // format should be supported.
1269 if ( !$content->isSupportedFormat( $this->contentFormat
) ) {
1270 $logger->warning( "Current revision content format unsupported. Overriding {prev} to {new}", [
1272 'prev' => $this->contentFormat
,
1273 'new' => $rev->getContentFormat(),
1274 'title' => $this->getTitle()->getPrefixedDBkey(),
1275 'method' => __METHOD__
1277 $this->contentFormat
= $rev->getContentFormat();
1285 * Use this method before edit() to preload some content into the edit box
1287 * @param Content $content
1291 public function setPreloadedContent( Content
$content ) {
1292 $this->mPreloadContent
= $content;
1296 * Get the contents to be preloaded into the box, either set by
1297 * an earlier setPreloadText() or by loading the given page.
1299 * @param string $preload Representing the title to preload from.
1300 * @param array $params Parameters to use (interface-message style) in the preloaded text
1306 protected function getPreloadedContent( $preload, $params = [] ) {
1309 if ( !empty( $this->mPreloadContent
) ) {
1310 return $this->mPreloadContent
;
1313 $handler = ContentHandler
::getForModelID( $this->contentModel
);
1315 if ( $preload === '' ) {
1316 return $handler->makeEmptyContent();
1319 $title = Title
::newFromText( $preload );
1320 # Check for existence to avoid getting MediaWiki:Noarticletext
1321 if ( $title === null ||
!$title->exists() ||
!$title->userCan( 'read', $wgUser ) ) {
1322 // TODO: somehow show a warning to the user!
1323 return $handler->makeEmptyContent();
1326 $page = WikiPage
::factory( $title );
1327 if ( $page->isRedirect() ) {
1328 $title = $page->getRedirectTarget();
1330 if ( $title === null ||
!$title->exists() ||
!$title->userCan( 'read', $wgUser ) ) {
1331 // TODO: somehow show a warning to the user!
1332 return $handler->makeEmptyContent();
1334 $page = WikiPage
::factory( $title );
1337 $parserOptions = ParserOptions
::newFromUser( $wgUser );
1338 $content = $page->getContent( Revision
::RAW
);
1341 // TODO: somehow show a warning to the user!
1342 return $handler->makeEmptyContent();
1345 if ( $content->getModel() !== $handler->getModelID() ) {
1346 $converted = $content->convert( $handler->getModelID() );
1348 if ( !$converted ) {
1349 // TODO: somehow show a warning to the user!
1350 wfDebug( "Attempt to preload incompatible content: " .
1351 "can't convert " . $content->getModel() .
1352 " to " . $handler->getModelID() );
1354 return $handler->makeEmptyContent();
1357 $content = $converted;
1360 return $content->preloadTransform( $title, $parserOptions, $params );
1364 * Make sure the form isn't faking a user's credentials.
1366 * @param WebRequest $request
1370 function tokenOk( &$request ) {
1372 $token = $request->getVal( 'wpEditToken' );
1373 $this->mTokenOk
= $wgUser->matchEditToken( $token );
1374 $this->mTokenOkExceptSuffix
= $wgUser->matchEditTokenNoSuffix( $token );
1375 return $this->mTokenOk
;
1379 * Sets post-edit cookie indicating the user just saved a particular revision.
1381 * This uses a temporary cookie for each revision ID so separate saves will never
1382 * interfere with each other.
1384 * The cookie is deleted in the mediawiki.action.view.postEdit JS module after
1385 * the redirect. It must be clearable by JavaScript code, so it must not be
1386 * marked HttpOnly. The JavaScript code converts the cookie to a wgPostEdit config
1389 * If the variable were set on the server, it would be cached, which is unwanted
1390 * since the post-edit state should only apply to the load right after the save.
1392 * @param int $statusValue The status value (to check for new article status)
1394 protected function setPostEditCookie( $statusValue ) {
1395 $revisionId = $this->page
->getLatest();
1396 $postEditKey = self
::POST_EDIT_COOKIE_KEY_PREFIX
. $revisionId;
1399 if ( $statusValue == self
::AS_SUCCESS_NEW_ARTICLE
) {
1401 } elseif ( $this->oldid
) {
1405 $response = RequestContext
::getMain()->getRequest()->response();
1406 $response->setCookie( $postEditKey, $val, time() + self
::POST_EDIT_COOKIE_DURATION
, [
1407 'httpOnly' => false,
1412 * Attempt submission
1413 * @param array $resultDetails See docs for $result in internalAttemptSave
1414 * @throws UserBlockedError|ReadOnlyError|ThrottledError|PermissionsError
1415 * @return Status The resulting status object.
1417 public function attemptSave( &$resultDetails = false ) {
1420 # Allow bots to exempt some edits from bot flagging
1421 $bot = $wgUser->isAllowed( 'bot' ) && $this->bot
;
1422 $status = $this->internalAttemptSave( $resultDetails, $bot );
1424 Hooks
::run( 'EditPage::attemptSave:after', [ $this, $status, $resultDetails ] );
1430 * Handle status, such as after attempt save
1432 * @param Status $status
1433 * @param array|bool $resultDetails
1435 * @throws ErrorPageError
1436 * @return bool False, if output is done, true if rest of the form should be displayed
1438 private function handleStatus( Status
$status, $resultDetails ) {
1439 global $wgUser, $wgOut;
1442 * @todo FIXME: once the interface for internalAttemptSave() is made
1443 * nicer, this should use the message in $status
1445 if ( $status->value
== self
::AS_SUCCESS_UPDATE
1446 ||
$status->value
== self
::AS_SUCCESS_NEW_ARTICLE
1448 $this->didSave
= true;
1449 if ( !$resultDetails['nullEdit'] ) {
1450 $this->setPostEditCookie( $status->value
);
1454 // "wpExtraQueryRedirect" is a hidden input to modify
1455 // after save URL and is not used by actual edit form
1456 $request = RequestContext
::getMain()->getRequest();
1457 $extraQueryRedirect = $request->getVal( 'wpExtraQueryRedirect' );
1459 switch ( $status->value
) {
1460 case self
::AS_HOOK_ERROR_EXPECTED
:
1461 case self
::AS_CONTENT_TOO_BIG
:
1462 case self
::AS_ARTICLE_WAS_DELETED
:
1463 case self
::AS_CONFLICT_DETECTED
:
1464 case self
::AS_SUMMARY_NEEDED
:
1465 case self
::AS_TEXTBOX_EMPTY
:
1466 case self
::AS_MAX_ARTICLE_SIZE_EXCEEDED
:
1468 case self
::AS_BLANK_ARTICLE
:
1469 case self
::AS_SELF_REDIRECT
:
1472 case self
::AS_HOOK_ERROR
:
1475 case self
::AS_CANNOT_USE_CUSTOM_MODEL
:
1476 case self
::AS_PARSE_ERROR
:
1477 $wgOut->addWikiText( '<div class="error">' . $status->getWikiText() . '</div>' );
1480 case self
::AS_SUCCESS_NEW_ARTICLE
:
1481 $query = $resultDetails['redirect'] ?
'redirect=no' : '';
1482 if ( $extraQueryRedirect ) {
1483 if ( $query === '' ) {
1484 $query = $extraQueryRedirect;
1486 $query = $query . '&' . $extraQueryRedirect;
1489 $anchor = isset( $resultDetails['sectionanchor'] ) ?
$resultDetails['sectionanchor'] : '';
1490 $wgOut->redirect( $this->mTitle
->getFullURL( $query ) . $anchor );
1493 case self
::AS_SUCCESS_UPDATE
:
1495 $sectionanchor = $resultDetails['sectionanchor'];
1497 // Give extensions a chance to modify URL query on update
1499 'ArticleUpdateBeforeRedirect',
1500 [ $this->mArticle
, &$sectionanchor, &$extraQuery ]
1503 if ( $resultDetails['redirect'] ) {
1504 if ( $extraQuery == '' ) {
1505 $extraQuery = 'redirect=no';
1507 $extraQuery = 'redirect=no&' . $extraQuery;
1510 if ( $extraQueryRedirect ) {
1511 if ( $extraQuery === '' ) {
1512 $extraQuery = $extraQueryRedirect;
1514 $extraQuery = $extraQuery . '&' . $extraQueryRedirect;
1518 $wgOut->redirect( $this->mTitle
->getFullURL( $extraQuery ) . $sectionanchor );
1521 case self
::AS_SPAM_ERROR
:
1522 $this->spamPageWithContent( $resultDetails['spam'] );
1525 case self
::AS_BLOCKED_PAGE_FOR_USER
:
1526 throw new UserBlockedError( $wgUser->getBlock() );
1528 case self
::AS_IMAGE_REDIRECT_ANON
:
1529 case self
::AS_IMAGE_REDIRECT_LOGGED
:
1530 throw new PermissionsError( 'upload' );
1532 case self
::AS_READ_ONLY_PAGE_ANON
:
1533 case self
::AS_READ_ONLY_PAGE_LOGGED
:
1534 throw new PermissionsError( 'edit' );
1536 case self
::AS_READ_ONLY_PAGE
:
1537 throw new ReadOnlyError
;
1539 case self
::AS_RATE_LIMITED
:
1540 throw new ThrottledError();
1542 case self
::AS_NO_CREATE_PERMISSION
:
1543 $permission = $this->mTitle
->isTalkPage() ?
'createtalk' : 'createpage';
1544 throw new PermissionsError( $permission );
1546 case self
::AS_NO_CHANGE_CONTENT_MODEL
:
1547 throw new PermissionsError( 'editcontentmodel' );
1550 // We don't recognize $status->value. The only way that can happen
1551 // is if an extension hook aborted from inside ArticleSave.
1552 // Render the status object into $this->hookError
1553 // FIXME this sucks, we should just use the Status object throughout
1554 $this->hookError
= '<div class="error">' . $status->getWikiText() .
1561 * Run hooks that can filter edits just before they get saved.
1563 * @param Content $content The Content to filter.
1564 * @param Status $status For reporting the outcome to the caller
1565 * @param User $user The user performing the edit
1569 protected function runPostMergeFilters( Content
$content, Status
$status, User
$user ) {
1570 // Run old style post-section-merge edit filter
1571 if ( !ContentHandler
::runLegacyHooks( 'EditFilterMerged',
1572 [ $this, $content, &$this->hookError
, $this->summary
] )
1574 # Error messages etc. could be handled within the hook...
1575 $status->fatal( 'hookaborted' );
1576 $status->value
= self
::AS_HOOK_ERROR
;
1578 } elseif ( $this->hookError
!= '' ) {
1579 # ...or the hook could be expecting us to produce an error
1580 $status->fatal( 'hookaborted' );
1581 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1585 // Run new style post-section-merge edit filter
1586 if ( !Hooks
::run( 'EditFilterMergedContent',
1587 [ $this->mArticle
->getContext(), $content, $status, $this->summary
,
1588 $user, $this->minoredit
] )
1590 # Error messages etc. could be handled within the hook...
1591 if ( $status->isGood() ) {
1592 $status->fatal( 'hookaborted' );
1593 // Not setting $this->hookError here is a hack to allow the hook
1594 // to cause a return to the edit page without $this->hookError
1595 // being set. This is used by ConfirmEdit to display a captcha
1596 // without any error message cruft.
1598 $this->hookError
= $status->getWikiText();
1600 // Use the existing $status->value if the hook set it
1601 if ( !$status->value
) {
1602 $status->value
= self
::AS_HOOK_ERROR
;
1605 } elseif ( !$status->isOK() ) {
1606 # ...or the hook could be expecting us to produce an error
1607 // FIXME this sucks, we should just use the Status object throughout
1608 $this->hookError
= $status->getWikiText();
1609 $status->fatal( 'hookaborted' );
1610 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1618 * Return the summary to be used for a new section.
1620 * @param string $sectionanchor Set to the section anchor text
1623 private function newSectionSummary( &$sectionanchor = null ) {
1626 if ( $this->sectiontitle
!== '' ) {
1627 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $this->sectiontitle
);
1628 // If no edit summary was specified, create one automatically from the section
1629 // title and have it link to the new section. Otherwise, respect the summary as
1631 if ( $this->summary
=== '' ) {
1632 $cleanSectionTitle = $wgParser->stripSectionName( $this->sectiontitle
);
1633 return wfMessage( 'newsectionsummary' )
1634 ->rawParams( $cleanSectionTitle )->inContentLanguage()->text();
1636 } elseif ( $this->summary
!== '' ) {
1637 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $this->summary
);
1638 # This is a new section, so create a link to the new section
1639 # in the revision summary.
1640 $cleanSummary = $wgParser->stripSectionName( $this->summary
);
1641 return wfMessage( 'newsectionsummary' )
1642 ->rawParams( $cleanSummary )->inContentLanguage()->text();
1644 return $this->summary
;
1648 * Attempt submission (no UI)
1650 * @param array $result Array to add statuses to, currently with the
1652 * - spam (string): Spam string from content if any spam is detected by
1654 * - sectionanchor (string): Section anchor for a section save.
1655 * - nullEdit (boolean): Set if doEditContent is OK. True if null edit,
1657 * - redirect (bool): Set if doEditContent is OK. True if resulting
1658 * revision is a redirect.
1659 * @param bool $bot True if edit is being made under the bot right.
1661 * @return Status Status object, possibly with a message, but always with
1662 * one of the AS_* constants in $status->value,
1664 * @todo FIXME: This interface is TERRIBLE, but hard to get rid of due to
1665 * various error display idiosyncrasies. There are also lots of cases
1666 * where error metadata is set in the object and retrieved later instead
1667 * of being returned, e.g. AS_CONTENT_TOO_BIG and
1668 * AS_BLOCKED_PAGE_FOR_USER. All that stuff needs to be cleaned up some
1671 function internalAttemptSave( &$result, $bot = false ) {
1672 global $wgUser, $wgRequest, $wgParser, $wgMaxArticleSize;
1673 global $wgContentHandlerUseDB;
1675 $status = Status
::newGood();
1677 if ( !Hooks
::run( 'EditPage::attemptSave', [ $this ] ) ) {
1678 wfDebug( "Hook 'EditPage::attemptSave' aborted article saving\n" );
1679 $status->fatal( 'hookaborted' );
1680 $status->value
= self
::AS_HOOK_ERROR
;
1684 $spam = $wgRequest->getText( 'wpAntispam' );
1685 if ( $spam !== '' ) {
1688 $wgUser->getName() .
1690 $this->mTitle
->getPrefixedText() .
1691 '" submitted bogus field "' .
1695 $status->fatal( 'spamprotectionmatch', false );
1696 $status->value
= self
::AS_SPAM_ERROR
;
1701 # Construct Content object
1702 $textbox_content = $this->toEditContent( $this->textbox1
);
1703 } catch ( MWContentSerializationException
$ex ) {
1705 'content-failed-to-parse',
1706 $this->contentModel
,
1707 $this->contentFormat
,
1710 $status->value
= self
::AS_PARSE_ERROR
;
1714 # Check image redirect
1715 if ( $this->mTitle
->getNamespace() == NS_FILE
&&
1716 $textbox_content->isRedirect() &&
1717 !$wgUser->isAllowed( 'upload' )
1719 $code = $wgUser->isAnon() ? self
::AS_IMAGE_REDIRECT_ANON
: self
::AS_IMAGE_REDIRECT_LOGGED
;
1720 $status->setResult( false, $code );
1726 $match = self
::matchSummarySpamRegex( $this->summary
);
1727 if ( $match === false && $this->section
== 'new' ) {
1728 # $wgSpamRegex is enforced on this new heading/summary because, unlike
1729 # regular summaries, it is added to the actual wikitext.
1730 if ( $this->sectiontitle
!== '' ) {
1731 # This branch is taken when the API is used with the 'sectiontitle' parameter.
1732 $match = self
::matchSpamRegex( $this->sectiontitle
);
1734 # This branch is taken when the "Add Topic" user interface is used, or the API
1735 # is used with the 'summary' parameter.
1736 $match = self
::matchSpamRegex( $this->summary
);
1739 if ( $match === false ) {
1740 $match = self
::matchSpamRegex( $this->textbox1
);
1742 if ( $match !== false ) {
1743 $result['spam'] = $match;
1744 $ip = $wgRequest->getIP();
1745 $pdbk = $this->mTitle
->getPrefixedDBkey();
1746 $match = str_replace( "\n", '', $match );
1747 wfDebugLog( 'SpamRegex', "$ip spam regex hit [[$pdbk]]: \"$match\"" );
1748 $status->fatal( 'spamprotectionmatch', $match );
1749 $status->value
= self
::AS_SPAM_ERROR
;
1754 [ $this, $this->textbox1
, $this->section
, &$this->hookError
, $this->summary
] )
1756 # Error messages etc. could be handled within the hook...
1757 $status->fatal( 'hookaborted' );
1758 $status->value
= self
::AS_HOOK_ERROR
;
1760 } elseif ( $this->hookError
!= '' ) {
1761 # ...or the hook could be expecting us to produce an error
1762 $status->fatal( 'hookaborted' );
1763 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1767 if ( $wgUser->isBlockedFrom( $this->mTitle
, false ) ) {
1768 // Auto-block user's IP if the account was "hard" blocked
1769 if ( !wfReadOnly() ) {
1770 $wgUser->spreadAnyEditBlock();
1772 # Check block state against master, thus 'false'.
1773 $status->setResult( false, self
::AS_BLOCKED_PAGE_FOR_USER
);
1777 $this->contentLength
= strlen( $this->textbox1
);
1778 if ( $this->contentLength
> $wgMaxArticleSize * 1024 ) {
1779 // Error will be displayed by showEditForm()
1780 $this->tooBig
= true;
1781 $status->setResult( false, self
::AS_CONTENT_TOO_BIG
);
1785 if ( !$wgUser->isAllowed( 'edit' ) ) {
1786 if ( $wgUser->isAnon() ) {
1787 $status->setResult( false, self
::AS_READ_ONLY_PAGE_ANON
);
1790 $status->fatal( 'readonlytext' );
1791 $status->value
= self
::AS_READ_ONLY_PAGE_LOGGED
;
1796 $changingContentModel = false;
1797 if ( $this->contentModel
!== $this->mTitle
->getContentModel() ) {
1798 if ( !$wgContentHandlerUseDB ) {
1799 $status->fatal( 'editpage-cannot-use-custom-model' );
1800 $status->value
= self
::AS_CANNOT_USE_CUSTOM_MODEL
;
1802 } elseif ( !$wgUser->isAllowed( 'editcontentmodel' ) ) {
1803 $status->setResult( false, self
::AS_NO_CHANGE_CONTENT_MODEL
);
1807 $changingContentModel = true;
1808 $oldContentModel = $this->mTitle
->getContentModel();
1811 if ( $this->changeTags
) {
1812 $changeTagsStatus = ChangeTags
::canAddTagsAccompanyingChange(
1813 $this->changeTags
, $wgUser );
1814 if ( !$changeTagsStatus->isOK() ) {
1815 $changeTagsStatus->value
= self
::AS_CHANGE_TAG_ERROR
;
1816 return $changeTagsStatus;
1820 if ( wfReadOnly() ) {
1821 $status->fatal( 'readonlytext' );
1822 $status->value
= self
::AS_READ_ONLY_PAGE
;
1825 if ( $wgUser->pingLimiter() ||
$wgUser->pingLimiter( 'linkpurge', 0 ) ) {
1826 $status->fatal( 'actionthrottledtext' );
1827 $status->value
= self
::AS_RATE_LIMITED
;
1831 # If the article has been deleted while editing, don't save it without
1833 if ( $this->wasDeletedSinceLastEdit() && !$this->recreate
) {
1834 $status->setResult( false, self
::AS_ARTICLE_WAS_DELETED
);
1838 # Load the page data from the master. If anything changes in the meantime,
1839 # we detect it by using page_latest like a token in a 1 try compare-and-swap.
1840 $this->page
->loadPageData( 'fromdbmaster' );
1841 $new = !$this->page
->exists();
1844 // Late check for create permission, just in case *PARANOIA*
1845 if ( !$this->mTitle
->userCan( 'create', $wgUser ) ) {
1846 $status->fatal( 'nocreatetext' );
1847 $status->value
= self
::AS_NO_CREATE_PERMISSION
;
1848 wfDebug( __METHOD__
. ": no create permission\n" );
1852 // Don't save a new page if it's blank or if it's a MediaWiki:
1853 // message with content equivalent to default (allow empty pages
1854 // in this case to disable messages, see bug 50124)
1855 $defaultMessageText = $this->mTitle
->getDefaultMessageText();
1856 if ( $this->mTitle
->getNamespace() === NS_MEDIAWIKI
&& $defaultMessageText !== false ) {
1857 $defaultText = $defaultMessageText;
1862 if ( !$this->allowBlankArticle
&& $this->textbox1
=== $defaultText ) {
1863 $this->blankArticle
= true;
1864 $status->fatal( 'blankarticle' );
1865 $status->setResult( false, self
::AS_BLANK_ARTICLE
);
1869 if ( !$this->runPostMergeFilters( $textbox_content, $status, $wgUser ) ) {
1873 $content = $textbox_content;
1875 $result['sectionanchor'] = '';
1876 if ( $this->section
== 'new' ) {
1877 if ( $this->sectiontitle
!== '' ) {
1878 // Insert the section title above the content.
1879 $content = $content->addSectionHeader( $this->sectiontitle
);
1880 } elseif ( $this->summary
!== '' ) {
1881 // Insert the section title above the content.
1882 $content = $content->addSectionHeader( $this->summary
);
1884 $this->summary
= $this->newSectionSummary( $result['sectionanchor'] );
1887 $status->value
= self
::AS_SUCCESS_NEW_ARTICLE
;
1891 # Article exists. Check for edit conflict.
1893 $this->page
->clear(); # Force reload of dates, etc.
1894 $timestamp = $this->page
->getTimestamp();
1895 $latest = $this->page
->getLatest();
1897 wfDebug( "timestamp: {$timestamp}, edittime: {$this->edittime}\n" );
1899 // Check editRevId if set, which handles same-second timestamp collisions
1900 if ( $timestamp != $this->edittime
1901 ||
( $this->editRevId
!== null && $this->editRevId
!= $latest )
1903 $this->isConflict
= true;
1904 if ( $this->section
== 'new' ) {
1905 if ( $this->page
->getUserText() == $wgUser->getName() &&
1906 $this->page
->getComment() == $this->newSectionSummary()
1908 // Probably a duplicate submission of a new comment.
1909 // This can happen when CDN resends a request after
1910 // a timeout but the first one actually went through.
1912 . ": duplicate new section submission; trigger edit conflict!\n" );
1914 // New comment; suppress conflict.
1915 $this->isConflict
= false;
1916 wfDebug( __METHOD__
. ": conflict suppressed; new section\n" );
1918 } elseif ( $this->section
== ''
1919 && Revision
::userWasLastToEdit(
1920 DB_MASTER
, $this->mTitle
->getArticleID(),
1921 $wgUser->getId(), $this->edittime
1924 # Suppress edit conflict with self, except for section edits where merging is required.
1925 wfDebug( __METHOD__
. ": Suppressing edit conflict, same user.\n" );
1926 $this->isConflict
= false;
1930 // If sectiontitle is set, use it, otherwise use the summary as the section title.
1931 if ( $this->sectiontitle
!== '' ) {
1932 $sectionTitle = $this->sectiontitle
;
1934 $sectionTitle = $this->summary
;
1939 if ( $this->isConflict
) {
1941 . ": conflict! getting section '{$this->section}' for time '{$this->edittime}'"
1942 . " (id '{$this->editRevId}') (article time '{$timestamp}')\n" );
1943 // @TODO: replaceSectionAtRev() with base ID (not prior current) for ?oldid=X case
1944 // ...or disable section editing for non-current revisions (not exposed anyway).
1945 if ( $this->editRevId
!== null ) {
1946 $content = $this->page
->replaceSectionAtRev(
1953 $content = $this->page
->replaceSectionContent(
1961 wfDebug( __METHOD__
. ": getting section '{$this->section}'\n" );
1962 $content = $this->page
->replaceSectionContent(
1969 if ( is_null( $content ) ) {
1970 wfDebug( __METHOD__
. ": activating conflict; section replace failed.\n" );
1971 $this->isConflict
= true;
1972 $content = $textbox_content; // do not try to merge here!
1973 } elseif ( $this->isConflict
) {
1975 if ( $this->mergeChangesIntoContent( $content ) ) {
1976 // Successful merge! Maybe we should tell the user the good news?
1977 $this->isConflict
= false;
1978 wfDebug( __METHOD__
. ": Suppressing edit conflict, successful merge.\n" );
1980 $this->section
= '';
1981 $this->textbox1
= ContentHandler
::getContentText( $content );
1982 wfDebug( __METHOD__
. ": Keeping edit conflict, failed merge.\n" );
1986 if ( $this->isConflict
) {
1987 $status->setResult( false, self
::AS_CONFLICT_DETECTED
);
1991 if ( !$this->runPostMergeFilters( $content, $status, $wgUser ) ) {
1995 if ( $this->section
== 'new' ) {
1996 // Handle the user preference to force summaries here
1997 if ( !$this->allowBlankSummary
&& trim( $this->summary
) == '' ) {
1998 $this->missingSummary
= true;
1999 $status->fatal( 'missingsummary' ); // or 'missingcommentheader' if $section == 'new'. Blegh
2000 $status->value
= self
::AS_SUMMARY_NEEDED
;
2004 // Do not allow the user to post an empty comment
2005 if ( $this->textbox1
== '' ) {
2006 $this->missingComment
= true;
2007 $status->fatal( 'missingcommenttext' );
2008 $status->value
= self
::AS_TEXTBOX_EMPTY
;
2011 } elseif ( !$this->allowBlankSummary
2012 && !$content->equals( $this->getOriginalContent( $wgUser ) )
2013 && !$content->isRedirect()
2014 && md5( $this->summary
) == $this->autoSumm
2016 $this->missingSummary
= true;
2017 $status->fatal( 'missingsummary' );
2018 $status->value
= self
::AS_SUMMARY_NEEDED
;
2023 $sectionanchor = '';
2024 if ( $this->section
== 'new' ) {
2025 $this->summary
= $this->newSectionSummary( $sectionanchor );
2026 } elseif ( $this->section
!= '' ) {
2027 # Try to get a section anchor from the section source, redirect
2028 # to edited section if header found.
2029 # XXX: Might be better to integrate this into Article::replaceSectionAtRev
2030 # for duplicate heading checking and maybe parsing.
2031 $hasmatch = preg_match( "/^ *([=]{1,6})(.*?)(\\1) *\\n/i", $this->textbox1
, $matches );
2032 # We can't deal with anchors, includes, html etc in the header for now,
2033 # headline would need to be parsed to improve this.
2034 if ( $hasmatch && strlen( $matches[2] ) > 0 ) {
2035 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $matches[2] );
2038 $result['sectionanchor'] = $sectionanchor;
2040 // Save errors may fall down to the edit form, but we've now
2041 // merged the section into full text. Clear the section field
2042 // so that later submission of conflict forms won't try to
2043 // replace that into a duplicated mess.
2044 $this->textbox1
= $this->toEditText( $content );
2045 $this->section
= '';
2047 $status->value
= self
::AS_SUCCESS_UPDATE
;
2050 if ( !$this->allowSelfRedirect
2051 && $content->isRedirect()
2052 && $content->getRedirectTarget()->equals( $this->getTitle() )
2054 // If the page already redirects to itself, don't warn.
2055 $currentTarget = $this->getCurrentContent()->getRedirectTarget();
2056 if ( !$currentTarget ||
!$currentTarget->equals( $this->getTitle() ) ) {
2057 $this->selfRedirect
= true;
2058 $status->fatal( 'selfredirect' );
2059 $status->value
= self
::AS_SELF_REDIRECT
;
2064 // Check for length errors again now that the section is merged in
2065 $this->contentLength
= strlen( $this->toEditText( $content ) );
2066 if ( $this->contentLength
> $wgMaxArticleSize * 1024 ) {
2067 $this->tooBig
= true;
2068 $status->setResult( false, self
::AS_MAX_ARTICLE_SIZE_EXCEEDED
);
2072 $flags = EDIT_AUTOSUMMARY |
2073 ( $new ? EDIT_NEW
: EDIT_UPDATE
) |
2074 ( ( $this->minoredit
&& !$this->isNew
) ? EDIT_MINOR
: 0 ) |
2075 ( $bot ? EDIT_FORCE_BOT
: 0 );
2077 $doEditStatus = $this->page
->doEditContent(
2083 $content->getDefaultFormat(),
2087 if ( !$doEditStatus->isOK() ) {
2088 // Failure from doEdit()
2089 // Show the edit conflict page for certain recognized errors from doEdit(),
2090 // but don't show it for errors from extension hooks
2091 $errors = $doEditStatus->getErrorsArray();
2092 if ( in_array( $errors[0][0],
2093 [ 'edit-gone-missing', 'edit-conflict', 'edit-already-exists' ] )
2095 $this->isConflict
= true;
2096 // Destroys data doEdit() put in $status->value but who cares
2097 $doEditStatus->value
= self
::AS_END
;
2099 return $doEditStatus;
2102 $result['nullEdit'] = $doEditStatus->hasMessage( 'edit-no-change' );
2103 if ( $result['nullEdit'] ) {
2104 // We don't know if it was a null edit until now, so increment here
2105 $wgUser->pingLimiter( 'linkpurge' );
2107 $result['redirect'] = $content->isRedirect();
2109 $this->updateWatchlist();
2111 // If the content model changed, add a log entry
2112 if ( $changingContentModel ) {
2113 $this->addContentModelChangeLogEntry(
2115 $new ?
false : $oldContentModel,
2116 $this->contentModel
,
2126 * @param string|false $oldModel false if the page is being newly created
2127 * @param string $newModel
2128 * @param string $reason
2130 protected function addContentModelChangeLogEntry( User
$user, $oldModel, $newModel, $reason ) {
2131 $new = $oldModel === false;
2132 $log = new ManualLogEntry( 'contentmodel', $new ?
'new' : 'change' );
2133 $log->setPerformer( $user );
2134 $log->setTarget( $this->mTitle
);
2135 $log->setComment( $reason );
2136 $log->setParameters( [
2137 '4::oldmodel' => $oldModel,
2138 '5::newmodel' => $newModel
2140 $logid = $log->insert();
2141 $log->publish( $logid );
2145 * Register the change of watch status
2147 protected function updateWatchlist() {
2150 if ( !$wgUser->isLoggedIn() ) {
2155 $title = $this->mTitle
;
2156 $watch = $this->watchthis
;
2157 // Do this in its own transaction to reduce contention...
2158 DeferredUpdates
::addCallableUpdate( function () use ( $user, $title, $watch ) {
2159 if ( $watch == $user->isWatched( $title, User
::IGNORE_USER_RIGHTS
) ) {
2160 return; // nothing to change
2162 WatchAction
::doWatchOrUnwatch( $watch, $title, $user );
2167 * Attempts to do 3-way merge of edit content with a base revision
2168 * and current content, in case of edit conflict, in whichever way appropriate
2169 * for the content type.
2173 * @param Content $editContent
2177 private function mergeChangesIntoContent( &$editContent ) {
2179 $db = wfGetDB( DB_MASTER
);
2181 // This is the revision the editor started from
2182 $baseRevision = $this->getBaseRevision();
2183 $baseContent = $baseRevision ?
$baseRevision->getContent() : null;
2185 if ( is_null( $baseContent ) ) {
2189 // The current state, we want to merge updates into it
2190 $currentRevision = Revision
::loadFromTitle( $db, $this->mTitle
);
2191 $currentContent = $currentRevision ?
$currentRevision->getContent() : null;
2193 if ( is_null( $currentContent ) ) {
2197 $handler = ContentHandler
::getForModelID( $baseContent->getModel() );
2199 $result = $handler->merge3( $baseContent, $editContent, $currentContent );
2202 $editContent = $result;
2203 // Update parentRevId to what we just merged.
2204 $this->parentRevId
= $currentRevision->getId();
2212 * @note: this method is very poorly named. If the user opened the form with ?oldid=X,
2213 * one might think of X as the "base revision", which is NOT what this returns.
2214 * @return Revision Current version when the edit was started
2216 function getBaseRevision() {
2217 if ( !$this->mBaseRevision
) {
2218 $db = wfGetDB( DB_MASTER
);
2219 $this->mBaseRevision
= $this->editRevId
2220 ? Revision
::newFromId( $this->editRevId
, Revision
::READ_LATEST
)
2221 : Revision
::loadFromTimestamp( $db, $this->mTitle
, $this->edittime
);
2223 return $this->mBaseRevision
;
2227 * Check given input text against $wgSpamRegex, and return the text of the first match.
2229 * @param string $text
2231 * @return string|bool Matching string or false
2233 public static function matchSpamRegex( $text ) {
2234 global $wgSpamRegex;
2235 // For back compatibility, $wgSpamRegex may be a single string or an array of regexes.
2236 $regexes = (array)$wgSpamRegex;
2237 return self
::matchSpamRegexInternal( $text, $regexes );
2241 * Check given input text against $wgSummarySpamRegex, and return the text of the first match.
2243 * @param string $text
2245 * @return string|bool Matching string or false
2247 public static function matchSummarySpamRegex( $text ) {
2248 global $wgSummarySpamRegex;
2249 $regexes = (array)$wgSummarySpamRegex;
2250 return self
::matchSpamRegexInternal( $text, $regexes );
2254 * @param string $text
2255 * @param array $regexes
2256 * @return bool|string
2258 protected static function matchSpamRegexInternal( $text, $regexes ) {
2259 foreach ( $regexes as $regex ) {
2261 if ( preg_match( $regex, $text, $matches ) ) {
2268 function setHeaders() {
2269 global $wgOut, $wgUser, $wgAjaxEditStash;
2271 $wgOut->addModules( 'mediawiki.action.edit' );
2272 $wgOut->addModuleStyles( 'mediawiki.action.edit.styles' );
2274 if ( $wgUser->getOption( 'showtoolbar' ) ) {
2275 // The addition of default buttons is handled by getEditToolbar() which
2276 // has its own dependency on this module. The call here ensures the module
2277 // is loaded in time (it has position "top") for other modules to register
2278 // buttons (e.g. extensions, gadgets, user scripts).
2279 $wgOut->addModules( 'mediawiki.toolbar' );
2282 if ( $wgUser->getOption( 'uselivepreview' ) ) {
2283 $wgOut->addModules( 'mediawiki.action.edit.preview' );
2286 if ( $wgUser->getOption( 'useeditwarning' ) ) {
2287 $wgOut->addModules( 'mediawiki.action.edit.editWarning' );
2290 # Enabled article-related sidebar, toplinks, etc.
2291 $wgOut->setArticleRelated( true );
2293 $contextTitle = $this->getContextTitle();
2294 if ( $this->isConflict
) {
2295 $msg = 'editconflict';
2296 } elseif ( $contextTitle->exists() && $this->section
!= '' ) {
2297 $msg = $this->section
== 'new' ?
'editingcomment' : 'editingsection';
2299 $msg = $contextTitle->exists()
2300 ||
( $contextTitle->getNamespace() == NS_MEDIAWIKI
2301 && $contextTitle->getDefaultMessageText() !== false
2307 # Use the title defined by DISPLAYTITLE magic word when present
2308 # NOTE: getDisplayTitle() returns HTML while getPrefixedText() returns plain text.
2309 # setPageTitle() treats the input as wikitext, which should be safe in either case.
2310 $displayTitle = isset( $this->mParserOutput
) ?
$this->mParserOutput
->getDisplayTitle() : false;
2311 if ( $displayTitle === false ) {
2312 $displayTitle = $contextTitle->getPrefixedText();
2314 $wgOut->setPageTitle( wfMessage( $msg, $displayTitle ) );
2315 # Transmit the name of the message to JavaScript for live preview
2316 # Keep Resources.php/mediawiki.action.edit.preview in sync with the possible keys
2317 $wgOut->addJsConfigVars( [
2318 'wgEditMessage' => $msg,
2319 'wgAjaxEditStash' => $wgAjaxEditStash,
2324 * Show all applicable editing introductions
2326 protected function showIntro() {
2327 global $wgOut, $wgUser;
2328 if ( $this->suppressIntro
) {
2332 $namespace = $this->mTitle
->getNamespace();
2334 if ( $namespace == NS_MEDIAWIKI
) {
2335 # Show a warning if editing an interface message
2336 $wgOut->wrapWikiMsg( "<div class='mw-editinginterface'>\n$1\n</div>", 'editinginterface' );
2337 # If this is a default message (but not css or js),
2338 # show a hint that it is translatable on translatewiki.net
2339 if ( !$this->mTitle
->hasContentModel( CONTENT_MODEL_CSS
)
2340 && !$this->mTitle
->hasContentModel( CONTENT_MODEL_JAVASCRIPT
)
2342 $defaultMessageText = $this->mTitle
->getDefaultMessageText();
2343 if ( $defaultMessageText !== false ) {
2344 $wgOut->wrapWikiMsg( "<div class='mw-translateinterface'>\n$1\n</div>",
2345 'translateinterface' );
2348 } elseif ( $namespace == NS_FILE
) {
2349 # Show a hint to shared repo
2350 $file = wfFindFile( $this->mTitle
);
2351 if ( $file && !$file->isLocal() ) {
2352 $descUrl = $file->getDescriptionUrl();
2353 # there must be a description url to show a hint to shared repo
2355 if ( !$this->mTitle
->exists() ) {
2356 $wgOut->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-create\">\n$1\n</div>", [
2357 'sharedupload-desc-create', $file->getRepo()->getDisplayName(), $descUrl
2360 $wgOut->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-edit\">\n$1\n</div>", [
2361 'sharedupload-desc-edit', $file->getRepo()->getDisplayName(), $descUrl
2368 # Show a warning message when someone creates/edits a user (talk) page but the user does not exist
2369 # Show log extract when the user is currently blocked
2370 if ( $namespace == NS_USER ||
$namespace == NS_USER_TALK
) {
2371 $username = explode( '/', $this->mTitle
->getText(), 2 )[0];
2372 $user = User
::newFromName( $username, false /* allow IP users*/ );
2373 $ip = User
::isIP( $username );
2374 $block = Block
::newFromTarget( $user, $user );
2375 if ( !( $user && $user->isLoggedIn() ) && !$ip ) { # User does not exist
2376 $wgOut->wrapWikiMsg( "<div class=\"mw-userpage-userdoesnotexist error\">\n$1\n</div>",
2377 [ 'userpage-userdoesnotexist', wfEscapeWikiText( $username ) ] );
2378 } elseif ( !is_null( $block ) && $block->getType() != Block
::TYPE_AUTO
) {
2379 # Show log extract if the user is currently blocked
2380 LogEventsList
::showLogExtract(
2383 MWNamespace
::getCanonicalName( NS_USER
) . ':' . $block->getTarget(),
2387 'showIfEmpty' => false,
2389 'blocked-notice-logextract',
2390 $user->getName() # Support GENDER in notice
2396 # Try to add a custom edit intro, or use the standard one if this is not possible.
2397 if ( !$this->showCustomIntro() && !$this->mTitle
->exists() ) {
2398 $helpLink = wfExpandUrl( Skin
::makeInternalOrExternalUrl(
2399 wfMessage( 'helppage' )->inContentLanguage()->text()
2401 if ( $wgUser->isLoggedIn() ) {
2402 $wgOut->wrapWikiMsg(
2403 // Suppress the external link icon, consider the help url an internal one
2404 "<div class=\"mw-newarticletext plainlinks\">\n$1\n</div>",
2411 $wgOut->wrapWikiMsg(
2412 // Suppress the external link icon, consider the help url an internal one
2413 "<div class=\"mw-newarticletextanon plainlinks\">\n$1\n</div>",
2415 'newarticletextanon',
2421 # Give a notice if the user is editing a deleted/moved page...
2422 if ( !$this->mTitle
->exists() ) {
2423 LogEventsList
::showLogExtract( $wgOut, [ 'delete', 'move' ], $this->mTitle
,
2427 'conds' => [ "log_action != 'revision'" ],
2428 'showIfEmpty' => false,
2429 'msgKey' => [ 'recreate-moveddeleted-warn' ]
2436 * Attempt to show a custom editing introduction, if supplied
2440 protected function showCustomIntro() {
2441 if ( $this->editintro
) {
2442 $title = Title
::newFromText( $this->editintro
);
2443 if ( $title instanceof Title
&& $title->exists() && $title->userCan( 'read' ) ) {
2445 // Added using template syntax, to take <noinclude>'s into account.
2446 $wgOut->addWikiTextTitleTidy(
2447 '<div class="mw-editintro">{{:' . $title->getFullText() . '}}</div>',
2457 * Gets an editable textual representation of $content.
2458 * The textual representation can be turned by into a Content object by the
2459 * toEditContent() method.
2461 * If $content is null or false or a string, $content is returned unchanged.
2463 * If the given Content object is not of a type that can be edited using
2464 * the text base EditPage, an exception will be raised. Set
2465 * $this->allowNonTextContent to true to allow editing of non-textual
2468 * @param Content|null|bool|string $content
2469 * @return string The editable text form of the content.
2471 * @throws MWException If $content is not an instance of TextContent and
2472 * $this->allowNonTextContent is not true.
2474 protected function toEditText( $content ) {
2475 if ( $content === null ||
$content === false ||
is_string( $content ) ) {
2479 if ( !$this->isSupportedContentModel( $content->getModel() ) ) {
2480 throw new MWException( 'This content model is not supported: '
2481 . ContentHandler
::getLocalizedName( $content->getModel() ) );
2484 return $content->serialize( $this->contentFormat
);
2488 * Turns the given text into a Content object by unserializing it.
2490 * If the resulting Content object is not of a type that can be edited using
2491 * the text base EditPage, an exception will be raised. Set
2492 * $this->allowNonTextContent to true to allow editing of non-textual
2495 * @param string|null|bool $text Text to unserialize
2496 * @return Content The content object created from $text. If $text was false
2497 * or null, false resp. null will be returned instead.
2499 * @throws MWException If unserializing the text results in a Content
2500 * object that is not an instance of TextContent and
2501 * $this->allowNonTextContent is not true.
2503 protected function toEditContent( $text ) {
2504 if ( $text === false ||
$text === null ) {
2508 $content = ContentHandler
::makeContent( $text, $this->getTitle(),
2509 $this->contentModel
, $this->contentFormat
);
2511 if ( !$this->isSupportedContentModel( $content->getModel() ) ) {
2512 throw new MWException( 'This content model is not supported: '
2513 . ContentHandler
::getLocalizedName( $content->getModel() ) );
2520 * Send the edit form and related headers to $wgOut
2521 * @param callable|null $formCallback That takes an OutputPage parameter; will be called
2522 * during form output near the top, for captchas and the like.
2524 * The $formCallback parameter is deprecated since MediaWiki 1.25. Please
2525 * use the EditPage::showEditForm:fields hook instead.
2527 function showEditForm( $formCallback = null ) {
2528 global $wgOut, $wgUser;
2530 # need to parse the preview early so that we know which templates are used,
2531 # otherwise users with "show preview after edit box" will get a blank list
2532 # we parse this near the beginning so that setHeaders can do the title
2533 # setting work instead of leaving it in getPreviewText
2534 $previewOutput = '';
2535 if ( $this->formtype
== 'preview' ) {
2536 $previewOutput = $this->getPreviewText();
2539 Hooks
::run( 'EditPage::showEditForm:initial', [ &$this, &$wgOut ] );
2541 $this->setHeaders();
2543 if ( $this->showHeader() === false ) {
2547 $wgOut->addHTML( $this->editFormPageTop
);
2549 if ( $wgUser->getOption( 'previewontop' ) ) {
2550 $this->displayPreviewArea( $previewOutput, true );
2553 $wgOut->addHTML( $this->editFormTextTop
);
2555 $showToolbar = true;
2556 if ( $this->wasDeletedSinceLastEdit() ) {
2557 if ( $this->formtype
== 'save' ) {
2558 // Hide the toolbar and edit area, user can click preview to get it back
2559 // Add an confirmation checkbox and explanation.
2560 $showToolbar = false;
2562 $wgOut->wrapWikiMsg( "<div class='error mw-deleted-while-editing'>\n$1\n</div>",
2563 'deletedwhileediting' );
2567 // @todo add EditForm plugin interface and use it here!
2568 // search for textarea1 and textares2, and allow EditForm to override all uses.
2569 $wgOut->addHTML( Html
::openElement(
2572 'id' => self
::EDITFORM_ID
,
2573 'name' => self
::EDITFORM_ID
,
2575 'action' => $this->getActionURL( $this->getContextTitle() ),
2576 'enctype' => 'multipart/form-data'
2580 if ( is_callable( $formCallback ) ) {
2581 wfWarn( 'The $formCallback parameter to ' . __METHOD__
. 'is deprecated' );
2582 call_user_func_array( $formCallback, [ &$wgOut ] );
2585 // Add an empty field to trip up spambots
2587 Xml
::openElement( 'div', [ 'id' => 'antispam-container', 'style' => 'display: none;' ] )
2590 [ 'for' => 'wpAntispam' ],
2591 wfMessage( 'simpleantispam-label' )->parse()
2597 'name' => 'wpAntispam',
2598 'id' => 'wpAntispam',
2602 . Xml
::closeElement( 'div' )
2605 Hooks
::run( 'EditPage::showEditForm:fields', [ &$this, &$wgOut ] );
2607 // Put these up at the top to ensure they aren't lost on early form submission
2608 $this->showFormBeforeText();
2610 if ( $this->wasDeletedSinceLastEdit() && 'save' == $this->formtype
) {
2611 $username = $this->lastDelete
->user_name
;
2612 $comment = $this->lastDelete
->log_comment
;
2614 // It is better to not parse the comment at all than to have templates expanded in the middle
2615 // TODO: can the checkLabel be moved outside of the div so that wrapWikiMsg could be used?
2616 $key = $comment === ''
2617 ?
'confirmrecreate-noreason'
2618 : 'confirmrecreate';
2620 '<div class="mw-confirm-recreate">' .
2621 wfMessage( $key, $username, "<nowiki>$comment</nowiki>" )->parse() .
2622 Xml
::checkLabel( wfMessage( 'recreate' )->text(), 'wpRecreate', 'wpRecreate', false,
2623 [ 'title' => Linker
::titleAttrib( 'recreate' ), 'tabindex' => 1, 'id' => 'wpRecreate' ]
2629 # When the summary is hidden, also hide them on preview/show changes
2630 if ( $this->nosummary
) {
2631 $wgOut->addHTML( Html
::hidden( 'nosummary', true ) );
2634 # If a blank edit summary was previously provided, and the appropriate
2635 # user preference is active, pass a hidden tag as wpIgnoreBlankSummary. This will stop the
2636 # user being bounced back more than once in the event that a summary
2639 # For a bit more sophisticated detection of blank summaries, hash the
2640 # automatic one and pass that in the hidden field wpAutoSummary.
2641 if ( $this->missingSummary ||
( $this->section
== 'new' && $this->nosummary
) ) {
2642 $wgOut->addHTML( Html
::hidden( 'wpIgnoreBlankSummary', true ) );
2645 if ( $this->undidRev
) {
2646 $wgOut->addHTML( Html
::hidden( 'wpUndidRevision', $this->undidRev
) );
2649 if ( $this->selfRedirect
) {
2650 $wgOut->addHTML( Html
::hidden( 'wpIgnoreSelfRedirect', true ) );
2653 if ( $this->hasPresetSummary
) {
2654 // If a summary has been preset using &summary= we don't want to prompt for
2655 // a different summary. Only prompt for a summary if the summary is blanked.
2657 $this->autoSumm
= md5( '' );
2660 $autosumm = $this->autoSumm ?
$this->autoSumm
: md5( $this->summary
);
2661 $wgOut->addHTML( Html
::hidden( 'wpAutoSummary', $autosumm ) );
2663 $wgOut->addHTML( Html
::hidden( 'oldid', $this->oldid
) );
2664 $wgOut->addHTML( Html
::hidden( 'parentRevId', $this->getParentRevId() ) );
2666 $wgOut->addHTML( Html
::hidden( 'format', $this->contentFormat
) );
2667 $wgOut->addHTML( Html
::hidden( 'model', $this->contentModel
) );
2669 if ( $this->section
== 'new' ) {
2670 $this->showSummaryInput( true, $this->summary
);
2671 $wgOut->addHTML( $this->getSummaryPreview( true, $this->summary
) );
2674 $wgOut->addHTML( $this->editFormTextBeforeContent
);
2676 if ( !$this->isCssJsSubpage
&& $showToolbar && $wgUser->getOption( 'showtoolbar' ) ) {
2677 $wgOut->addHTML( EditPage
::getEditToolbar( $this->mTitle
) );
2680 if ( $this->blankArticle
) {
2681 $wgOut->addHTML( Html
::hidden( 'wpIgnoreBlankArticle', true ) );
2684 if ( $this->isConflict
) {
2685 // In an edit conflict bypass the overridable content form method
2686 // and fallback to the raw wpTextbox1 since editconflicts can't be
2687 // resolved between page source edits and custom ui edits using the
2689 $this->textbox2
= $this->textbox1
;
2691 $content = $this->getCurrentContent();
2692 $this->textbox1
= $this->toEditText( $content );
2694 $this->showTextbox1();
2696 $this->showContentForm();
2699 $wgOut->addHTML( $this->editFormTextAfterContent
);
2701 $this->showStandardInputs();
2703 $this->showFormAfterText();
2705 $this->showTosSummary();
2707 $this->showEditTools();
2709 $wgOut->addHTML( $this->editFormTextAfterTools
. "\n" );
2711 $wgOut->addHTML( Html
::rawElement( 'div', [ 'class' => 'templatesUsed' ],
2712 Linker
::formatTemplates( $this->getTemplates(), $this->preview
, $this->section
!= '' ) ) );
2714 $wgOut->addHTML( Html
::rawElement( 'div', [ 'class' => 'hiddencats' ],
2715 Linker
::formatHiddenCategories( $this->page
->getHiddenCategories() ) ) );
2717 $wgOut->addHTML( Html
::rawElement( 'div', [ 'class' => 'limitreport' ],
2718 self
::getPreviewLimitReport( $this->mParserOutput
) ) );
2720 $wgOut->addModules( 'mediawiki.action.edit.collapsibleFooter' );
2722 if ( $this->isConflict
) {
2724 $this->showConflict();
2725 } catch ( MWContentSerializationException
$ex ) {
2726 // this can't really happen, but be nice if it does.
2728 'content-failed-to-parse',
2729 $this->contentModel
,
2730 $this->contentFormat
,
2733 $wgOut->addWikiText( '<div class="error">' . $msg->text() . '</div>' );
2737 // Set a hidden field so JS knows what edit form mode we are in
2738 if ( $this->isConflict
) {
2740 } elseif ( $this->preview
) {
2742 } elseif ( $this->diff
) {
2747 $wgOut->addHTML( Html
::hidden( 'mode', $mode, [ 'id' => 'mw-edit-mode' ] ) );
2749 // Marker for detecting truncated form data. This must be the last
2750 // parameter sent in order to be of use, so do not move me.
2751 $wgOut->addHTML( Html
::hidden( 'wpUltimateParam', true ) );
2752 $wgOut->addHTML( $this->editFormTextBottom
. "\n</form>\n" );
2754 if ( !$wgUser->getOption( 'previewontop' ) ) {
2755 $this->displayPreviewArea( $previewOutput, false );
2761 * Extract the section title from current section text, if any.
2763 * @param string $text
2764 * @return string|bool String or false
2766 public static function extractSectionTitle( $text ) {
2767 preg_match( "/^(=+)(.+)\\1\\s*(\n|$)/i", $text, $matches );
2768 if ( !empty( $matches[2] ) ) {
2770 return $wgParser->stripSectionName( trim( $matches[2] ) );
2779 protected function showHeader() {
2780 global $wgOut, $wgUser, $wgMaxArticleSize, $wgLang;
2781 global $wgAllowUserCss, $wgAllowUserJs;
2783 if ( $this->mTitle
->isTalkPage() ) {
2784 $wgOut->addWikiMsg( 'talkpagetext' );
2788 $editNotices = $this->mTitle
->getEditNotices( $this->oldid
);
2789 if ( count( $editNotices ) ) {
2790 $wgOut->addHTML( implode( "\n", $editNotices ) );
2792 $msg = wfMessage( 'editnotice-notext' );
2793 if ( !$msg->isDisabled() ) {
2795 '<div class="mw-editnotice-notext">'
2796 . $msg->parseAsBlock()
2802 if ( $this->isConflict
) {
2803 $wgOut->wrapWikiMsg( "<div class='mw-explainconflict'>\n$1\n</div>", 'explainconflict' );
2804 $this->editRevId
= $this->page
->getLatest();
2806 if ( $this->section
!= '' && !$this->isSectionEditSupported() ) {
2807 // We use $this->section to much before this and getVal('wgSection') directly in other places
2808 // at this point we can't reset $this->section to '' to fallback to non-section editing.
2809 // Someone is welcome to try refactoring though
2810 $wgOut->showErrorPage( 'sectioneditnotsupported-title', 'sectioneditnotsupported-text' );
2814 if ( $this->section
!= '' && $this->section
!= 'new' ) {
2815 if ( !$this->summary
&& !$this->preview
&& !$this->diff
) {
2816 $sectionTitle = self
::extractSectionTitle( $this->textbox1
); // FIXME: use Content object
2817 if ( $sectionTitle !== false ) {
2818 $this->summary
= "/* $sectionTitle */ ";
2823 if ( $this->missingComment
) {
2824 $wgOut->wrapWikiMsg( "<div id='mw-missingcommenttext'>\n$1\n</div>", 'missingcommenttext' );
2827 if ( $this->missingSummary
&& $this->section
!= 'new' ) {
2828 $wgOut->wrapWikiMsg( "<div id='mw-missingsummary'>\n$1\n</div>", 'missingsummary' );
2831 if ( $this->missingSummary
&& $this->section
== 'new' ) {
2832 $wgOut->wrapWikiMsg( "<div id='mw-missingcommentheader'>\n$1\n</div>", 'missingcommentheader' );
2835 if ( $this->blankArticle
) {
2836 $wgOut->wrapWikiMsg( "<div id='mw-blankarticle'>\n$1\n</div>", 'blankarticle' );
2839 if ( $this->selfRedirect
) {
2840 $wgOut->wrapWikiMsg( "<div id='mw-selfredirect'>\n$1\n</div>", 'selfredirect' );
2843 if ( $this->hookError
!== '' ) {
2844 $wgOut->addWikiText( $this->hookError
);
2847 if ( !$this->checkUnicodeCompliantBrowser() ) {
2848 $wgOut->addWikiMsg( 'nonunicodebrowser' );
2851 if ( $this->section
!= 'new' ) {
2852 $revision = $this->mArticle
->getRevisionFetched();
2854 // Let sysop know that this will make private content public if saved
2856 if ( !$revision->userCan( Revision
::DELETED_TEXT
, $wgUser ) ) {
2857 $wgOut->wrapWikiMsg(
2858 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
2859 'rev-deleted-text-permission'
2861 } elseif ( $revision->isDeleted( Revision
::DELETED_TEXT
) ) {
2862 $wgOut->wrapWikiMsg(
2863 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
2864 'rev-deleted-text-view'
2868 if ( !$revision->isCurrent() ) {
2869 $this->mArticle
->setOldSubtitle( $revision->getId() );
2870 $wgOut->addWikiMsg( 'editingold' );
2872 } elseif ( $this->mTitle
->exists() ) {
2873 // Something went wrong
2875 $wgOut->wrapWikiMsg( "<div class='errorbox'>\n$1\n</div>\n",
2876 [ 'missing-revision', $this->oldid
] );
2881 if ( wfReadOnly() ) {
2882 $wgOut->wrapWikiMsg(
2883 "<div id=\"mw-read-only-warning\">\n$1\n</div>",
2884 [ 'readonlywarning', wfReadOnlyReason() ]
2886 } elseif ( $wgUser->isAnon() ) {
2887 if ( $this->formtype
!= 'preview' ) {
2888 $wgOut->wrapWikiMsg(
2889 "<div id='mw-anon-edit-warning' class='warningbox'>\n$1\n</div>",
2890 [ 'anoneditwarning',
2892 SpecialPage
::getTitleFor( 'Userlogin' )->getFullURL( [
2893 'returnto' => $this->getTitle()->getPrefixedDBkey()
2896 SpecialPage
::getTitleFor( 'CreateAccount' )->getFullURL( [
2897 'returnto' => $this->getTitle()->getPrefixedDBkey()
2902 $wgOut->wrapWikiMsg( "<div id=\"mw-anon-preview-warning\" class=\"warningbox\">\n$1</div>",
2903 'anonpreviewwarning'
2907 if ( $this->isCssJsSubpage
) {
2908 # Check the skin exists
2909 if ( $this->isWrongCaseCssJsPage
) {
2910 $wgOut->wrapWikiMsg(
2911 "<div class='error' id='mw-userinvalidcssjstitle'>\n$1\n</div>",
2912 [ 'userinvalidcssjstitle', $this->mTitle
->getSkinFromCssJsSubpage() ]
2915 if ( $this->getTitle()->isSubpageOf( $wgUser->getUserPage() ) ) {
2916 if ( $this->formtype
!== 'preview' ) {
2917 if ( $this->isCssSubpage
&& $wgAllowUserCss ) {
2918 $wgOut->wrapWikiMsg(
2919 "<div id='mw-usercssyoucanpreview'>\n$1\n</div>",
2920 [ 'usercssyoucanpreview' ]
2924 if ( $this->isJsSubpage
&& $wgAllowUserJs ) {
2925 $wgOut->wrapWikiMsg(
2926 "<div id='mw-userjsyoucanpreview'>\n$1\n</div>",
2927 [ 'userjsyoucanpreview' ]
2935 if ( $this->mTitle
->isProtected( 'edit' ) &&
2936 MWNamespace
::getRestrictionLevels( $this->mTitle
->getNamespace() ) !== [ '' ]
2938 # Is the title semi-protected?
2939 if ( $this->mTitle
->isSemiProtected() ) {
2940 $noticeMsg = 'semiprotectedpagewarning';
2942 # Then it must be protected based on static groups (regular)
2943 $noticeMsg = 'protectedpagewarning';
2945 LogEventsList
::showLogExtract( $wgOut, 'protect', $this->mTitle
, '',
2946 [ 'lim' => 1, 'msgKey' => [ $noticeMsg ] ] );
2948 if ( $this->mTitle
->isCascadeProtected() ) {
2949 # Is this page under cascading protection from some source pages?
2950 /** @var Title[] $cascadeSources */
2951 list( $cascadeSources, /* $restrictions */ ) = $this->mTitle
->getCascadeProtectionSources();
2952 $notice = "<div class='mw-cascadeprotectedwarning'>\n$1\n";
2953 $cascadeSourcesCount = count( $cascadeSources );
2954 if ( $cascadeSourcesCount > 0 ) {
2955 # Explain, and list the titles responsible
2956 foreach ( $cascadeSources as $page ) {
2957 $notice .= '* [[:' . $page->getPrefixedText() . "]]\n";
2960 $notice .= '</div>';
2961 $wgOut->wrapWikiMsg( $notice, [ 'cascadeprotectedwarning', $cascadeSourcesCount ] );
2963 if ( !$this->mTitle
->exists() && $this->mTitle
->getRestrictions( 'create' ) ) {
2964 LogEventsList
::showLogExtract( $wgOut, 'protect', $this->mTitle
, '',
2966 'showIfEmpty' => false,
2967 'msgKey' => [ 'titleprotectedwarning' ],
2968 'wrap' => "<div class=\"mw-titleprotectedwarning\">\n$1</div>" ] );
2971 if ( $this->contentLength
=== false ) {
2972 $this->contentLength
= strlen( $this->textbox1
);
2975 if ( $this->tooBig ||
$this->contentLength
> $wgMaxArticleSize * 1024 ) {
2976 $wgOut->wrapWikiMsg( "<div class='error' id='mw-edit-longpageerror'>\n$1\n</div>",
2979 $wgLang->formatNum( round( $this->contentLength
/ 1024, 3 ) ),
2980 $wgLang->formatNum( $wgMaxArticleSize )
2984 if ( !wfMessage( 'longpage-hint' )->isDisabled() ) {
2985 $wgOut->wrapWikiMsg( "<div id='mw-edit-longpage-hint'>\n$1\n</div>",
2988 $wgLang->formatSize( strlen( $this->textbox1
) ),
2989 strlen( $this->textbox1
)
2994 # Add header copyright warning
2995 $this->showHeaderCopyrightWarning();
3001 * Standard summary input and label (wgSummary), abstracted so EditPage
3002 * subclasses may reorganize the form.
3003 * Note that you do not need to worry about the label's for=, it will be
3004 * inferred by the id given to the input. You can remove them both by
3005 * passing array( 'id' => false ) to $userInputAttrs.
3007 * @param string $summary The value of the summary input
3008 * @param string $labelText The html to place inside the label
3009 * @param array $inputAttrs Array of attrs to use on the input
3010 * @param array $spanLabelAttrs Array of attrs to use on the span inside the label
3012 * @return array An array in the format array( $label, $input )
3014 function getSummaryInput( $summary = "", $labelText = null,
3015 $inputAttrs = null, $spanLabelAttrs = null
3017 // Note: the maxlength is overridden in JS to 255 and to make it use UTF-8 bytes, not characters.
3018 $inputAttrs = ( is_array( $inputAttrs ) ?
$inputAttrs : [] ) +
[
3019 'id' => 'wpSummary',
3020 'maxlength' => '200',
3023 'spellcheck' => 'true',
3024 ] + Linker
::tooltipAndAccesskeyAttribs( 'summary' );
3026 $spanLabelAttrs = ( is_array( $spanLabelAttrs ) ?
$spanLabelAttrs : [] ) +
[
3027 'class' => $this->missingSummary ?
'mw-summarymissed' : 'mw-summary',
3028 'id' => "wpSummaryLabel"
3035 $inputAttrs['id'] ?
[ 'for' => $inputAttrs['id'] ] : null,
3038 $label = Xml
::tags( 'span', $spanLabelAttrs, $label );
3041 $input = Html
::input( 'wpSummary', $summary, 'text', $inputAttrs );
3043 return [ $label, $input ];
3047 * @param bool $isSubjectPreview True if this is the section subject/title
3048 * up top, or false if this is the comment summary
3049 * down below the textarea
3050 * @param string $summary The text of the summary to display
3052 protected function showSummaryInput( $isSubjectPreview, $summary = "" ) {
3054 # Add a class if 'missingsummary' is triggered to allow styling of the summary line
3055 $summaryClass = $this->missingSummary ?
'mw-summarymissed' : 'mw-summary';
3056 if ( $isSubjectPreview ) {
3057 if ( $this->nosummary
) {
3061 if ( !$this->mShowSummaryField
) {
3065 $labelText = wfMessage( $isSubjectPreview ?
'subject' : 'summary' )->parse();
3066 list( $label, $input ) = $this->getSummaryInput(
3069 [ 'class' => $summaryClass ],
3072 $wgOut->addHTML( "{$label} {$input}" );
3076 * @param bool $isSubjectPreview True if this is the section subject/title
3077 * up top, or false if this is the comment summary
3078 * down below the textarea
3079 * @param string $summary The text of the summary to display
3082 protected function getSummaryPreview( $isSubjectPreview, $summary = "" ) {
3083 // avoid spaces in preview, gets always trimmed on save
3084 $summary = trim( $summary );
3085 if ( !$summary ||
( !$this->preview
&& !$this->diff
) ) {
3091 if ( $isSubjectPreview ) {
3092 $summary = wfMessage( 'newsectionsummary' )->rawParams( $wgParser->stripSectionName( $summary ) )
3093 ->inContentLanguage()->text();
3096 $message = $isSubjectPreview ?
'subject-preview' : 'summary-preview';
3098 $summary = wfMessage( $message )->parse()
3099 . Linker
::commentBlock( $summary, $this->mTitle
, $isSubjectPreview );
3100 return Xml
::tags( 'div', [ 'class' => 'mw-summary-preview' ], $summary );
3103 protected function showFormBeforeText() {
3105 $section = htmlspecialchars( $this->section
);
3106 $wgOut->addHTML( <<<HTML
3107 <input type='hidden' value="{$section}" name="wpSection"/>
3108 <input type='hidden' value="{$this->starttime}" name="wpStarttime" />
3109 <input type='hidden' value="{$this->edittime}" name="wpEdittime" />
3110 <input type='hidden' value="{$this->editRevId}" name="editRevId" />
3111 <input type='hidden' value="{$this->scrolltop}" name="wpScrolltop" id="wpScrolltop" />
3115 if ( !$this->checkUnicodeCompliantBrowser() ) {
3116 $wgOut->addHTML( Html
::hidden( 'safemode', '1' ) );
3120 protected function showFormAfterText() {
3121 global $wgOut, $wgUser;
3123 * To make it harder for someone to slip a user a page
3124 * which submits an edit form to the wiki without their
3125 * knowledge, a random token is associated with the login
3126 * session. If it's not passed back with the submission,
3127 * we won't save the page, or render user JavaScript and
3130 * For anon editors, who may not have a session, we just
3131 * include the constant suffix to prevent editing from
3132 * broken text-mangling proxies.
3134 $wgOut->addHTML( "\n" . Html
::hidden( "wpEditToken", $wgUser->getEditToken() ) . "\n" );
3138 * Subpage overridable method for printing the form for page content editing
3139 * By default this simply outputs wpTextbox1
3140 * Subclasses can override this to provide a custom UI for editing;
3141 * be it a form, or simply wpTextbox1 with a modified content that will be
3142 * reverse modified when extracted from the post data.
3143 * Note that this is basically the inverse for importContentFormData
3145 protected function showContentForm() {
3146 $this->showTextbox1();
3150 * Method to output wpTextbox1
3151 * The $textoverride method can be used by subclasses overriding showContentForm
3152 * to pass back to this method.
3154 * @param array $customAttribs Array of html attributes to use in the textarea
3155 * @param string $textoverride Optional text to override $this->textarea1 with
3157 protected function showTextbox1( $customAttribs = null, $textoverride = null ) {
3158 if ( $this->wasDeletedSinceLastEdit() && $this->formtype
== 'save' ) {
3159 $attribs = [ 'style' => 'display:none;' ];
3161 $classes = []; // Textarea CSS
3162 if ( $this->mTitle
->isProtected( 'edit' ) &&
3163 MWNamespace
::getRestrictionLevels( $this->mTitle
->getNamespace() ) !== [ '' ]
3165 # Is the title semi-protected?
3166 if ( $this->mTitle
->isSemiProtected() ) {
3167 $classes[] = 'mw-textarea-sprotected';
3169 # Then it must be protected based on static groups (regular)
3170 $classes[] = 'mw-textarea-protected';
3172 # Is the title cascade-protected?
3173 if ( $this->mTitle
->isCascadeProtected() ) {
3174 $classes[] = 'mw-textarea-cprotected';
3178 $attribs = [ 'tabindex' => 1 ];
3180 if ( is_array( $customAttribs ) ) {
3181 $attribs +
= $customAttribs;
3184 if ( count( $classes ) ) {
3185 if ( isset( $attribs['class'] ) ) {
3186 $classes[] = $attribs['class'];
3188 $attribs['class'] = implode( ' ', $classes );
3193 $textoverride !== null ?
$textoverride : $this->textbox1
,
3199 protected function showTextbox2() {
3200 $this->showTextbox( $this->textbox2
, 'wpTextbox2', [ 'tabindex' => 6, 'readonly' ] );
3203 protected function showTextbox( $text, $name, $customAttribs = [] ) {
3204 global $wgOut, $wgUser;
3206 $wikitext = $this->safeUnicodeOutput( $text );
3207 if ( strval( $wikitext ) !== '' ) {
3208 // Ensure there's a newline at the end, otherwise adding lines
3210 // But don't add a newline if the ext is empty, or Firefox in XHTML
3211 // mode will show an extra newline. A bit annoying.
3215 $attribs = $customAttribs +
[
3218 'cols' => $wgUser->getIntOption( 'cols' ),
3219 'rows' => $wgUser->getIntOption( 'rows' ),
3220 // Avoid PHP notices when appending preferences
3221 // (appending allows customAttribs['style'] to still work).
3225 $pageLang = $this->mTitle
->getPageLanguage();
3226 $attribs['lang'] = $pageLang->getHtmlCode();
3227 $attribs['dir'] = $pageLang->getDir();
3229 $wgOut->addHTML( Html
::textarea( $name, $wikitext, $attribs ) );
3232 protected function displayPreviewArea( $previewOutput, $isOnTop = false ) {
3236 $classes[] = 'ontop';
3239 $attribs = [ 'id' => 'wikiPreview', 'class' => implode( ' ', $classes ) ];
3241 if ( $this->formtype
!= 'preview' ) {
3242 $attribs['style'] = 'display: none;';
3245 $wgOut->addHTML( Xml
::openElement( 'div', $attribs ) );
3247 if ( $this->formtype
== 'preview' ) {
3248 $this->showPreview( $previewOutput );
3250 // Empty content container for LivePreview
3251 $pageViewLang = $this->mTitle
->getPageViewLanguage();
3252 $attribs = [ 'lang' => $pageViewLang->getHtmlCode(), 'dir' => $pageViewLang->getDir(),
3253 'class' => 'mw-content-' . $pageViewLang->getDir() ];
3254 $wgOut->addHTML( Html
::rawElement( 'div', $attribs ) );
3257 $wgOut->addHTML( '</div>' );
3259 if ( $this->formtype
== 'diff' ) {
3262 } catch ( MWContentSerializationException
$ex ) {
3264 'content-failed-to-parse',
3265 $this->contentModel
,
3266 $this->contentFormat
,
3269 $wgOut->addWikiText( '<div class="error">' . $msg->text() . '</div>' );
3275 * Append preview output to $wgOut.
3276 * Includes category rendering if this is a category page.
3278 * @param string $text The HTML to be output for the preview.
3280 protected function showPreview( $text ) {
3282 if ( $this->mTitle
->getNamespace() == NS_CATEGORY
) {
3283 $this->mArticle
->openShowCategory();
3285 # This hook seems slightly odd here, but makes things more
3286 # consistent for extensions.
3287 Hooks
::run( 'OutputPageBeforeHTML', [ &$wgOut, &$text ] );
3288 $wgOut->addHTML( $text );
3289 if ( $this->mTitle
->getNamespace() == NS_CATEGORY
) {
3290 $this->mArticle
->closeShowCategory();
3295 * Get a diff between the current contents of the edit box and the
3296 * version of the page we're editing from.
3298 * If this is a section edit, we'll replace the section as for final
3299 * save and then make a comparison.
3301 function showDiff() {
3302 global $wgUser, $wgContLang, $wgOut;
3304 $oldtitlemsg = 'currentrev';
3305 # if message does not exist, show diff against the preloaded default
3306 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
&& !$this->mTitle
->exists() ) {
3307 $oldtext = $this->mTitle
->getDefaultMessageText();
3308 if ( $oldtext !== false ) {
3309 $oldtitlemsg = 'defaultmessagetext';
3310 $oldContent = $this->toEditContent( $oldtext );
3315 $oldContent = $this->getCurrentContent();
3318 $textboxContent = $this->toEditContent( $this->textbox1
);
3319 if ( $this->editRevId
!== null ) {
3320 $newContent = $this->page
->replaceSectionAtRev(
3321 $this->section
, $textboxContent, $this->summary
, $this->editRevId
3324 $newContent = $this->page
->replaceSectionContent(
3325 $this->section
, $textboxContent, $this->summary
, $this->edittime
3329 if ( $newContent ) {
3330 ContentHandler
::runLegacyHooks( 'EditPageGetDiffText', [ $this, &$newContent ] );
3331 Hooks
::run( 'EditPageGetDiffContent', [ $this, &$newContent ] );
3333 $popts = ParserOptions
::newFromUserAndLang( $wgUser, $wgContLang );
3334 $newContent = $newContent->preSaveTransform( $this->mTitle
, $wgUser, $popts );
3337 if ( ( $oldContent && !$oldContent->isEmpty() ) ||
( $newContent && !$newContent->isEmpty() ) ) {
3338 $oldtitle = wfMessage( $oldtitlemsg )->parse();
3339 $newtitle = wfMessage( 'yourtext' )->parse();
3341 if ( !$oldContent ) {
3342 $oldContent = $newContent->getContentHandler()->makeEmptyContent();
3345 if ( !$newContent ) {
3346 $newContent = $oldContent->getContentHandler()->makeEmptyContent();
3349 $de = $oldContent->getContentHandler()->createDifferenceEngine( $this->mArticle
->getContext() );
3350 $de->setContent( $oldContent, $newContent );
3352 $difftext = $de->getDiff( $oldtitle, $newtitle );
3353 $de->showDiffStyle();
3358 $wgOut->addHTML( '<div id="wikiDiff">' . $difftext . '</div>' );
3362 * Show the header copyright warning.
3364 protected function showHeaderCopyrightWarning() {
3365 $msg = 'editpage-head-copy-warn';
3366 if ( !wfMessage( $msg )->isDisabled() ) {
3368 $wgOut->wrapWikiMsg( "<div class='editpage-head-copywarn'>\n$1\n</div>",
3369 'editpage-head-copy-warn' );
3374 * Give a chance for site and per-namespace customizations of
3375 * terms of service summary link that might exist separately
3376 * from the copyright notice.
3378 * This will display between the save button and the edit tools,
3379 * so should remain short!
3381 protected function showTosSummary() {
3382 $msg = 'editpage-tos-summary';
3383 Hooks
::run( 'EditPageTosSummary', [ $this->mTitle
, &$msg ] );
3384 if ( !wfMessage( $msg )->isDisabled() ) {
3386 $wgOut->addHTML( '<div class="mw-tos-summary">' );
3387 $wgOut->addWikiMsg( $msg );
3388 $wgOut->addHTML( '</div>' );
3392 protected function showEditTools() {
3394 $wgOut->addHTML( '<div class="mw-editTools">' .
3395 wfMessage( 'edittools' )->inContentLanguage()->parse() .
3400 * Get the copyright warning
3402 * Renamed to getCopyrightWarning(), old name kept around for backwards compatibility
3405 protected function getCopywarn() {
3406 return self
::getCopyrightWarning( $this->mTitle
);
3410 * Get the copyright warning, by default returns wikitext
3412 * @param Title $title
3413 * @param string $format Output format, valid values are any function of a Message object
3416 public static function getCopyrightWarning( $title, $format = 'plain' ) {
3417 global $wgRightsText;
3418 if ( $wgRightsText ) {
3419 $copywarnMsg = [ 'copyrightwarning',
3420 '[[' . wfMessage( 'copyrightpage' )->inContentLanguage()->text() . ']]',
3423 $copywarnMsg = [ 'copyrightwarning2',
3424 '[[' . wfMessage( 'copyrightpage' )->inContentLanguage()->text() . ']]' ];
3426 // Allow for site and per-namespace customization of contribution/copyright notice.
3427 Hooks
::run( 'EditPageCopyrightWarning', [ $title, &$copywarnMsg ] );
3429 return "<div id=\"editpage-copywarn\">\n" .
3430 call_user_func_array( 'wfMessage', $copywarnMsg )->$format() . "\n</div>";
3434 * Get the Limit report for page previews
3437 * @param ParserOutput $output ParserOutput object from the parse
3438 * @return string HTML
3440 public static function getPreviewLimitReport( $output ) {
3441 if ( !$output ||
!$output->getLimitReportData() ) {
3445 $limitReport = Html
::rawElement( 'div', [ 'class' => 'mw-limitReportExplanation' ],
3446 wfMessage( 'limitreport-title' )->parseAsBlock()
3449 // Show/hide animation doesn't work correctly on a table, so wrap it in a div.
3450 $limitReport .= Html
::openElement( 'div', [ 'class' => 'preview-limit-report-wrapper' ] );
3452 $limitReport .= Html
::openElement( 'table', [
3453 'class' => 'preview-limit-report wikitable'
3455 Html
::openElement( 'tbody' );
3457 foreach ( $output->getLimitReportData() as $key => $value ) {
3458 if ( Hooks
::run( 'ParserLimitReportFormat',
3459 [ $key, &$value, &$limitReport, true, true ]
3461 $keyMsg = wfMessage( $key );
3462 $valueMsg = wfMessage( [ "$key-value-html", "$key-value" ] );
3463 if ( !$valueMsg->exists() ) {
3464 $valueMsg = new RawMessage( '$1' );
3466 if ( !$keyMsg->isDisabled() && !$valueMsg->isDisabled() ) {
3467 $limitReport .= Html
::openElement( 'tr' ) .
3468 Html
::rawElement( 'th', null, $keyMsg->parse() ) .
3469 Html
::rawElement( 'td', null, $valueMsg->params( $value )->parse() ) .
3470 Html
::closeElement( 'tr' );
3475 $limitReport .= Html
::closeElement( 'tbody' ) .
3476 Html
::closeElement( 'table' ) .
3477 Html
::closeElement( 'div' );
3479 return $limitReport;
3482 protected function showStandardInputs( &$tabindex = 2 ) {
3484 $wgOut->addHTML( "<div class='editOptions'>\n" );
3486 if ( $this->section
!= 'new' ) {
3487 $this->showSummaryInput( false, $this->summary
);
3488 $wgOut->addHTML( $this->getSummaryPreview( false, $this->summary
) );
3491 $checkboxes = $this->getCheckboxes( $tabindex,
3492 [ 'minor' => $this->minoredit
, 'watch' => $this->watchthis
] );
3493 $wgOut->addHTML( "<div class='editCheckboxes'>" . implode( $checkboxes, "\n" ) . "</div>\n" );
3495 // Show copyright warning.
3496 $wgOut->addWikiText( $this->getCopywarn() );
3497 $wgOut->addHTML( $this->editFormTextAfterWarn
);
3499 $wgOut->addHTML( "<div class='editButtons'>\n" );
3500 $wgOut->addHTML( implode( $this->getEditButtons( $tabindex ), "\n" ) . "\n" );
3502 $cancel = $this->getCancelLink();
3503 if ( $cancel !== '' ) {
3504 $cancel .= Html
::element( 'span',
3505 [ 'class' => 'mw-editButtons-pipe-separator' ],
3506 wfMessage( 'pipe-separator' )->text() );
3509 $message = wfMessage( 'edithelppage' )->inContentLanguage()->text();
3510 $edithelpurl = Skin
::makeInternalOrExternalUrl( $message );
3512 'target' => 'helpwindow',
3513 'href' => $edithelpurl,
3515 $edithelp = Html
::linkButton( wfMessage( 'edithelp' )->text(),
3516 $attrs, [ 'mw-ui-quiet' ] ) .
3517 wfMessage( 'word-separator' )->escaped() .
3518 wfMessage( 'newwindow' )->parse();
3520 $wgOut->addHTML( " <span class='cancelLink'>{$cancel}</span>\n" );
3521 $wgOut->addHTML( " <span class='editHelp'>{$edithelp}</span>\n" );
3522 $wgOut->addHTML( "</div><!-- editButtons -->\n" );
3524 Hooks
::run( 'EditPage::showStandardInputs:options', [ $this, $wgOut, &$tabindex ] );
3526 $wgOut->addHTML( "</div><!-- editOptions -->\n" );
3530 * Show an edit conflict. textbox1 is already shown in showEditForm().
3531 * If you want to use another entry point to this function, be careful.
3533 protected function showConflict() {
3536 if ( Hooks
::run( 'EditPageBeforeConflictDiff', [ &$this, &$wgOut ] ) ) {
3537 $stats = $wgOut->getContext()->getStats();
3538 $stats->increment( 'edit.failures.conflict' );
3539 // Only include 'standard' namespaces to avoid creating unknown numbers of statsd metrics
3541 $this->mTitle
->getNamespace() >= NS_MAIN
&&
3542 $this->mTitle
->getNamespace() <= NS_CATEGORY_TALK
3544 $stats->increment( 'edit.failures.conflict.byNamespaceId.' . $this->mTitle
->getNamespace() );
3547 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
3549 $content1 = $this->toEditContent( $this->textbox1
);
3550 $content2 = $this->toEditContent( $this->textbox2
);
3552 $handler = ContentHandler
::getForModelID( $this->contentModel
);
3553 $de = $handler->createDifferenceEngine( $this->mArticle
->getContext() );
3554 $de->setContent( $content2, $content1 );
3556 wfMessage( 'yourtext' )->parse(),
3557 wfMessage( 'storedversion' )->text()
3560 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
3561 $this->showTextbox2();
3568 public function getCancelLink() {
3570 if ( !$this->isConflict
&& $this->oldid
> 0 ) {
3571 $cancelParams['oldid'] = $this->oldid
;
3572 } elseif ( $this->getContextTitle()->isRedirect() ) {
3573 $cancelParams['redirect'] = 'no';
3575 $attrs = [ 'id' => 'mw-editform-cancel' ];
3577 return Linker
::linkKnown(
3578 $this->getContextTitle(),
3579 wfMessage( 'cancel' )->parse(),
3580 Html
::buttonAttributes( $attrs, [ 'mw-ui-quiet' ] ),
3586 * Returns the URL to use in the form's action attribute.
3587 * This is used by EditPage subclasses when simply customizing the action
3588 * variable in the constructor is not enough. This can be used when the
3589 * EditPage lives inside of a Special page rather than a custom page action.
3591 * @param Title $title Title object for which is being edited (where we go to for &action= links)
3594 protected function getActionURL( Title
$title ) {
3595 return $title->getLocalURL( [ 'action' => $this->action
] );
3599 * Check if a page was deleted while the user was editing it, before submit.
3600 * Note that we rely on the logging table, which hasn't been always there,
3601 * but that doesn't matter, because this only applies to brand new
3605 protected function wasDeletedSinceLastEdit() {
3606 if ( $this->deletedSinceEdit
!== null ) {
3607 return $this->deletedSinceEdit
;
3610 $this->deletedSinceEdit
= false;
3612 if ( !$this->mTitle
->exists() && $this->mTitle
->isDeletedQuick() ) {
3613 $this->lastDelete
= $this->getLastDelete();
3614 if ( $this->lastDelete
) {
3615 $deleteTime = wfTimestamp( TS_MW
, $this->lastDelete
->log_timestamp
);
3616 if ( $deleteTime > $this->starttime
) {
3617 $this->deletedSinceEdit
= true;
3622 return $this->deletedSinceEdit
;
3626 * @return bool|stdClass
3628 protected function getLastDelete() {
3629 $dbr = wfGetDB( DB_SLAVE
);
3630 $data = $dbr->selectRow(
3631 [ 'logging', 'user' ],
3644 'log_namespace' => $this->mTitle
->getNamespace(),
3645 'log_title' => $this->mTitle
->getDBkey(),
3646 'log_type' => 'delete',
3647 'log_action' => 'delete',
3651 [ 'LIMIT' => 1, 'ORDER BY' => 'log_timestamp DESC' ]
3653 // Quick paranoid permission checks...
3654 if ( is_object( $data ) ) {
3655 if ( $data->log_deleted
& LogPage
::DELETED_USER
) {
3656 $data->user_name
= wfMessage( 'rev-deleted-user' )->escaped();
3659 if ( $data->log_deleted
& LogPage
::DELETED_COMMENT
) {
3660 $data->log_comment
= wfMessage( 'rev-deleted-comment' )->escaped();
3668 * Get the rendered text for previewing.
3669 * @throws MWException
3672 function getPreviewText() {
3673 global $wgOut, $wgRawHtml, $wgLang;
3674 global $wgAllowUserCss, $wgAllowUserJs;
3676 $stats = $wgOut->getContext()->getStats();
3678 if ( $wgRawHtml && !$this->mTokenOk
) {
3679 // Could be an offsite preview attempt. This is very unsafe if
3680 // HTML is enabled, as it could be an attack.
3682 if ( $this->textbox1
!== '' ) {
3683 // Do not put big scary notice, if previewing the empty
3684 // string, which happens when you initially edit
3685 // a category page, due to automatic preview-on-open.
3686 $parsedNote = $wgOut->parse( "<div class='previewnote'>" .
3687 wfMessage( 'session_fail_preview_html' )->text() . "</div>", true, /* interface */true );
3689 $stats->increment( 'edit.failures.session_loss' );
3696 $content = $this->toEditContent( $this->textbox1
);
3700 'AlternateEditPreview',
3701 [ $this, &$content, &$previewHTML, &$this->mParserOutput
] )
3703 return $previewHTML;
3706 # provide a anchor link to the editform
3707 $continueEditing = '<span class="mw-continue-editing">' .
3708 '[[#' . self
::EDITFORM_ID
. '|' . $wgLang->getArrow() . ' ' .
3709 wfMessage( 'continue-editing' )->text() . ']]</span>';
3710 if ( $this->mTriedSave
&& !$this->mTokenOk
) {
3711 if ( $this->mTokenOkExceptSuffix
) {
3712 $note = wfMessage( 'token_suffix_mismatch' )->plain();
3713 $stats->increment( 'edit.failures.bad_token' );
3715 $note = wfMessage( 'session_fail_preview' )->plain();
3716 $stats->increment( 'edit.failures.session_loss' );
3718 } elseif ( $this->incompleteForm
) {
3719 $note = wfMessage( 'edit_form_incomplete' )->plain();
3720 if ( $this->mTriedSave
) {
3721 $stats->increment( 'edit.failures.incomplete_form' );
3724 $note = wfMessage( 'previewnote' )->plain() . ' ' . $continueEditing;
3727 # don't parse non-wikitext pages, show message about preview
3728 if ( $this->mTitle
->isCssJsSubpage() ||
$this->mTitle
->isCssOrJsPage() ) {
3729 if ( $this->mTitle
->isCssJsSubpage() ) {
3731 } elseif ( $this->mTitle
->isCssOrJsPage() ) {
3737 if ( $content->getModel() == CONTENT_MODEL_CSS
) {
3739 if ( $level === 'user' && !$wgAllowUserCss ) {
3742 } elseif ( $content->getModel() == CONTENT_MODEL_JAVASCRIPT
) {
3744 if ( $level === 'user' && !$wgAllowUserJs ) {
3751 # Used messages to make sure grep find them:
3752 # Messages: usercsspreview, userjspreview, sitecsspreview, sitejspreview
3753 if ( $level && $format ) {
3754 $note = "<div id='mw-{$level}{$format}preview'>" .
3755 wfMessage( "{$level}{$format}preview" )->text() .
3756 ' ' . $continueEditing . "</div>";
3760 # If we're adding a comment, we need to show the
3761 # summary as the headline
3762 if ( $this->section
=== "new" && $this->summary
!== "" ) {
3763 $content = $content->addSectionHeader( $this->summary
);
3766 $hook_args = [ $this, &$content ];
3767 ContentHandler
::runLegacyHooks( 'EditPageGetPreviewText', $hook_args );
3768 Hooks
::run( 'EditPageGetPreviewContent', $hook_args );
3770 $parserResult = $this->doPreviewParse( $content );
3771 $parserOutput = $parserResult['parserOutput'];
3772 $previewHTML = $parserResult['html'];
3773 $this->mParserOutput
= $parserOutput;
3774 $wgOut->addParserOutputMetadata( $parserOutput );
3776 if ( count( $parserOutput->getWarnings() ) ) {
3777 $note .= "\n\n" . implode( "\n\n", $parserOutput->getWarnings() );
3780 } catch ( MWContentSerializationException
$ex ) {
3782 'content-failed-to-parse',
3783 $this->contentModel
,
3784 $this->contentFormat
,
3787 $note .= "\n\n" . $m->parse();
3791 if ( $this->isConflict
) {
3792 $conflict = '<h2 id="mw-previewconflict">'
3793 . wfMessage( 'previewconflict' )->escaped() . "</h2>\n";
3795 $conflict = '<hr />';
3798 $previewhead = "<div class='previewnote'>\n" .
3799 '<h2 id="mw-previewheader">' . wfMessage( 'preview' )->escaped() . "</h2>" .
3800 $wgOut->parse( $note, true, /* interface */true ) . $conflict . "</div>\n";
3802 $pageViewLang = $this->mTitle
->getPageViewLanguage();
3803 $attribs = [ 'lang' => $pageViewLang->getHtmlCode(), 'dir' => $pageViewLang->getDir(),
3804 'class' => 'mw-content-' . $pageViewLang->getDir() ];
3805 $previewHTML = Html
::rawElement( 'div', $attribs, $previewHTML );
3807 return $previewhead . $previewHTML . $this->previewTextAfterContent
;
3811 * Get parser options for a preview
3812 * @return ParserOptions
3814 protected function getPreviewParserOptions() {
3815 $parserOptions = $this->page
->makeParserOptions( $this->mArticle
->getContext() );
3816 $parserOptions->setIsPreview( true );
3817 $parserOptions->setIsSectionPreview( !is_null( $this->section
) && $this->section
!== '' );
3818 $parserOptions->enableLimitReport();
3819 return $parserOptions;
3823 * Parse the page for a preview. Subclasses may override this class, in order
3824 * to parse with different options, or to otherwise modify the preview HTML.
3826 * @param Content @content The page content
3827 * @return Associative array with keys:
3828 * - parserOutput: The ParserOutput object
3829 * - html: The HTML to be displayed
3831 protected function doPreviewParse( Content
$content ) {
3833 $parserOptions = $this->getPreviewParserOptions();
3834 $pstContent = $content->preSaveTransform( $this->mTitle
, $wgUser, $parserOptions );
3835 $scopedCallback = $parserOptions->setupFakeRevision(
3836 $this->mTitle
, $pstContent, $wgUser );
3837 $parserOutput = $pstContent->getParserOutput( $this->mTitle
, null, $parserOptions );
3838 ScopedCallback
::consume( $scopedCallback );
3839 $parserOutput->setEditSectionTokens( false ); // no section edit links
3841 'parserOutput' => $parserOutput,
3842 'html' => $parserOutput->getText() ];
3848 function getTemplates() {
3849 if ( $this->preview ||
$this->section
!= '' ) {
3851 if ( !isset( $this->mParserOutput
) ) {
3854 foreach ( $this->mParserOutput
->getTemplates() as $ns => $template ) {
3855 foreach ( array_keys( $template ) as $dbk ) {
3856 $templates[] = Title
::makeTitle( $ns, $dbk );
3861 return $this->mTitle
->getTemplateLinksFrom();
3866 * Shows a bulletin board style toolbar for common editing functions.
3867 * It can be disabled in the user preferences.
3869 * @param Title $title Title object for the page being edited (optional)
3872 static function getEditToolbar( $title = null ) {
3873 global $wgContLang, $wgOut;
3874 global $wgEnableUploads, $wgForeignFileRepos;
3876 $imagesAvailable = $wgEnableUploads ||
count( $wgForeignFileRepos );
3877 $showSignature = true;
3879 $showSignature = MWNamespace
::wantSignatures( $title->getNamespace() );
3883 * $toolarray is an array of arrays each of which includes the
3884 * opening tag, the closing tag, optionally a sample text that is
3885 * inserted between the two when no selection is highlighted
3886 * and. The tip text is shown when the user moves the mouse
3889 * Images are defined in ResourceLoaderEditToolbarModule.
3893 'id' => 'mw-editbutton-bold',
3895 'close' => '\'\'\'',
3896 'sample' => wfMessage( 'bold_sample' )->text(),
3897 'tip' => wfMessage( 'bold_tip' )->text(),
3900 'id' => 'mw-editbutton-italic',
3903 'sample' => wfMessage( 'italic_sample' )->text(),
3904 'tip' => wfMessage( 'italic_tip' )->text(),
3907 'id' => 'mw-editbutton-link',
3910 'sample' => wfMessage( 'link_sample' )->text(),
3911 'tip' => wfMessage( 'link_tip' )->text(),
3914 'id' => 'mw-editbutton-extlink',
3917 'sample' => wfMessage( 'extlink_sample' )->text(),
3918 'tip' => wfMessage( 'extlink_tip' )->text(),
3921 'id' => 'mw-editbutton-headline',
3924 'sample' => wfMessage( 'headline_sample' )->text(),
3925 'tip' => wfMessage( 'headline_tip' )->text(),
3927 $imagesAvailable ?
[
3928 'id' => 'mw-editbutton-image',
3929 'open' => '[[' . $wgContLang->getNsText( NS_FILE
) . ':',
3931 'sample' => wfMessage( 'image_sample' )->text(),
3932 'tip' => wfMessage( 'image_tip' )->text(),
3934 $imagesAvailable ?
[
3935 'id' => 'mw-editbutton-media',
3936 'open' => '[[' . $wgContLang->getNsText( NS_MEDIA
) . ':',
3938 'sample' => wfMessage( 'media_sample' )->text(),
3939 'tip' => wfMessage( 'media_tip' )->text(),
3942 'id' => 'mw-editbutton-nowiki',
3943 'open' => "<nowiki>",
3944 'close' => "</nowiki>",
3945 'sample' => wfMessage( 'nowiki_sample' )->text(),
3946 'tip' => wfMessage( 'nowiki_tip' )->text(),
3949 'id' => 'mw-editbutton-signature',
3950 'open' => wfMessage( 'sig-text', '~~~~' )->inContentLanguage()->text(),
3953 'tip' => wfMessage( 'sig_tip' )->text(),
3956 'id' => 'mw-editbutton-hr',
3957 'open' => "\n----\n",
3960 'tip' => wfMessage( 'hr_tip' )->text(),
3964 $script = 'mw.loader.using("mediawiki.toolbar", function () {';
3965 foreach ( $toolarray as $tool ) {
3971 // Images are defined in ResourceLoaderEditToolbarModule
3973 // Note that we use the tip both for the ALT tag and the TITLE tag of the image.
3974 // Older browsers show a "speedtip" type message only for ALT.
3975 // Ideally these should be different, realistically they
3976 // probably don't need to be.
3984 $script .= Xml
::encodeJsCall(
3985 'mw.toolbar.addButton',
3987 ResourceLoader
::inDebugMode()
3992 $wgOut->addScript( ResourceLoader
::makeInlineScript( $script ) );
3994 $toolbar = '<div id="toolbar"></div>';
3996 Hooks
::run( 'EditPageBeforeEditToolbar', [ &$toolbar ] );
4002 * Returns an array of html code of the following checkboxes:
4005 * @param int $tabindex Current tabindex
4006 * @param array $checked Array of checkbox => bool, where bool indicates the checked
4007 * status of the checkbox
4011 public function getCheckboxes( &$tabindex, $checked ) {
4012 global $wgUser, $wgUseMediaWikiUIEverywhere;
4016 // don't show the minor edit checkbox if it's a new page or section
4017 if ( !$this->isNew
) {
4018 $checkboxes['minor'] = '';
4019 $minorLabel = wfMessage( 'minoredit' )->parse();
4020 if ( $wgUser->isAllowed( 'minoredit' ) ) {
4022 'tabindex' => ++
$tabindex,
4023 'accesskey' => wfMessage( 'accesskey-minoredit' )->text(),
4024 'id' => 'wpMinoredit',
4027 Xml
::check( 'wpMinoredit', $checked['minor'], $attribs ) .
4028 " <label for='wpMinoredit' id='mw-editpage-minoredit'" .
4029 Xml
::expandAttributes( [ 'title' => Linker
::titleAttrib( 'minoredit', 'withaccess' ) ] ) .
4030 ">{$minorLabel}</label>";
4032 if ( $wgUseMediaWikiUIEverywhere ) {
4033 $checkboxes['minor'] = Html
::openElement( 'div', [ 'class' => 'mw-ui-checkbox' ] ) .
4035 Html
::closeElement( 'div' );
4037 $checkboxes['minor'] = $minorEditHtml;
4042 $watchLabel = wfMessage( 'watchthis' )->parse();
4043 $checkboxes['watch'] = '';
4044 if ( $wgUser->isLoggedIn() ) {
4046 'tabindex' => ++
$tabindex,
4047 'accesskey' => wfMessage( 'accesskey-watch' )->text(),
4048 'id' => 'wpWatchthis',
4051 Xml
::check( 'wpWatchthis', $checked['watch'], $attribs ) .
4052 " <label for='wpWatchthis' id='mw-editpage-watch'" .
4053 Xml
::expandAttributes( [ 'title' => Linker
::titleAttrib( 'watch', 'withaccess' ) ] ) .
4054 ">{$watchLabel}</label>";
4055 if ( $wgUseMediaWikiUIEverywhere ) {
4056 $checkboxes['watch'] = Html
::openElement( 'div', [ 'class' => 'mw-ui-checkbox' ] ) .
4058 Html
::closeElement( 'div' );
4060 $checkboxes['watch'] = $watchThisHtml;
4063 Hooks
::run( 'EditPageBeforeEditChecks', [ &$this, &$checkboxes, &$tabindex ] );
4068 * Returns an array of html code of the following buttons:
4069 * save, diff, preview and live
4071 * @param int $tabindex Current tabindex
4075 public function getEditButtons( &$tabindex ) {
4081 'tabindex' => ++
$tabindex,
4082 ] + Linker
::tooltipAndAccesskeyAttribs( 'save' );
4083 $buttons['save'] = Html
::submitButton( wfMessage( 'savearticle' )->text(),
4084 $attribs, [ 'mw-ui-constructive' ] );
4086 ++
$tabindex; // use the same for preview and live preview
4088 'id' => 'wpPreview',
4089 'name' => 'wpPreview',
4090 'tabindex' => $tabindex,
4091 ] + Linker
::tooltipAndAccesskeyAttribs( 'preview' );
4092 $buttons['preview'] = Html
::submitButton( wfMessage( 'showpreview' )->text(),
4094 $buttons['live'] = '';
4099 'tabindex' => ++
$tabindex,
4100 ] + Linker
::tooltipAndAccesskeyAttribs( 'diff' );
4101 $buttons['diff'] = Html
::submitButton( wfMessage( 'showdiff' )->text(),
4104 Hooks
::run( 'EditPageBeforeEditButtons', [ &$this, &$buttons, &$tabindex ] );
4109 * Creates a basic error page which informs the user that
4110 * they have attempted to edit a nonexistent section.
4112 function noSuchSectionPage() {
4115 $wgOut->prepareErrorPage( wfMessage( 'nosuchsectiontitle' ) );
4117 $res = wfMessage( 'nosuchsectiontext', $this->section
)->parseAsBlock();
4118 Hooks
::run( 'EditPageNoSuchSection', [ &$this, &$res ] );
4119 $wgOut->addHTML( $res );
4121 $wgOut->returnToMain( false, $this->mTitle
);
4125 * Show "your edit contains spam" page with your diff and text
4127 * @param string|array|bool $match Text (or array of texts) which triggered one or more filters
4129 public function spamPageWithContent( $match = false ) {
4130 global $wgOut, $wgLang;
4131 $this->textbox2
= $this->textbox1
;
4133 if ( is_array( $match ) ) {
4134 $match = $wgLang->listToText( $match );
4136 $wgOut->prepareErrorPage( wfMessage( 'spamprotectiontitle' ) );
4138 $wgOut->addHTML( '<div id="spamprotected">' );
4139 $wgOut->addWikiMsg( 'spamprotectiontext' );
4141 $wgOut->addWikiMsg( 'spamprotectionmatch', wfEscapeWikiText( $match ) );
4143 $wgOut->addHTML( '</div>' );
4145 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
4148 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
4149 $this->showTextbox2();
4151 $wgOut->addReturnTo( $this->getContextTitle(), [ 'action' => 'edit' ] );
4155 * Check if the browser is on a blacklist of user-agents known to
4156 * mangle UTF-8 data on form submission. Returns true if Unicode
4157 * should make it through, false if it's known to be a problem.
4160 private function checkUnicodeCompliantBrowser() {
4161 global $wgBrowserBlackList, $wgRequest;
4163 $currentbrowser = $wgRequest->getHeader( 'User-Agent' );
4164 if ( $currentbrowser === false ) {
4165 // No User-Agent header sent? Trust it by default...
4169 foreach ( $wgBrowserBlackList as $browser ) {
4170 if ( preg_match( $browser, $currentbrowser ) ) {
4178 * Filter an input field through a Unicode de-armoring process if it
4179 * came from an old browser with known broken Unicode editing issues.
4181 * @param WebRequest $request
4182 * @param string $field
4185 protected function safeUnicodeInput( $request, $field ) {
4186 $text = rtrim( $request->getText( $field ) );
4187 return $request->getBool( 'safemode' )
4188 ?
$this->unmakeSafe( $text )
4193 * Filter an output field through a Unicode armoring process if it is
4194 * going to an old browser with known broken Unicode editing issues.
4196 * @param string $text
4199 protected function safeUnicodeOutput( $text ) {
4200 return $this->checkUnicodeCompliantBrowser()
4202 : $this->makesafe( $text );
4206 * A number of web browsers are known to corrupt non-ASCII characters
4207 * in a UTF-8 text editing environment. To protect against this,
4208 * detected browsers will be served an armored version of the text,
4209 * with non-ASCII chars converted to numeric HTML character references.
4211 * Preexisting such character references will have a 0 added to them
4212 * to ensure that round-trips do not alter the original data.
4214 * @param string $invalue
4217 private function makeSafe( $invalue ) {
4218 // Armor existing references for reversibility.
4219 $invalue = strtr( $invalue, [ "&#x" => "�" ] );
4224 $valueLength = strlen( $invalue );
4225 for ( $i = 0; $i < $valueLength; $i++
) {
4226 $bytevalue = ord( $invalue[$i] );
4227 if ( $bytevalue <= 0x7F ) { // 0xxx xxxx
4228 $result .= chr( $bytevalue );
4230 } elseif ( $bytevalue <= 0xBF ) { // 10xx xxxx
4231 $working = $working << 6;
4232 $working +
= ( $bytevalue & 0x3F );
4234 if ( $bytesleft <= 0 ) {
4235 $result .= "&#x" . strtoupper( dechex( $working ) ) . ";";
4237 } elseif ( $bytevalue <= 0xDF ) { // 110x xxxx
4238 $working = $bytevalue & 0x1F;
4240 } elseif ( $bytevalue <= 0xEF ) { // 1110 xxxx
4241 $working = $bytevalue & 0x0F;
4243 } else { // 1111 0xxx
4244 $working = $bytevalue & 0x07;
4252 * Reverse the previously applied transliteration of non-ASCII characters
4253 * back to UTF-8. Used to protect data from corruption by broken web browsers
4254 * as listed in $wgBrowserBlackList.
4256 * @param string $invalue
4259 private function unmakeSafe( $invalue ) {
4261 $valueLength = strlen( $invalue );
4262 for ( $i = 0; $i < $valueLength; $i++
) {
4263 if ( ( substr( $invalue, $i, 3 ) == "&#x" ) && ( $invalue[$i +
3] != '0' ) ) {
4267 $hexstring .= $invalue[$i];
4269 } while ( ctype_xdigit( $invalue[$i] ) && ( $i < strlen( $invalue ) ) );
4271 // Do some sanity checks. These aren't needed for reversibility,
4272 // but should help keep the breakage down if the editor
4273 // breaks one of the entities whilst editing.
4274 if ( ( substr( $invalue, $i, 1 ) == ";" ) && ( strlen( $hexstring ) <= 6 ) ) {
4275 $codepoint = hexdec( $hexstring );
4276 $result .= UtfNormal\Utils
::codepointToUtf8( $codepoint );
4278 $result .= "&#x" . $hexstring . substr( $invalue, $i, 1 );
4281 $result .= substr( $invalue, $i, 1 );
4284 // reverse the transform that we made for reversibility reasons.
4285 return strtr( $result, [ "�" => "&#x" ] );