3 * User interface for page editing.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 use MediaWiki\Logger\LoggerFactory
;
24 use MediaWiki\MediaWikiServices
;
25 use Wikimedia\ScopedCallback
;
28 * The edit page/HTML interface (split from Article)
29 * The actual database and text munging is still in Article,
30 * but it should get easier to call those from alternate
33 * EditPage cares about two distinct titles:
34 * $this->mContextTitle is the page that forms submit to, links point to,
35 * redirects go to, etc. $this->mTitle (as well as $mArticle) is the
36 * page in the database that is actually being edited. These are
37 * usually the same, but they are now allowed to be different.
39 * Surgeon General's Warning: prolonged exposure to this class is known to cause
40 * headaches, which may be fatal.
44 * Status: Article successfully updated
46 const AS_SUCCESS_UPDATE
= 200;
49 * Status: Article successfully created
51 const AS_SUCCESS_NEW_ARTICLE
= 201;
54 * Status: Article update aborted by a hook function
56 const AS_HOOK_ERROR
= 210;
59 * Status: A hook function returned an error
61 const AS_HOOK_ERROR_EXPECTED
= 212;
64 * Status: User is blocked from editing this page
66 const AS_BLOCKED_PAGE_FOR_USER
= 215;
69 * Status: Content too big (> $wgMaxArticleSize)
71 const AS_CONTENT_TOO_BIG
= 216;
74 * Status: this anonymous user is not allowed to edit this page
76 const AS_READ_ONLY_PAGE_ANON
= 218;
79 * Status: this logged in user is not allowed to edit this page
81 const AS_READ_ONLY_PAGE_LOGGED
= 219;
84 * Status: wiki is in readonly mode (wfReadOnly() == true)
86 const AS_READ_ONLY_PAGE
= 220;
89 * Status: rate limiter for action 'edit' was tripped
91 const AS_RATE_LIMITED
= 221;
94 * Status: article was deleted while editing and param wpRecreate == false or form
97 const AS_ARTICLE_WAS_DELETED
= 222;
100 * Status: user tried to create this page, but is not allowed to do that
101 * ( Title->userCan('create') == false )
103 const AS_NO_CREATE_PERMISSION
= 223;
106 * Status: user tried to create a blank page and wpIgnoreBlankArticle == false
108 const AS_BLANK_ARTICLE
= 224;
111 * Status: (non-resolvable) edit conflict
113 const AS_CONFLICT_DETECTED
= 225;
116 * Status: no edit summary given and the user has forceeditsummary set and the user is not
117 * editing in his own userspace or talkspace and wpIgnoreBlankSummary == false
119 const AS_SUMMARY_NEEDED
= 226;
122 * Status: user tried to create a new section without content
124 const AS_TEXTBOX_EMPTY
= 228;
127 * Status: article is too big (> $wgMaxArticleSize), after merging in the new section
129 const AS_MAX_ARTICLE_SIZE_EXCEEDED
= 229;
132 * Status: WikiPage::doEdit() was unsuccessful
137 * Status: summary contained spam according to one of the regexes in $wgSummarySpamRegex
139 const AS_SPAM_ERROR
= 232;
142 * Status: anonymous user is not allowed to upload (User::isAllowed('upload') == false)
144 const AS_IMAGE_REDIRECT_ANON
= 233;
147 * Status: logged in user is not allowed to upload (User::isAllowed('upload') == false)
149 const AS_IMAGE_REDIRECT_LOGGED
= 234;
152 * Status: user tried to modify the content model, but is not allowed to do that
153 * ( User::isAllowed('editcontentmodel') == false )
155 const AS_NO_CHANGE_CONTENT_MODEL
= 235;
158 * Status: user tried to create self-redirect (redirect to the same article) and
159 * wpIgnoreSelfRedirect == false
161 const AS_SELF_REDIRECT
= 236;
164 * Status: an error relating to change tagging. Look at the message key for
167 const AS_CHANGE_TAG_ERROR
= 237;
170 * Status: can't parse content
172 const AS_PARSE_ERROR
= 240;
175 * Status: when changing the content model is disallowed due to
176 * $wgContentHandlerUseDB being false
178 const AS_CANNOT_USE_CUSTOM_MODEL
= 241;
181 * HTML id and name for the beginning of the edit form.
183 const EDITFORM_ID
= 'editform';
186 * Prefix of key for cookie used to pass post-edit state.
187 * The revision id edited is added after this
189 const POST_EDIT_COOKIE_KEY_PREFIX
= 'PostEditRevision';
192 * Duration of PostEdit cookie, in seconds.
193 * The cookie will be removed instantly if the JavaScript runs.
195 * Otherwise, though, we don't want the cookies to accumulate.
196 * RFC 2109 ( https://www.ietf.org/rfc/rfc2109.txt ) specifies a possible
197 * limit of only 20 cookies per domain. This still applies at least to some
198 * versions of IE without full updates:
199 * https://blogs.msdn.com/b/ieinternals/archive/2009/08/20/wininet-ie-cookie-internals-faq.aspx
201 * A value of 20 minutes should be enough to take into account slow loads and minor
202 * clock skew while still avoiding cookie accumulation when JavaScript is turned off.
204 const POST_EDIT_COOKIE_DURATION
= 1200;
214 /** @var null|Title */
215 private $mContextTitle = null;
218 public $action = 'submit';
221 public $isConflict = false;
224 public $isCssJsSubpage = false;
227 public $isCssSubpage = false;
230 public $isJsSubpage = false;
233 public $isWrongCaseCssJsPage = false;
235 /** @var bool New page or new section */
236 public $isNew = false;
239 public $deletedSinceEdit;
247 /** @var bool|stdClass */
251 public $mTokenOk = false;
254 public $mTokenOkExceptSuffix = false;
257 public $mTriedSave = false;
260 public $incompleteForm = false;
263 public $tooBig = false;
266 public $missingComment = false;
269 public $missingSummary = false;
272 public $allowBlankSummary = false;
275 protected $blankArticle = false;
278 protected $allowBlankArticle = false;
281 protected $selfRedirect = false;
284 protected $allowSelfRedirect = false;
287 public $autoSumm = '';
290 public $hookError = '';
292 /** @var ParserOutput */
293 public $mParserOutput;
295 /** @var bool Has a summary been preset using GET parameter &summary= ? */
296 public $hasPresetSummary = false;
299 public $mBaseRevision = false;
302 public $mShowSummaryField = true;
307 public $save = false;
310 public $preview = false;
313 public $diff = false;
316 public $minoredit = false;
319 public $watchthis = false;
322 public $recreate = false;
325 public $textbox1 = '';
328 public $textbox2 = '';
331 public $summary = '';
334 public $nosummary = false;
337 public $edittime = '';
340 private $editRevId = null;
343 public $section = '';
346 public $sectiontitle = '';
349 public $starttime = '';
355 public $parentRevId = 0;
358 public $editintro = '';
361 public $scrolltop = null;
366 /** @var null|string */
367 public $contentModel = null;
369 /** @var null|string */
370 public $contentFormat = null;
372 /** @var null|array */
373 private $changeTags = null;
375 # Placeholders for text injection by hooks (must be HTML)
376 # extensions should take care to _append_ to the present value
378 /** @var string Before even the preview */
379 public $editFormPageTop = '';
380 public $editFormTextTop = '';
381 public $editFormTextBeforeContent = '';
382 public $editFormTextAfterWarn = '';
383 public $editFormTextAfterTools = '';
384 public $editFormTextBottom = '';
385 public $editFormTextAfterContent = '';
386 public $previewTextAfterContent = '';
387 public $mPreloadContent = null;
389 /* $didSave should be set to true whenever an article was successfully altered. */
390 public $didSave = false;
391 public $undidRev = 0;
393 public $suppressIntro = false;
399 protected $contentLength = false;
402 * @var bool Set in ApiEditPage, based on ContentHandler::allowsDirectApiEditing
404 private $enableApiEditOverride = false;
407 * @var IContextSource
412 * @var bool Whether an old revision is edited
414 private $isOldRev = false;
417 * @param Article $article
419 public function __construct( Article
$article ) {
420 $this->mArticle
= $article;
421 $this->page
= $article->getPage(); // model object
422 $this->mTitle
= $article->getTitle();
423 $this->context
= $article->getContext();
425 $this->contentModel
= $this->mTitle
->getContentModel();
427 $handler = ContentHandler
::getForModelID( $this->contentModel
);
428 $this->contentFormat
= $handler->getDefaultFormat();
434 public function getArticle() {
435 return $this->mArticle
;
440 * @return IContextSource
442 public function getContext() {
443 return $this->context
;
450 public function getTitle() {
451 return $this->mTitle
;
455 * Set the context Title object
457 * @param Title|null $title Title object or null
459 public function setContextTitle( $title ) {
460 $this->mContextTitle
= $title;
464 * Get the context title object.
465 * If not set, $wgTitle will be returned. This behavior might change in
466 * the future to return $this->mTitle instead.
470 public function getContextTitle() {
471 if ( is_null( $this->mContextTitle
) ) {
475 return $this->mContextTitle
;
480 * Returns if the given content model is editable.
482 * @param string $modelId The ID of the content model to test. Use CONTENT_MODEL_XXX constants.
484 * @throws MWException If $modelId has no known handler
486 public function isSupportedContentModel( $modelId ) {
487 return $this->enableApiEditOverride
=== true ||
488 ContentHandler
::getForModelID( $modelId )->supportsDirectEditing();
492 * Allow editing of content that supports API direct editing, but not general
493 * direct editing. Set to false by default.
495 * @param bool $enableOverride
497 public function setApiEditOverride( $enableOverride ) {
498 $this->enableApiEditOverride
= $enableOverride;
506 * This is the function that gets called for "action=edit". It
507 * sets up various member variables, then passes execution to
508 * another function, usually showEditForm()
510 * The edit form is self-submitting, so that when things like
511 * preview and edit conflicts occur, we get the same form back
512 * with the extra stuff added. Only when the final submission
513 * is made and all is well do we actually save and redirect to
514 * the newly-edited page.
517 global $wgOut, $wgRequest, $wgUser;
518 // Allow extensions to modify/prevent this form or submission
519 if ( !Hooks
::run( 'AlternateEdit', [ $this ] ) ) {
523 wfDebug( __METHOD__
. ": enter\n" );
525 // If they used redlink=1 and the page exists, redirect to the main article
526 if ( $wgRequest->getBool( 'redlink' ) && $this->mTitle
->exists() ) {
527 $wgOut->redirect( $this->mTitle
->getFullURL() );
531 $this->importFormData( $wgRequest );
532 $this->firsttime
= false;
534 if ( wfReadOnly() && $this->save
) {
537 $this->preview
= true;
541 $this->formtype
= 'save';
542 } elseif ( $this->preview
) {
543 $this->formtype
= 'preview';
544 } elseif ( $this->diff
) {
545 $this->formtype
= 'diff';
546 } else { # First time through
547 $this->firsttime
= true;
548 if ( $this->previewOnOpen() ) {
549 $this->formtype
= 'preview';
551 $this->formtype
= 'initial';
555 $permErrors = $this->getEditPermissionErrors( $this->save ?
'secure' : 'full' );
557 wfDebug( __METHOD__
. ": User can't edit\n" );
558 // Auto-block user's IP if the account was "hard" blocked
559 if ( !wfReadOnly() ) {
561 DeferredUpdates
::addCallableUpdate( function () use ( $user ) {
562 $user->spreadAnyEditBlock();
565 $this->displayPermissionsError( $permErrors );
570 $revision = $this->mArticle
->getRevisionFetched();
571 // Disallow editing revisions with content models different from the current one
572 // Undo edits being an exception in order to allow reverting content model changes.
574 && $revision->getContentModel() !== $this->contentModel
577 if ( $this->undidRev
) {
578 $undidRevObj = Revision
::newFromId( $this->undidRev
);
579 $prevRev = $undidRevObj ?
$undidRevObj->getPrevious() : null;
581 if ( !$this->undidRev
583 ||
$prevRev->getContentModel() !== $this->contentModel
585 $this->displayViewSourcePage(
586 $this->getContentObject(),
588 'contentmodelediterror',
589 $revision->getContentModel(),
597 $this->isConflict
= false;
598 // css / js subpages of user pages get a special treatment
599 $this->isCssJsSubpage
= $this->mTitle
->isCssJsSubpage();
600 $this->isCssSubpage
= $this->mTitle
->isCssSubpage();
601 $this->isJsSubpage
= $this->mTitle
->isJsSubpage();
602 // @todo FIXME: Silly assignment.
603 $this->isWrongCaseCssJsPage
= $this->isWrongCaseCssJsPage();
605 # Show applicable editing introductions
606 if ( $this->formtype
== 'initial' ||
$this->firsttime
) {
610 # Attempt submission here. This will check for edit conflicts,
611 # and redundantly check for locked database, blocked IPs, etc.
612 # that edit() already checked just in case someone tries to sneak
613 # in the back door with a hand-edited submission URL.
615 if ( 'save' == $this->formtype
) {
616 $resultDetails = null;
617 $status = $this->attemptSave( $resultDetails );
618 if ( !$this->handleStatus( $status, $resultDetails ) ) {
623 # First time through: get contents, set time for conflict
625 if ( 'initial' == $this->formtype ||
$this->firsttime
) {
626 if ( $this->initialiseForm() === false ) {
627 $this->noSuchSectionPage();
631 if ( !$this->mTitle
->getArticleID() ) {
632 Hooks
::run( 'EditFormPreloadText', [ &$this->textbox1
, &$this->mTitle
] );
634 Hooks
::run( 'EditFormInitialText', [ $this ] );
639 $this->showEditForm();
643 * @param string $rigor Same format as Title::getUserPermissionErrors()
646 protected function getEditPermissionErrors( $rigor = 'secure' ) {
649 $permErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $wgUser, $rigor );
650 # Can this title be created?
651 if ( !$this->mTitle
->exists() ) {
652 $permErrors = array_merge(
655 $this->mTitle
->getUserPermissionsErrors( 'create', $wgUser, $rigor ),
660 # Ignore some permissions errors when a user is just previewing/viewing diffs
662 foreach ( $permErrors as $error ) {
663 if ( ( $this->preview ||
$this->diff
)
664 && ( $error[0] == 'blockedtext' ||
$error[0] == 'autoblockedtext' )
669 $permErrors = wfArrayDiff2( $permErrors, $remove );
675 * Display a permissions error page, like OutputPage::showPermissionsErrorPage(),
676 * but with the following differences:
677 * - If redlink=1, the user will be redirected to the page
678 * - If there is content to display or the error occurs while either saving,
679 * previewing or showing the difference, it will be a
680 * "View source for ..." page displaying the source code after the error message.
683 * @param array $permErrors Array of permissions errors, as returned by
684 * Title::getUserPermissionsErrors().
685 * @throws PermissionsError
687 protected function displayPermissionsError( array $permErrors ) {
688 global $wgRequest, $wgOut;
690 if ( $wgRequest->getBool( 'redlink' ) ) {
691 // The edit page was reached via a red link.
692 // Redirect to the article page and let them click the edit tab if
693 // they really want a permission error.
694 $wgOut->redirect( $this->mTitle
->getFullURL() );
698 $content = $this->getContentObject();
700 # Use the normal message if there's nothing to display
701 if ( $this->firsttime
&& ( !$content ||
$content->isEmpty() ) ) {
702 $action = $this->mTitle
->exists() ?
'edit' :
703 ( $this->mTitle
->isTalkPage() ?
'createtalk' : 'createpage' );
704 throw new PermissionsError( $action, $permErrors );
707 $this->displayViewSourcePage(
709 $wgOut->formatPermissionsErrorMessage( $permErrors, 'edit' )
714 * Display a read-only View Source page
715 * @param Content $content content object
716 * @param string $errorMessage additional wikitext error message to display
718 protected function displayViewSourcePage( Content
$content, $errorMessage = '' ) {
721 Hooks
::run( 'EditPage::showReadOnlyForm:initial', [ $this, &$wgOut ] );
723 $wgOut->setRobotPolicy( 'noindex,nofollow' );
724 $wgOut->setPageTitle( $this->context
->msg(
726 $this->getContextTitle()->getPrefixedText()
728 $wgOut->addBacklinkSubtitle( $this->getContextTitle() );
729 $wgOut->addHTML( $this->editFormPageTop
);
730 $wgOut->addHTML( $this->editFormTextTop
);
732 if ( $errorMessage !== '' ) {
733 $wgOut->addWikiText( $errorMessage );
734 $wgOut->addHTML( "<hr />\n" );
737 # If the user made changes, preserve them when showing the markup
738 # (This happens when a user is blocked during edit, for instance)
739 if ( !$this->firsttime
) {
740 $text = $this->textbox1
;
741 $wgOut->addWikiMsg( 'viewyourtext' );
744 $text = $this->toEditText( $content );
745 } catch ( MWException
$e ) {
746 # Serialize using the default format if the content model is not supported
747 # (e.g. for an old revision with a different model)
748 $text = $content->serialize();
750 $wgOut->addWikiMsg( 'viewsourcetext' );
753 $wgOut->addHTML( $this->editFormTextBeforeContent
);
754 $this->showTextbox( $text, 'wpTextbox1', [ 'readonly' ] );
755 $wgOut->addHTML( $this->editFormTextAfterContent
);
757 $wgOut->addHTML( $this->makeTemplatesOnThisPageList( $this->getTemplates() ) );
759 $wgOut->addModules( 'mediawiki.action.edit.collapsibleFooter' );
761 $wgOut->addHTML( $this->editFormTextBottom
);
762 if ( $this->mTitle
->exists() ) {
763 $wgOut->returnToMain( null, $this->mTitle
);
768 * Should we show a preview when the edit form is first shown?
772 protected function previewOnOpen() {
773 global $wgRequest, $wgUser, $wgPreviewOnOpenNamespaces;
774 if ( $wgRequest->getVal( 'preview' ) == 'yes' ) {
775 // Explicit override from request
777 } elseif ( $wgRequest->getVal( 'preview' ) == 'no' ) {
778 // Explicit override from request
780 } elseif ( $this->section
== 'new' ) {
781 // Nothing *to* preview for new sections
783 } elseif ( ( $wgRequest->getVal( 'preload' ) !== null ||
$this->mTitle
->exists() )
784 && $wgUser->getOption( 'previewonfirst' )
786 // Standard preference behavior
788 } elseif ( !$this->mTitle
->exists()
789 && isset( $wgPreviewOnOpenNamespaces[$this->mTitle
->getNamespace()] )
790 && $wgPreviewOnOpenNamespaces[$this->mTitle
->getNamespace()]
792 // Categories are special
800 * Checks whether the user entered a skin name in uppercase,
801 * e.g. "User:Example/Monobook.css" instead of "monobook.css"
805 protected function isWrongCaseCssJsPage() {
806 if ( $this->mTitle
->isCssJsSubpage() ) {
807 $name = $this->mTitle
->getSkinFromCssJsSubpage();
808 $skins = array_merge(
809 array_keys( Skin
::getSkinNames() ),
812 return !in_array( $name, $skins )
813 && in_array( strtolower( $name ), $skins );
820 * Returns whether section editing is supported for the current page.
821 * Subclasses may override this to replace the default behavior, which is
822 * to check ContentHandler::supportsSections.
824 * @return bool True if this edit page supports sections, false otherwise.
826 protected function isSectionEditSupported() {
827 $contentHandler = ContentHandler
::getForTitle( $this->mTitle
);
828 return $contentHandler->supportsSections();
832 * This function collects the form data and uses it to populate various member variables.
833 * @param WebRequest $request
834 * @throws ErrorPageError
836 function importFormData( &$request ) {
837 global $wgContLang, $wgUser;
839 # Section edit can come from either the form or a link
840 $this->section
= $request->getVal( 'wpSection', $request->getVal( 'section' ) );
842 if ( $this->section
!== null && $this->section
!== '' && !$this->isSectionEditSupported() ) {
843 throw new ErrorPageError( 'sectioneditnotsupported-title', 'sectioneditnotsupported-text' );
846 $this->isNew
= !$this->mTitle
->exists() ||
$this->section
== 'new';
848 if ( $request->wasPosted() ) {
849 # These fields need to be checked for encoding.
850 # Also remove trailing whitespace, but don't remove _initial_
851 # whitespace from the text boxes. This may be significant formatting.
852 $this->textbox1
= $this->safeUnicodeInput( $request, 'wpTextbox1' );
853 if ( !$request->getCheck( 'wpTextbox2' ) ) {
854 // Skip this if wpTextbox2 has input, it indicates that we came
855 // from a conflict page with raw page text, not a custom form
856 // modified by subclasses
857 $textbox1 = $this->importContentFormData( $request );
858 if ( $textbox1 !== null ) {
859 $this->textbox1
= $textbox1;
863 # Truncate for whole multibyte characters
864 $this->summary
= $wgContLang->truncate( $request->getText( 'wpSummary' ), 255 );
866 # If the summary consists of a heading, e.g. '==Foobar==', extract the title from the
867 # header syntax, e.g. 'Foobar'. This is mainly an issue when we are using wpSummary for
869 $this->summary
= preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->summary
);
871 # Treat sectiontitle the same way as summary.
872 # Note that wpSectionTitle is not yet a part of the actual edit form, as wpSummary is
873 # currently doing double duty as both edit summary and section title. Right now this
874 # is just to allow API edits to work around this limitation, but this should be
875 # incorporated into the actual edit form when EditPage is rewritten (Bugs 18654, 26312).
876 $this->sectiontitle
= $wgContLang->truncate( $request->getText( 'wpSectionTitle' ), 255 );
877 $this->sectiontitle
= preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->sectiontitle
);
879 $this->edittime
= $request->getVal( 'wpEdittime' );
880 $this->editRevId
= $request->getIntOrNull( 'editRevId' );
881 $this->starttime
= $request->getVal( 'wpStarttime' );
883 $undidRev = $request->getInt( 'wpUndidRevision' );
885 $this->undidRev
= $undidRev;
888 $this->scrolltop
= $request->getIntOrNull( 'wpScrolltop' );
890 if ( $this->textbox1
=== '' && $request->getVal( 'wpTextbox1' ) === null ) {
891 // wpTextbox1 field is missing, possibly due to being "too big"
892 // according to some filter rules such as Suhosin's setting for
893 // suhosin.request.max_value_length (d'oh)
894 $this->incompleteForm
= true;
896 // If we receive the last parameter of the request, we can fairly
897 // claim the POST request has not been truncated.
899 // TODO: softened the check for cutover. Once we determine
900 // that it is safe, we should complete the transition by
901 // removing the "edittime" clause.
902 $this->incompleteForm
= ( !$request->getVal( 'wpUltimateParam' )
903 && is_null( $this->edittime
) );
905 if ( $this->incompleteForm
) {
906 # If the form is incomplete, force to preview.
907 wfDebug( __METHOD__
. ": Form data appears to be incomplete\n" );
908 wfDebug( "POST DATA: " . var_export( $_POST, true ) . "\n" );
909 $this->preview
= true;
911 $this->preview
= $request->getCheck( 'wpPreview' );
912 $this->diff
= $request->getCheck( 'wpDiff' );
914 // Remember whether a save was requested, so we can indicate
915 // if we forced preview due to session failure.
916 $this->mTriedSave
= !$this->preview
;
918 if ( $this->tokenOk( $request ) ) {
919 # Some browsers will not report any submit button
920 # if the user hits enter in the comment box.
921 # The unmarked state will be assumed to be a save,
922 # if the form seems otherwise complete.
923 wfDebug( __METHOD__
. ": Passed token check.\n" );
924 } elseif ( $this->diff
) {
925 # Failed token check, but only requested "Show Changes".
926 wfDebug( __METHOD__
. ": Failed token check; Show Changes requested.\n" );
928 # Page might be a hack attempt posted from
929 # an external site. Preview instead of saving.
930 wfDebug( __METHOD__
. ": Failed token check; forcing preview\n" );
931 $this->preview
= true;
934 $this->save
= !$this->preview
&& !$this->diff
;
935 if ( !preg_match( '/^\d{14}$/', $this->edittime
) ) {
936 $this->edittime
= null;
939 if ( !preg_match( '/^\d{14}$/', $this->starttime
) ) {
940 $this->starttime
= null;
943 $this->recreate
= $request->getCheck( 'wpRecreate' );
945 $this->minoredit
= $request->getCheck( 'wpMinoredit' );
946 $this->watchthis
= $request->getCheck( 'wpWatchthis' );
948 # Don't force edit summaries when a user is editing their own user or talk page
949 if ( ( $this->mTitle
->mNamespace
== NS_USER ||
$this->mTitle
->mNamespace
== NS_USER_TALK
)
950 && $this->mTitle
->getText() == $wgUser->getName()
952 $this->allowBlankSummary
= true;
954 $this->allowBlankSummary
= $request->getBool( 'wpIgnoreBlankSummary' )
955 ||
!$wgUser->getOption( 'forceeditsummary' );
958 $this->autoSumm
= $request->getText( 'wpAutoSummary' );
960 $this->allowBlankArticle
= $request->getBool( 'wpIgnoreBlankArticle' );
961 $this->allowSelfRedirect
= $request->getBool( 'wpIgnoreSelfRedirect' );
963 $changeTags = $request->getVal( 'wpChangeTags' );
964 if ( is_null( $changeTags ) ||
$changeTags === '' ) {
965 $this->changeTags
= [];
967 $this->changeTags
= array_filter( array_map( 'trim', explode( ',',
971 # Not a posted form? Start with nothing.
972 wfDebug( __METHOD__
. ": Not a posted form.\n" );
973 $this->textbox1
= '';
975 $this->sectiontitle
= '';
976 $this->edittime
= '';
977 $this->editRevId
= null;
978 $this->starttime
= wfTimestampNow();
980 $this->preview
= false;
983 $this->minoredit
= false;
984 // Watch may be overridden by request parameters
985 $this->watchthis
= $request->getBool( 'watchthis', false );
986 $this->recreate
= false;
988 // When creating a new section, we can preload a section title by passing it as the
989 // preloadtitle parameter in the URL (Bug 13100)
990 if ( $this->section
== 'new' && $request->getVal( 'preloadtitle' ) ) {
991 $this->sectiontitle
= $request->getVal( 'preloadtitle' );
992 // Once wpSummary isn't being use for setting section titles, we should delete this.
993 $this->summary
= $request->getVal( 'preloadtitle' );
994 } elseif ( $this->section
!= 'new' && $request->getVal( 'summary' ) ) {
995 $this->summary
= $request->getText( 'summary' );
996 if ( $this->summary
!== '' ) {
997 $this->hasPresetSummary
= true;
1001 if ( $request->getVal( 'minor' ) ) {
1002 $this->minoredit
= true;
1006 $this->oldid
= $request->getInt( 'oldid' );
1007 $this->parentRevId
= $request->getInt( 'parentRevId' );
1009 $this->bot
= $request->getBool( 'bot', true );
1010 $this->nosummary
= $request->getBool( 'nosummary' );
1012 // May be overridden by revision.
1013 $this->contentModel
= $request->getText( 'model', $this->contentModel
);
1014 // May be overridden by revision.
1015 $this->contentFormat
= $request->getText( 'format', $this->contentFormat
);
1018 $handler = ContentHandler
::getForModelID( $this->contentModel
);
1019 } catch ( MWUnknownContentModelException
$e ) {
1020 throw new ErrorPageError(
1021 'editpage-invalidcontentmodel-title',
1022 'editpage-invalidcontentmodel-text',
1023 [ $this->contentModel
]
1027 if ( !$handler->isSupportedFormat( $this->contentFormat
) ) {
1028 throw new ErrorPageError(
1029 'editpage-notsupportedcontentformat-title',
1030 'editpage-notsupportedcontentformat-text',
1031 [ $this->contentFormat
, ContentHandler
::getLocalizedName( $this->contentModel
) ]
1036 * @todo Check if the desired model is allowed in this namespace, and if
1037 * a transition from the page's current model to the new model is
1041 $this->editintro
= $request->getText( 'editintro',
1042 // Custom edit intro for new sections
1043 $this->section
=== 'new' ?
'MediaWiki:addsection-editintro' : '' );
1045 // Allow extensions to modify form data
1046 Hooks
::run( 'EditPage::importFormData', [ $this, $request ] );
1051 * Subpage overridable method for extracting the page content data from the
1052 * posted form to be placed in $this->textbox1, if using customized input
1053 * this method should be overridden and return the page text that will be used
1054 * for saving, preview parsing and so on...
1056 * @param WebRequest $request
1057 * @return string|null
1059 protected function importContentFormData( &$request ) {
1060 return; // Don't do anything, EditPage already extracted wpTextbox1
1064 * Initialise form fields in the object
1065 * Called on the first invocation, e.g. when a user clicks an edit link
1066 * @return bool If the requested section is valid
1068 function initialiseForm() {
1070 $this->edittime
= $this->page
->getTimestamp();
1071 $this->editRevId
= $this->page
->getLatest();
1073 $content = $this->getContentObject( false ); # TODO: track content object?!
1074 if ( $content === false ) {
1077 $this->textbox1
= $this->toEditText( $content );
1079 // activate checkboxes if user wants them to be always active
1080 # Sort out the "watch" checkbox
1081 if ( $wgUser->getOption( 'watchdefault' ) ) {
1083 $this->watchthis
= true;
1084 } elseif ( $wgUser->getOption( 'watchcreations' ) && !$this->mTitle
->exists() ) {
1086 $this->watchthis
= true;
1087 } elseif ( $wgUser->isWatched( $this->mTitle
) ) {
1089 $this->watchthis
= true;
1091 if ( $wgUser->getOption( 'minordefault' ) && !$this->isNew
) {
1092 $this->minoredit
= true;
1094 if ( $this->textbox1
=== false ) {
1101 * @param Content|null $def_content The default value to return
1103 * @return Content|null Content on success, $def_content for invalid sections
1107 protected function getContentObject( $def_content = null ) {
1108 global $wgOut, $wgRequest, $wgUser, $wgContLang;
1112 // For message page not locally set, use the i18n message.
1113 // For other non-existent articles, use preload text if any.
1114 if ( !$this->mTitle
->exists() ||
$this->section
== 'new' ) {
1115 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
&& $this->section
!= 'new' ) {
1116 # If this is a system message, get the default text.
1117 $msg = $this->mTitle
->getDefaultMessageText();
1119 $content = $this->toEditContent( $msg );
1121 if ( $content === false ) {
1122 # If requested, preload some text.
1123 $preload = $wgRequest->getVal( 'preload',
1124 // Custom preload text for new sections
1125 $this->section
=== 'new' ?
'MediaWiki:addsection-preload' : '' );
1126 $params = $wgRequest->getArray( 'preloadparams', [] );
1128 $content = $this->getPreloadedContent( $preload, $params );
1130 // For existing pages, get text based on "undo" or section parameters.
1132 if ( $this->section
!= '' ) {
1133 // Get section edit text (returns $def_text for invalid sections)
1134 $orig = $this->getOriginalContent( $wgUser );
1135 $content = $orig ?
$orig->getSection( $this->section
) : null;
1138 $content = $def_content;
1141 $undoafter = $wgRequest->getInt( 'undoafter' );
1142 $undo = $wgRequest->getInt( 'undo' );
1144 if ( $undo > 0 && $undoafter > 0 ) {
1145 $undorev = Revision
::newFromId( $undo );
1146 $oldrev = Revision
::newFromId( $undoafter );
1148 # Sanity check, make sure it's the right page,
1149 # the revisions exist and they were not deleted.
1150 # Otherwise, $content will be left as-is.
1151 if ( !is_null( $undorev ) && !is_null( $oldrev ) &&
1152 !$undorev->isDeleted( Revision
::DELETED_TEXT
) &&
1153 !$oldrev->isDeleted( Revision
::DELETED_TEXT
)
1155 $content = $this->page
->getUndoContent( $undorev, $oldrev );
1157 if ( $content === false ) {
1158 # Warn the user that something went wrong
1159 $undoMsg = 'failure';
1161 $oldContent = $this->page
->getContent( Revision
::RAW
);
1162 $popts = ParserOptions
::newFromUserAndLang( $wgUser, $wgContLang );
1163 $newContent = $content->preSaveTransform( $this->mTitle
, $wgUser, $popts );
1164 if ( $newContent->getModel() !== $oldContent->getModel() ) {
1165 // The undo may change content
1166 // model if its reverting the top
1167 // edit. This can result in
1168 // mismatched content model/format.
1169 $this->contentModel
= $newContent->getModel();
1170 $this->contentFormat
= $oldrev->getContentFormat();
1173 if ( $newContent->equals( $oldContent ) ) {
1174 # Tell the user that the undo results in no change,
1175 # i.e. the revisions were already undone.
1176 $undoMsg = 'nochange';
1179 # Inform the user of our success and set an automatic edit summary
1180 $undoMsg = 'success';
1182 # If we just undid one rev, use an autosummary
1183 $firstrev = $oldrev->getNext();
1184 if ( $firstrev && $firstrev->getId() == $undo ) {
1185 $userText = $undorev->getUserText();
1186 if ( $userText === '' ) {
1187 $undoSummary = $this->context
->msg(
1188 'undo-summary-username-hidden',
1190 )->inContentLanguage()->text();
1192 $undoSummary = $this->context
->msg(
1196 )->inContentLanguage()->text();
1198 if ( $this->summary
=== '' ) {
1199 $this->summary
= $undoSummary;
1201 $this->summary
= $undoSummary . $this->context
->msg( 'colon-separator' )
1202 ->inContentLanguage()->text() . $this->summary
;
1204 $this->undidRev
= $undo;
1206 $this->formtype
= 'diff';
1210 // Failed basic sanity checks.
1211 // Older revisions may have been removed since the link
1212 // was created, or we may simply have got bogus input.
1216 // Messages: undo-success, undo-failure, undo-norev, undo-nochange
1217 $class = ( $undoMsg == 'success' ?
'' : 'error ' ) . "mw-undo-{$undoMsg}";
1218 $this->editFormPageTop
.= $wgOut->parse( "<div class=\"{$class}\">" .
1219 $this->context
->msg( 'undo-' . $undoMsg )->plain() . '</div>', true, /* interface */true );
1222 if ( $content === false ) {
1223 $content = $this->getOriginalContent( $wgUser );
1232 * Get the content of the wanted revision, without section extraction.
1234 * The result of this function can be used to compare user's input with
1235 * section replaced in its context (using WikiPage::replaceSectionAtRev())
1236 * to the original text of the edit.
1238 * This differs from Article::getContent() that when a missing revision is
1239 * encountered the result will be null and not the
1240 * 'missing-revision' message.
1243 * @param User $user The user to get the revision for
1244 * @return Content|null
1246 private function getOriginalContent( User
$user ) {
1247 if ( $this->section
== 'new' ) {
1248 return $this->getCurrentContent();
1250 $revision = $this->mArticle
->getRevisionFetched();
1251 if ( $revision === null ) {
1252 if ( !$this->contentModel
) {
1253 $this->contentModel
= $this->getTitle()->getContentModel();
1255 $handler = ContentHandler
::getForModelID( $this->contentModel
);
1257 return $handler->makeEmptyContent();
1259 $content = $revision->getContent( Revision
::FOR_THIS_USER
, $user );
1264 * Get the edit's parent revision ID
1266 * The "parent" revision is the ancestor that should be recorded in this
1267 * page's revision history. It is either the revision ID of the in-memory
1268 * article content, or in the case of a 3-way merge in order to rebase
1269 * across a recoverable edit conflict, the ID of the newer revision to
1270 * which we have rebased this page.
1273 * @return int Revision ID
1275 public function getParentRevId() {
1276 if ( $this->parentRevId
) {
1277 return $this->parentRevId
;
1279 return $this->mArticle
->getRevIdFetched();
1284 * Get the current content of the page. This is basically similar to
1285 * WikiPage::getContent( Revision::RAW ) except that when the page doesn't exist an empty
1286 * content object is returned instead of null.
1291 protected function getCurrentContent() {
1292 $rev = $this->page
->getRevision();
1293 $content = $rev ?
$rev->getContent( Revision
::RAW
) : null;
1295 if ( $content === false ||
$content === null ) {
1296 if ( !$this->contentModel
) {
1297 $this->contentModel
= $this->getTitle()->getContentModel();
1299 $handler = ContentHandler
::getForModelID( $this->contentModel
);
1301 return $handler->makeEmptyContent();
1302 } elseif ( !$this->undidRev
) {
1303 // Content models should always be the same since we error
1304 // out if they are different before this point (in ->edit()).
1305 // The exception being, during an undo, the current revision might
1306 // differ from the prior revision.
1307 $logger = LoggerFactory
::getInstance( 'editpage' );
1308 if ( $this->contentModel
!== $rev->getContentModel() ) {
1309 $logger->warning( "Overriding content model from current edit {prev} to {new}", [
1310 'prev' => $this->contentModel
,
1311 'new' => $rev->getContentModel(),
1312 'title' => $this->getTitle()->getPrefixedDBkey(),
1313 'method' => __METHOD__
1315 $this->contentModel
= $rev->getContentModel();
1318 // Given that the content models should match, the current selected
1319 // format should be supported.
1320 if ( !$content->isSupportedFormat( $this->contentFormat
) ) {
1321 $logger->warning( "Current revision content format unsupported. Overriding {prev} to {new}", [
1323 'prev' => $this->contentFormat
,
1324 'new' => $rev->getContentFormat(),
1325 'title' => $this->getTitle()->getPrefixedDBkey(),
1326 'method' => __METHOD__
1328 $this->contentFormat
= $rev->getContentFormat();
1335 * Use this method before edit() to preload some content into the edit box
1337 * @param Content $content
1341 public function setPreloadedContent( Content
$content ) {
1342 $this->mPreloadContent
= $content;
1346 * Get the contents to be preloaded into the box, either set by
1347 * an earlier setPreloadText() or by loading the given page.
1349 * @param string $preload Representing the title to preload from.
1350 * @param array $params Parameters to use (interface-message style) in the preloaded text
1356 protected function getPreloadedContent( $preload, $params = [] ) {
1359 if ( !empty( $this->mPreloadContent
) ) {
1360 return $this->mPreloadContent
;
1363 $handler = ContentHandler
::getForModelID( $this->contentModel
);
1365 if ( $preload === '' ) {
1366 return $handler->makeEmptyContent();
1369 $title = Title
::newFromText( $preload );
1370 # Check for existence to avoid getting MediaWiki:Noarticletext
1371 if ( $title === null ||
!$title->exists() ||
!$title->userCan( 'read', $wgUser ) ) {
1372 // TODO: somehow show a warning to the user!
1373 return $handler->makeEmptyContent();
1376 $page = WikiPage
::factory( $title );
1377 if ( $page->isRedirect() ) {
1378 $title = $page->getRedirectTarget();
1380 if ( $title === null ||
!$title->exists() ||
!$title->userCan( 'read', $wgUser ) ) {
1381 // TODO: somehow show a warning to the user!
1382 return $handler->makeEmptyContent();
1384 $page = WikiPage
::factory( $title );
1387 $parserOptions = ParserOptions
::newFromUser( $wgUser );
1388 $content = $page->getContent( Revision
::RAW
);
1391 // TODO: somehow show a warning to the user!
1392 return $handler->makeEmptyContent();
1395 if ( $content->getModel() !== $handler->getModelID() ) {
1396 $converted = $content->convert( $handler->getModelID() );
1398 if ( !$converted ) {
1399 // TODO: somehow show a warning to the user!
1400 wfDebug( "Attempt to preload incompatible content: " .
1401 "can't convert " . $content->getModel() .
1402 " to " . $handler->getModelID() );
1404 return $handler->makeEmptyContent();
1407 $content = $converted;
1410 return $content->preloadTransform( $title, $parserOptions, $params );
1414 * Make sure the form isn't faking a user's credentials.
1416 * @param WebRequest $request
1420 function tokenOk( &$request ) {
1422 $token = $request->getVal( 'wpEditToken' );
1423 $this->mTokenOk
= $wgUser->matchEditToken( $token );
1424 $this->mTokenOkExceptSuffix
= $wgUser->matchEditTokenNoSuffix( $token );
1425 return $this->mTokenOk
;
1429 * Sets post-edit cookie indicating the user just saved a particular revision.
1431 * This uses a temporary cookie for each revision ID so separate saves will never
1432 * interfere with each other.
1434 * The cookie is deleted in the mediawiki.action.view.postEdit JS module after
1435 * the redirect. It must be clearable by JavaScript code, so it must not be
1436 * marked HttpOnly. The JavaScript code converts the cookie to a wgPostEdit config
1439 * If the variable were set on the server, it would be cached, which is unwanted
1440 * since the post-edit state should only apply to the load right after the save.
1442 * @param int $statusValue The status value (to check for new article status)
1444 protected function setPostEditCookie( $statusValue ) {
1445 $revisionId = $this->page
->getLatest();
1446 $postEditKey = self
::POST_EDIT_COOKIE_KEY_PREFIX
. $revisionId;
1449 if ( $statusValue == self
::AS_SUCCESS_NEW_ARTICLE
) {
1451 } elseif ( $this->oldid
) {
1455 $response = RequestContext
::getMain()->getRequest()->response();
1456 $response->setCookie( $postEditKey, $val, time() + self
::POST_EDIT_COOKIE_DURATION
, [
1457 'httpOnly' => false,
1462 * Attempt submission
1463 * @param array|bool $resultDetails See docs for $result in internalAttemptSave
1464 * @throws UserBlockedError|ReadOnlyError|ThrottledError|PermissionsError
1465 * @return Status The resulting status object.
1467 public function attemptSave( &$resultDetails = false ) {
1470 # Allow bots to exempt some edits from bot flagging
1471 $bot = $wgUser->isAllowed( 'bot' ) && $this->bot
;
1472 $status = $this->internalAttemptSave( $resultDetails, $bot );
1474 Hooks
::run( 'EditPage::attemptSave:after', [ $this, $status, $resultDetails ] );
1480 * Handle status, such as after attempt save
1482 * @param Status $status
1483 * @param array|bool $resultDetails
1485 * @throws ErrorPageError
1486 * @return bool False, if output is done, true if rest of the form should be displayed
1488 private function handleStatus( Status
$status, $resultDetails ) {
1489 global $wgUser, $wgOut;
1492 * @todo FIXME: once the interface for internalAttemptSave() is made
1493 * nicer, this should use the message in $status
1495 if ( $status->value
== self
::AS_SUCCESS_UPDATE
1496 ||
$status->value
== self
::AS_SUCCESS_NEW_ARTICLE
1498 $this->didSave
= true;
1499 if ( !$resultDetails['nullEdit'] ) {
1500 $this->setPostEditCookie( $status->value
);
1504 // "wpExtraQueryRedirect" is a hidden input to modify
1505 // after save URL and is not used by actual edit form
1506 $request = RequestContext
::getMain()->getRequest();
1507 $extraQueryRedirect = $request->getVal( 'wpExtraQueryRedirect' );
1509 switch ( $status->value
) {
1510 case self
::AS_HOOK_ERROR_EXPECTED
:
1511 case self
::AS_CONTENT_TOO_BIG
:
1512 case self
::AS_ARTICLE_WAS_DELETED
:
1513 case self
::AS_CONFLICT_DETECTED
:
1514 case self
::AS_SUMMARY_NEEDED
:
1515 case self
::AS_TEXTBOX_EMPTY
:
1516 case self
::AS_MAX_ARTICLE_SIZE_EXCEEDED
:
1518 case self
::AS_BLANK_ARTICLE
:
1519 case self
::AS_SELF_REDIRECT
:
1522 case self
::AS_HOOK_ERROR
:
1525 case self
::AS_CANNOT_USE_CUSTOM_MODEL
:
1526 case self
::AS_PARSE_ERROR
:
1527 $wgOut->addWikiText( '<div class="error">' . "\n" . $status->getWikiText() . '</div>' );
1530 case self
::AS_SUCCESS_NEW_ARTICLE
:
1531 $query = $resultDetails['redirect'] ?
'redirect=no' : '';
1532 if ( $extraQueryRedirect ) {
1533 if ( $query === '' ) {
1534 $query = $extraQueryRedirect;
1536 $query = $query . '&' . $extraQueryRedirect;
1539 $anchor = isset( $resultDetails['sectionanchor'] ) ?
$resultDetails['sectionanchor'] : '';
1540 $wgOut->redirect( $this->mTitle
->getFullURL( $query ) . $anchor );
1543 case self
::AS_SUCCESS_UPDATE
:
1545 $sectionanchor = $resultDetails['sectionanchor'];
1547 // Give extensions a chance to modify URL query on update
1549 'ArticleUpdateBeforeRedirect',
1550 [ $this->mArticle
, &$sectionanchor, &$extraQuery ]
1553 if ( $resultDetails['redirect'] ) {
1554 if ( $extraQuery == '' ) {
1555 $extraQuery = 'redirect=no';
1557 $extraQuery = 'redirect=no&' . $extraQuery;
1560 if ( $extraQueryRedirect ) {
1561 if ( $extraQuery === '' ) {
1562 $extraQuery = $extraQueryRedirect;
1564 $extraQuery = $extraQuery . '&' . $extraQueryRedirect;
1568 $wgOut->redirect( $this->mTitle
->getFullURL( $extraQuery ) . $sectionanchor );
1571 case self
::AS_SPAM_ERROR
:
1572 $this->spamPageWithContent( $resultDetails['spam'] );
1575 case self
::AS_BLOCKED_PAGE_FOR_USER
:
1576 throw new UserBlockedError( $wgUser->getBlock() );
1578 case self
::AS_IMAGE_REDIRECT_ANON
:
1579 case self
::AS_IMAGE_REDIRECT_LOGGED
:
1580 throw new PermissionsError( 'upload' );
1582 case self
::AS_READ_ONLY_PAGE_ANON
:
1583 case self
::AS_READ_ONLY_PAGE_LOGGED
:
1584 throw new PermissionsError( 'edit' );
1586 case self
::AS_READ_ONLY_PAGE
:
1587 throw new ReadOnlyError
;
1589 case self
::AS_RATE_LIMITED
:
1590 throw new ThrottledError();
1592 case self
::AS_NO_CREATE_PERMISSION
:
1593 $permission = $this->mTitle
->isTalkPage() ?
'createtalk' : 'createpage';
1594 throw new PermissionsError( $permission );
1596 case self
::AS_NO_CHANGE_CONTENT_MODEL
:
1597 throw new PermissionsError( 'editcontentmodel' );
1600 // We don't recognize $status->value. The only way that can happen
1601 // is if an extension hook aborted from inside ArticleSave.
1602 // Render the status object into $this->hookError
1603 // FIXME this sucks, we should just use the Status object throughout
1604 $this->hookError
= '<div class="error">' ."\n" . $status->getWikiText() .
1611 * Run hooks that can filter edits just before they get saved.
1613 * @param Content $content The Content to filter.
1614 * @param Status $status For reporting the outcome to the caller
1615 * @param User $user The user performing the edit
1619 protected function runPostMergeFilters( Content
$content, Status
$status, User
$user ) {
1620 // Run old style post-section-merge edit filter
1621 if ( !ContentHandler
::runLegacyHooks( 'EditFilterMerged',
1622 [ $this, $content, &$this->hookError
, $this->summary
],
1625 # Error messages etc. could be handled within the hook...
1626 $status->fatal( 'hookaborted' );
1627 $status->value
= self
::AS_HOOK_ERROR
;
1629 } elseif ( $this->hookError
!= '' ) {
1630 # ...or the hook could be expecting us to produce an error
1631 $status->fatal( 'hookaborted' );
1632 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1636 // Run new style post-section-merge edit filter
1637 if ( !Hooks
::run( 'EditFilterMergedContent',
1638 [ $this->mArticle
->getContext(), $content, $status, $this->summary
,
1639 $user, $this->minoredit
] )
1641 # Error messages etc. could be handled within the hook...
1642 if ( $status->isGood() ) {
1643 $status->fatal( 'hookaborted' );
1644 // Not setting $this->hookError here is a hack to allow the hook
1645 // to cause a return to the edit page without $this->hookError
1646 // being set. This is used by ConfirmEdit to display a captcha
1647 // without any error message cruft.
1649 $this->hookError
= $this->formatStatusErrors( $status );
1651 // Use the existing $status->value if the hook set it
1652 if ( !$status->value
) {
1653 $status->value
= self
::AS_HOOK_ERROR
;
1656 } elseif ( !$status->isOK() ) {
1657 # ...or the hook could be expecting us to produce an error
1658 // FIXME this sucks, we should just use the Status object throughout
1659 $this->hookError
= $this->formatStatusErrors( $status );
1660 $status->fatal( 'hookaborted' );
1661 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1669 * Wrap status errors in an errorbox for increased visiblity
1671 * @param Status $status
1674 private function formatStatusErrors( Status
$status ) {
1675 $errmsg = $status->getHTML(
1678 $this->context
->getLanguage()
1681 <div class="errorbox">
1689 * Return the summary to be used for a new section.
1691 * @param string $sectionanchor Set to the section anchor text
1694 private function newSectionSummary( &$sectionanchor = null ) {
1697 if ( $this->sectiontitle
!== '' ) {
1698 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $this->sectiontitle
);
1699 // If no edit summary was specified, create one automatically from the section
1700 // title and have it link to the new section. Otherwise, respect the summary as
1702 if ( $this->summary
=== '' ) {
1703 $cleanSectionTitle = $wgParser->stripSectionName( $this->sectiontitle
);
1704 return $this->context
->msg( 'newsectionsummary' )
1705 ->rawParams( $cleanSectionTitle )->inContentLanguage()->text();
1707 } elseif ( $this->summary
!== '' ) {
1708 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $this->summary
);
1709 # This is a new section, so create a link to the new section
1710 # in the revision summary.
1711 $cleanSummary = $wgParser->stripSectionName( $this->summary
);
1712 return $this->context
->msg( 'newsectionsummary' )
1713 ->rawParams( $cleanSummary )->inContentLanguage()->text();
1715 return $this->summary
;
1719 * Attempt submission (no UI)
1721 * @param array $result Array to add statuses to, currently with the
1723 * - spam (string): Spam string from content if any spam is detected by
1725 * - sectionanchor (string): Section anchor for a section save.
1726 * - nullEdit (boolean): Set if doEditContent is OK. True if null edit,
1728 * - redirect (bool): Set if doEditContent is OK. True if resulting
1729 * revision is a redirect.
1730 * @param bool $bot True if edit is being made under the bot right.
1732 * @return Status Status object, possibly with a message, but always with
1733 * one of the AS_* constants in $status->value,
1735 * @todo FIXME: This interface is TERRIBLE, but hard to get rid of due to
1736 * various error display idiosyncrasies. There are also lots of cases
1737 * where error metadata is set in the object and retrieved later instead
1738 * of being returned, e.g. AS_CONTENT_TOO_BIG and
1739 * AS_BLOCKED_PAGE_FOR_USER. All that stuff needs to be cleaned up some
1742 function internalAttemptSave( &$result, $bot = false ) {
1743 global $wgUser, $wgRequest, $wgParser, $wgMaxArticleSize;
1744 global $wgContentHandlerUseDB;
1746 $status = Status
::newGood();
1748 if ( !Hooks
::run( 'EditPage::attemptSave', [ $this ] ) ) {
1749 wfDebug( "Hook 'EditPage::attemptSave' aborted article saving\n" );
1750 $status->fatal( 'hookaborted' );
1751 $status->value
= self
::AS_HOOK_ERROR
;
1755 $spam = $wgRequest->getText( 'wpAntispam' );
1756 if ( $spam !== '' ) {
1759 $wgUser->getName() .
1761 $this->mTitle
->getPrefixedText() .
1762 '" submitted bogus field "' .
1766 $status->fatal( 'spamprotectionmatch', false );
1767 $status->value
= self
::AS_SPAM_ERROR
;
1772 # Construct Content object
1773 $textbox_content = $this->toEditContent( $this->textbox1
);
1774 } catch ( MWContentSerializationException
$ex ) {
1776 'content-failed-to-parse',
1777 $this->contentModel
,
1778 $this->contentFormat
,
1781 $status->value
= self
::AS_PARSE_ERROR
;
1785 # Check image redirect
1786 if ( $this->mTitle
->getNamespace() == NS_FILE
&&
1787 $textbox_content->isRedirect() &&
1788 !$wgUser->isAllowed( 'upload' )
1790 $code = $wgUser->isAnon() ? self
::AS_IMAGE_REDIRECT_ANON
: self
::AS_IMAGE_REDIRECT_LOGGED
;
1791 $status->setResult( false, $code );
1797 $match = self
::matchSummarySpamRegex( $this->summary
);
1798 if ( $match === false && $this->section
== 'new' ) {
1799 # $wgSpamRegex is enforced on this new heading/summary because, unlike
1800 # regular summaries, it is added to the actual wikitext.
1801 if ( $this->sectiontitle
!== '' ) {
1802 # This branch is taken when the API is used with the 'sectiontitle' parameter.
1803 $match = self
::matchSpamRegex( $this->sectiontitle
);
1805 # This branch is taken when the "Add Topic" user interface is used, or the API
1806 # is used with the 'summary' parameter.
1807 $match = self
::matchSpamRegex( $this->summary
);
1810 if ( $match === false ) {
1811 $match = self
::matchSpamRegex( $this->textbox1
);
1813 if ( $match !== false ) {
1814 $result['spam'] = $match;
1815 $ip = $wgRequest->getIP();
1816 $pdbk = $this->mTitle
->getPrefixedDBkey();
1817 $match = str_replace( "\n", '', $match );
1818 wfDebugLog( 'SpamRegex', "$ip spam regex hit [[$pdbk]]: \"$match\"" );
1819 $status->fatal( 'spamprotectionmatch', $match );
1820 $status->value
= self
::AS_SPAM_ERROR
;
1825 [ $this, $this->textbox1
, $this->section
, &$this->hookError
, $this->summary
] )
1827 # Error messages etc. could be handled within the hook...
1828 $status->fatal( 'hookaborted' );
1829 $status->value
= self
::AS_HOOK_ERROR
;
1831 } elseif ( $this->hookError
!= '' ) {
1832 # ...or the hook could be expecting us to produce an error
1833 $status->fatal( 'hookaborted' );
1834 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1838 if ( $wgUser->isBlockedFrom( $this->mTitle
, false ) ) {
1839 // Auto-block user's IP if the account was "hard" blocked
1840 if ( !wfReadOnly() ) {
1841 $wgUser->spreadAnyEditBlock();
1843 # Check block state against master, thus 'false'.
1844 $status->setResult( false, self
::AS_BLOCKED_PAGE_FOR_USER
);
1848 $this->contentLength
= strlen( $this->textbox1
);
1849 if ( $this->contentLength
> $wgMaxArticleSize * 1024 ) {
1850 // Error will be displayed by showEditForm()
1851 $this->tooBig
= true;
1852 $status->setResult( false, self
::AS_CONTENT_TOO_BIG
);
1856 if ( !$wgUser->isAllowed( 'edit' ) ) {
1857 if ( $wgUser->isAnon() ) {
1858 $status->setResult( false, self
::AS_READ_ONLY_PAGE_ANON
);
1861 $status->fatal( 'readonlytext' );
1862 $status->value
= self
::AS_READ_ONLY_PAGE_LOGGED
;
1867 $changingContentModel = false;
1868 if ( $this->contentModel
!== $this->mTitle
->getContentModel() ) {
1869 if ( !$wgContentHandlerUseDB ) {
1870 $status->fatal( 'editpage-cannot-use-custom-model' );
1871 $status->value
= self
::AS_CANNOT_USE_CUSTOM_MODEL
;
1873 } elseif ( !$wgUser->isAllowed( 'editcontentmodel' ) ) {
1874 $status->setResult( false, self
::AS_NO_CHANGE_CONTENT_MODEL
);
1877 // Make sure the user can edit the page under the new content model too
1878 $titleWithNewContentModel = clone $this->mTitle
;
1879 $titleWithNewContentModel->setContentModel( $this->contentModel
);
1880 if ( !$titleWithNewContentModel->userCan( 'editcontentmodel', $wgUser )
1881 ||
!$titleWithNewContentModel->userCan( 'edit', $wgUser )
1883 $status->setResult( false, self
::AS_NO_CHANGE_CONTENT_MODEL
);
1887 $changingContentModel = true;
1888 $oldContentModel = $this->mTitle
->getContentModel();
1891 if ( $this->changeTags
) {
1892 $changeTagsStatus = ChangeTags
::canAddTagsAccompanyingChange(
1893 $this->changeTags
, $wgUser );
1894 if ( !$changeTagsStatus->isOK() ) {
1895 $changeTagsStatus->value
= self
::AS_CHANGE_TAG_ERROR
;
1896 return $changeTagsStatus;
1900 if ( wfReadOnly() ) {
1901 $status->fatal( 'readonlytext' );
1902 $status->value
= self
::AS_READ_ONLY_PAGE
;
1905 if ( $wgUser->pingLimiter() ||
$wgUser->pingLimiter( 'linkpurge', 0 )
1906 ||
( $changingContentModel && $wgUser->pingLimiter( 'editcontentmodel' ) )
1908 $status->fatal( 'actionthrottledtext' );
1909 $status->value
= self
::AS_RATE_LIMITED
;
1913 # If the article has been deleted while editing, don't save it without
1915 if ( $this->wasDeletedSinceLastEdit() && !$this->recreate
) {
1916 $status->setResult( false, self
::AS_ARTICLE_WAS_DELETED
);
1920 # Load the page data from the master. If anything changes in the meantime,
1921 # we detect it by using page_latest like a token in a 1 try compare-and-swap.
1922 $this->page
->loadPageData( 'fromdbmaster' );
1923 $new = !$this->page
->exists();
1926 // Late check for create permission, just in case *PARANOIA*
1927 if ( !$this->mTitle
->userCan( 'create', $wgUser ) ) {
1928 $status->fatal( 'nocreatetext' );
1929 $status->value
= self
::AS_NO_CREATE_PERMISSION
;
1930 wfDebug( __METHOD__
. ": no create permission\n" );
1934 // Don't save a new page if it's blank or if it's a MediaWiki:
1935 // message with content equivalent to default (allow empty pages
1936 // in this case to disable messages, see bug 50124)
1937 $defaultMessageText = $this->mTitle
->getDefaultMessageText();
1938 if ( $this->mTitle
->getNamespace() === NS_MEDIAWIKI
&& $defaultMessageText !== false ) {
1939 $defaultText = $defaultMessageText;
1944 if ( !$this->allowBlankArticle
&& $this->textbox1
=== $defaultText ) {
1945 $this->blankArticle
= true;
1946 $status->fatal( 'blankarticle' );
1947 $status->setResult( false, self
::AS_BLANK_ARTICLE
);
1951 if ( !$this->runPostMergeFilters( $textbox_content, $status, $wgUser ) ) {
1955 $content = $textbox_content;
1957 $result['sectionanchor'] = '';
1958 if ( $this->section
== 'new' ) {
1959 if ( $this->sectiontitle
!== '' ) {
1960 // Insert the section title above the content.
1961 $content = $content->addSectionHeader( $this->sectiontitle
);
1962 } elseif ( $this->summary
!== '' ) {
1963 // Insert the section title above the content.
1964 $content = $content->addSectionHeader( $this->summary
);
1966 $this->summary
= $this->newSectionSummary( $result['sectionanchor'] );
1969 $status->value
= self
::AS_SUCCESS_NEW_ARTICLE
;
1973 # Article exists. Check for edit conflict.
1975 $this->page
->clear(); # Force reload of dates, etc.
1976 $timestamp = $this->page
->getTimestamp();
1977 $latest = $this->page
->getLatest();
1979 wfDebug( "timestamp: {$timestamp}, edittime: {$this->edittime}\n" );
1981 // Check editRevId if set, which handles same-second timestamp collisions
1982 if ( $timestamp != $this->edittime
1983 ||
( $this->editRevId
!== null && $this->editRevId
!= $latest )
1985 $this->isConflict
= true;
1986 if ( $this->section
== 'new' ) {
1987 if ( $this->page
->getUserText() == $wgUser->getName() &&
1988 $this->page
->getComment() == $this->newSectionSummary()
1990 // Probably a duplicate submission of a new comment.
1991 // This can happen when CDN resends a request after
1992 // a timeout but the first one actually went through.
1994 . ": duplicate new section submission; trigger edit conflict!\n" );
1996 // New comment; suppress conflict.
1997 $this->isConflict
= false;
1998 wfDebug( __METHOD__
. ": conflict suppressed; new section\n" );
2000 } elseif ( $this->section
== ''
2001 && Revision
::userWasLastToEdit(
2002 DB_MASTER
, $this->mTitle
->getArticleID(),
2003 $wgUser->getId(), $this->edittime
2006 # Suppress edit conflict with self, except for section edits where merging is required.
2007 wfDebug( __METHOD__
. ": Suppressing edit conflict, same user.\n" );
2008 $this->isConflict
= false;
2012 // If sectiontitle is set, use it, otherwise use the summary as the section title.
2013 if ( $this->sectiontitle
!== '' ) {
2014 $sectionTitle = $this->sectiontitle
;
2016 $sectionTitle = $this->summary
;
2021 if ( $this->isConflict
) {
2023 . ": conflict! getting section '{$this->section}' for time '{$this->edittime}'"
2024 . " (id '{$this->editRevId}') (article time '{$timestamp}')\n" );
2025 // @TODO: replaceSectionAtRev() with base ID (not prior current) for ?oldid=X case
2026 // ...or disable section editing for non-current revisions (not exposed anyway).
2027 if ( $this->editRevId
!== null ) {
2028 $content = $this->page
->replaceSectionAtRev(
2035 $content = $this->page
->replaceSectionContent(
2043 wfDebug( __METHOD__
. ": getting section '{$this->section}'\n" );
2044 $content = $this->page
->replaceSectionContent(
2051 if ( is_null( $content ) ) {
2052 wfDebug( __METHOD__
. ": activating conflict; section replace failed.\n" );
2053 $this->isConflict
= true;
2054 $content = $textbox_content; // do not try to merge here!
2055 } elseif ( $this->isConflict
) {
2057 if ( $this->mergeChangesIntoContent( $content ) ) {
2058 // Successful merge! Maybe we should tell the user the good news?
2059 $this->isConflict
= false;
2060 wfDebug( __METHOD__
. ": Suppressing edit conflict, successful merge.\n" );
2062 $this->section
= '';
2063 $this->textbox1
= ContentHandler
::getContentText( $content );
2064 wfDebug( __METHOD__
. ": Keeping edit conflict, failed merge.\n" );
2068 if ( $this->isConflict
) {
2069 $status->setResult( false, self
::AS_CONFLICT_DETECTED
);
2073 if ( !$this->runPostMergeFilters( $content, $status, $wgUser ) ) {
2077 if ( $this->section
== 'new' ) {
2078 // Handle the user preference to force summaries here
2079 if ( !$this->allowBlankSummary
&& trim( $this->summary
) == '' ) {
2080 $this->missingSummary
= true;
2081 $status->fatal( 'missingsummary' ); // or 'missingcommentheader' if $section == 'new'. Blegh
2082 $status->value
= self
::AS_SUMMARY_NEEDED
;
2086 // Do not allow the user to post an empty comment
2087 if ( $this->textbox1
== '' ) {
2088 $this->missingComment
= true;
2089 $status->fatal( 'missingcommenttext' );
2090 $status->value
= self
::AS_TEXTBOX_EMPTY
;
2093 } elseif ( !$this->allowBlankSummary
2094 && !$content->equals( $this->getOriginalContent( $wgUser ) )
2095 && !$content->isRedirect()
2096 && md5( $this->summary
) == $this->autoSumm
2098 $this->missingSummary
= true;
2099 $status->fatal( 'missingsummary' );
2100 $status->value
= self
::AS_SUMMARY_NEEDED
;
2105 $sectionanchor = '';
2106 if ( $this->section
== 'new' ) {
2107 $this->summary
= $this->newSectionSummary( $sectionanchor );
2108 } elseif ( $this->section
!= '' ) {
2109 # Try to get a section anchor from the section source, redirect
2110 # to edited section if header found.
2111 # XXX: Might be better to integrate this into Article::replaceSectionAtRev
2112 # for duplicate heading checking and maybe parsing.
2113 $hasmatch = preg_match( "/^ *([=]{1,6})(.*?)(\\1) *\\n/i", $this->textbox1
, $matches );
2114 # We can't deal with anchors, includes, html etc in the header for now,
2115 # headline would need to be parsed to improve this.
2116 if ( $hasmatch && strlen( $matches[2] ) > 0 ) {
2117 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $matches[2] );
2120 $result['sectionanchor'] = $sectionanchor;
2122 // Save errors may fall down to the edit form, but we've now
2123 // merged the section into full text. Clear the section field
2124 // so that later submission of conflict forms won't try to
2125 // replace that into a duplicated mess.
2126 $this->textbox1
= $this->toEditText( $content );
2127 $this->section
= '';
2129 $status->value
= self
::AS_SUCCESS_UPDATE
;
2132 if ( !$this->allowSelfRedirect
2133 && $content->isRedirect()
2134 && $content->getRedirectTarget()->equals( $this->getTitle() )
2136 // If the page already redirects to itself, don't warn.
2137 $currentTarget = $this->getCurrentContent()->getRedirectTarget();
2138 if ( !$currentTarget ||
!$currentTarget->equals( $this->getTitle() ) ) {
2139 $this->selfRedirect
= true;
2140 $status->fatal( 'selfredirect' );
2141 $status->value
= self
::AS_SELF_REDIRECT
;
2146 // Check for length errors again now that the section is merged in
2147 $this->contentLength
= strlen( $this->toEditText( $content ) );
2148 if ( $this->contentLength
> $wgMaxArticleSize * 1024 ) {
2149 $this->tooBig
= true;
2150 $status->setResult( false, self
::AS_MAX_ARTICLE_SIZE_EXCEEDED
);
2154 $flags = EDIT_AUTOSUMMARY |
2155 ( $new ? EDIT_NEW
: EDIT_UPDATE
) |
2156 ( ( $this->minoredit
&& !$this->isNew
) ? EDIT_MINOR
: 0 ) |
2157 ( $bot ? EDIT_FORCE_BOT
: 0 );
2159 $doEditStatus = $this->page
->doEditContent(
2165 $content->getDefaultFormat(),
2169 if ( !$doEditStatus->isOK() ) {
2170 // Failure from doEdit()
2171 // Show the edit conflict page for certain recognized errors from doEdit(),
2172 // but don't show it for errors from extension hooks
2173 $errors = $doEditStatus->getErrorsArray();
2174 if ( in_array( $errors[0][0],
2175 [ 'edit-gone-missing', 'edit-conflict', 'edit-already-exists' ] )
2177 $this->isConflict
= true;
2178 // Destroys data doEdit() put in $status->value but who cares
2179 $doEditStatus->value
= self
::AS_END
;
2181 return $doEditStatus;
2184 $result['nullEdit'] = $doEditStatus->hasMessage( 'edit-no-change' );
2185 if ( $result['nullEdit'] ) {
2186 // We don't know if it was a null edit until now, so increment here
2187 $wgUser->pingLimiter( 'linkpurge' );
2189 $result['redirect'] = $content->isRedirect();
2191 $this->updateWatchlist();
2193 // If the content model changed, add a log entry
2194 if ( $changingContentModel ) {
2195 $this->addContentModelChangeLogEntry(
2197 $new ?
false : $oldContentModel,
2198 $this->contentModel
,
2208 * @param string|false $oldModel false if the page is being newly created
2209 * @param string $newModel
2210 * @param string $reason
2212 protected function addContentModelChangeLogEntry( User
$user, $oldModel, $newModel, $reason ) {
2213 $new = $oldModel === false;
2214 $log = new ManualLogEntry( 'contentmodel', $new ?
'new' : 'change' );
2215 $log->setPerformer( $user );
2216 $log->setTarget( $this->mTitle
);
2217 $log->setComment( $reason );
2218 $log->setParameters( [
2219 '4::oldmodel' => $oldModel,
2220 '5::newmodel' => $newModel
2222 $logid = $log->insert();
2223 $log->publish( $logid );
2227 * Register the change of watch status
2229 protected function updateWatchlist() {
2232 if ( !$wgUser->isLoggedIn() ) {
2237 $title = $this->mTitle
;
2238 $watch = $this->watchthis
;
2239 // Do this in its own transaction to reduce contention...
2240 DeferredUpdates
::addCallableUpdate( function () use ( $user, $title, $watch ) {
2241 if ( $watch == $user->isWatched( $title, User
::IGNORE_USER_RIGHTS
) ) {
2242 return; // nothing to change
2244 WatchAction
::doWatchOrUnwatch( $watch, $title, $user );
2249 * Attempts to do 3-way merge of edit content with a base revision
2250 * and current content, in case of edit conflict, in whichever way appropriate
2251 * for the content type.
2255 * @param Content $editContent
2259 private function mergeChangesIntoContent( &$editContent ) {
2261 $db = wfGetDB( DB_MASTER
);
2263 // This is the revision the editor started from
2264 $baseRevision = $this->getBaseRevision();
2265 $baseContent = $baseRevision ?
$baseRevision->getContent() : null;
2267 if ( is_null( $baseContent ) ) {
2271 // The current state, we want to merge updates into it
2272 $currentRevision = Revision
::loadFromTitle( $db, $this->mTitle
);
2273 $currentContent = $currentRevision ?
$currentRevision->getContent() : null;
2275 if ( is_null( $currentContent ) ) {
2279 $handler = ContentHandler
::getForModelID( $baseContent->getModel() );
2281 $result = $handler->merge3( $baseContent, $editContent, $currentContent );
2284 $editContent = $result;
2285 // Update parentRevId to what we just merged.
2286 $this->parentRevId
= $currentRevision->getId();
2294 * @note: this method is very poorly named. If the user opened the form with ?oldid=X,
2295 * one might think of X as the "base revision", which is NOT what this returns.
2296 * @return Revision Current version when the edit was started
2298 function getBaseRevision() {
2299 if ( !$this->mBaseRevision
) {
2300 $db = wfGetDB( DB_MASTER
);
2301 $this->mBaseRevision
= $this->editRevId
2302 ? Revision
::newFromId( $this->editRevId
, Revision
::READ_LATEST
)
2303 : Revision
::loadFromTimestamp( $db, $this->mTitle
, $this->edittime
);
2305 return $this->mBaseRevision
;
2309 * Check given input text against $wgSpamRegex, and return the text of the first match.
2311 * @param string $text
2313 * @return string|bool Matching string or false
2315 public static function matchSpamRegex( $text ) {
2316 global $wgSpamRegex;
2317 // For back compatibility, $wgSpamRegex may be a single string or an array of regexes.
2318 $regexes = (array)$wgSpamRegex;
2319 return self
::matchSpamRegexInternal( $text, $regexes );
2323 * Check given input text against $wgSummarySpamRegex, and return the text of the first match.
2325 * @param string $text
2327 * @return string|bool Matching string or false
2329 public static function matchSummarySpamRegex( $text ) {
2330 global $wgSummarySpamRegex;
2331 $regexes = (array)$wgSummarySpamRegex;
2332 return self
::matchSpamRegexInternal( $text, $regexes );
2336 * @param string $text
2337 * @param array $regexes
2338 * @return bool|string
2340 protected static function matchSpamRegexInternal( $text, $regexes ) {
2341 foreach ( $regexes as $regex ) {
2343 if ( preg_match( $regex, $text, $matches ) ) {
2350 function setHeaders() {
2351 global $wgOut, $wgUser, $wgAjaxEditStash;
2353 $wgOut->addModules( 'mediawiki.action.edit' );
2354 $wgOut->addModuleStyles( 'mediawiki.action.edit.styles' );
2356 if ( $wgUser->getOption( 'showtoolbar' ) ) {
2357 // The addition of default buttons is handled by getEditToolbar() which
2358 // has its own dependency on this module. The call here ensures the module
2359 // is loaded in time (it has position "top") for other modules to register
2360 // buttons (e.g. extensions, gadgets, user scripts).
2361 $wgOut->addModules( 'mediawiki.toolbar' );
2364 if ( $wgUser->getOption( 'uselivepreview' ) ) {
2365 $wgOut->addModules( 'mediawiki.action.edit.preview' );
2368 if ( $wgUser->getOption( 'useeditwarning' ) ) {
2369 $wgOut->addModules( 'mediawiki.action.edit.editWarning' );
2372 # Enabled article-related sidebar, toplinks, etc.
2373 $wgOut->setArticleRelated( true );
2375 $contextTitle = $this->getContextTitle();
2376 if ( $this->isConflict
) {
2377 $msg = 'editconflict';
2378 } elseif ( $contextTitle->exists() && $this->section
!= '' ) {
2379 $msg = $this->section
== 'new' ?
'editingcomment' : 'editingsection';
2381 $msg = $contextTitle->exists()
2382 ||
( $contextTitle->getNamespace() == NS_MEDIAWIKI
2383 && $contextTitle->getDefaultMessageText() !== false
2389 # Use the title defined by DISPLAYTITLE magic word when present
2390 # NOTE: getDisplayTitle() returns HTML while getPrefixedText() returns plain text.
2391 # setPageTitle() treats the input as wikitext, which should be safe in either case.
2392 $displayTitle = isset( $this->mParserOutput
) ?
$this->mParserOutput
->getDisplayTitle() : false;
2393 if ( $displayTitle === false ) {
2394 $displayTitle = $contextTitle->getPrefixedText();
2396 $wgOut->setPageTitle( $this->context
->msg( $msg, $displayTitle ) );
2397 # Transmit the name of the message to JavaScript for live preview
2398 # Keep Resources.php/mediawiki.action.edit.preview in sync with the possible keys
2399 $wgOut->addJsConfigVars( [
2400 'wgEditMessage' => $msg,
2401 'wgAjaxEditStash' => $wgAjaxEditStash,
2406 * Show all applicable editing introductions
2408 protected function showIntro() {
2409 global $wgOut, $wgUser;
2410 if ( $this->suppressIntro
) {
2414 $namespace = $this->mTitle
->getNamespace();
2416 if ( $namespace == NS_MEDIAWIKI
) {
2417 # Show a warning if editing an interface message
2418 $wgOut->wrapWikiMsg( "<div class='mw-editinginterface'>\n$1\n</div>", 'editinginterface' );
2419 # If this is a default message (but not css or js),
2420 # show a hint that it is translatable on translatewiki.net
2421 if ( !$this->mTitle
->hasContentModel( CONTENT_MODEL_CSS
)
2422 && !$this->mTitle
->hasContentModel( CONTENT_MODEL_JAVASCRIPT
)
2424 $defaultMessageText = $this->mTitle
->getDefaultMessageText();
2425 if ( $defaultMessageText !== false ) {
2426 $wgOut->wrapWikiMsg( "<div class='mw-translateinterface'>\n$1\n</div>",
2427 'translateinterface' );
2430 } elseif ( $namespace == NS_FILE
) {
2431 # Show a hint to shared repo
2432 $file = wfFindFile( $this->mTitle
);
2433 if ( $file && !$file->isLocal() ) {
2434 $descUrl = $file->getDescriptionUrl();
2435 # there must be a description url to show a hint to shared repo
2437 if ( !$this->mTitle
->exists() ) {
2438 $wgOut->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-create\">\n$1\n</div>", [
2439 'sharedupload-desc-create', $file->getRepo()->getDisplayName(), $descUrl
2442 $wgOut->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-edit\">\n$1\n</div>", [
2443 'sharedupload-desc-edit', $file->getRepo()->getDisplayName(), $descUrl
2450 # Show a warning message when someone creates/edits a user (talk) page but the user does not exist
2451 # Show log extract when the user is currently blocked
2452 if ( $namespace == NS_USER ||
$namespace == NS_USER_TALK
) {
2453 $username = explode( '/', $this->mTitle
->getText(), 2 )[0];
2454 $user = User
::newFromName( $username, false /* allow IP users*/ );
2455 $ip = User
::isIP( $username );
2456 $block = Block
::newFromTarget( $user, $user );
2457 if ( !( $user && $user->isLoggedIn() ) && !$ip ) { # User does not exist
2458 $wgOut->wrapWikiMsg( "<div class=\"mw-userpage-userdoesnotexist error\">\n$1\n</div>",
2459 [ 'userpage-userdoesnotexist', wfEscapeWikiText( $username ) ] );
2460 } elseif ( !is_null( $block ) && $block->getType() != Block
::TYPE_AUTO
) {
2461 # Show log extract if the user is currently blocked
2462 LogEventsList
::showLogExtract(
2465 MWNamespace
::getCanonicalName( NS_USER
) . ':' . $block->getTarget(),
2469 'showIfEmpty' => false,
2471 'blocked-notice-logextract',
2472 $user->getName() # Support GENDER in notice
2478 # Try to add a custom edit intro, or use the standard one if this is not possible.
2479 if ( !$this->showCustomIntro() && !$this->mTitle
->exists() ) {
2480 $helpLink = wfExpandUrl( Skin
::makeInternalOrExternalUrl(
2481 $this->context
->msg( 'helppage' )->inContentLanguage()->text()
2483 if ( $wgUser->isLoggedIn() ) {
2484 $wgOut->wrapWikiMsg(
2485 // Suppress the external link icon, consider the help url an internal one
2486 "<div class=\"mw-newarticletext plainlinks\">\n$1\n</div>",
2493 $wgOut->wrapWikiMsg(
2494 // Suppress the external link icon, consider the help url an internal one
2495 "<div class=\"mw-newarticletextanon plainlinks\">\n$1\n</div>",
2497 'newarticletextanon',
2503 # Give a notice if the user is editing a deleted/moved page...
2504 if ( !$this->mTitle
->exists() ) {
2505 LogEventsList
::showLogExtract( $wgOut, [ 'delete', 'move' ], $this->mTitle
,
2509 'conds' => [ "log_action != 'revision'" ],
2510 'showIfEmpty' => false,
2511 'msgKey' => [ 'recreate-moveddeleted-warn' ]
2518 * Attempt to show a custom editing introduction, if supplied
2522 protected function showCustomIntro() {
2523 if ( $this->editintro
) {
2524 $title = Title
::newFromText( $this->editintro
);
2525 if ( $title instanceof Title
&& $title->exists() && $title->userCan( 'read' ) ) {
2527 // Added using template syntax, to take <noinclude>'s into account.
2528 $wgOut->addWikiTextTitleTidy(
2529 '<div class="mw-editintro">{{:' . $title->getFullText() . '}}</div>',
2539 * Gets an editable textual representation of $content.
2540 * The textual representation can be turned by into a Content object by the
2541 * toEditContent() method.
2543 * If $content is null or false or a string, $content is returned unchanged.
2545 * If the given Content object is not of a type that can be edited using
2546 * the text base EditPage, an exception will be raised. Set
2547 * $this->allowNonTextContent to true to allow editing of non-textual
2550 * @param Content|null|bool|string $content
2551 * @return string The editable text form of the content.
2553 * @throws MWException If $content is not an instance of TextContent and
2554 * $this->allowNonTextContent is not true.
2556 protected function toEditText( $content ) {
2557 if ( $content === null ||
$content === false ||
is_string( $content ) ) {
2561 if ( !$this->isSupportedContentModel( $content->getModel() ) ) {
2562 throw new MWException( 'This content model is not supported: ' . $content->getModel() );
2565 return $content->serialize( $this->contentFormat
);
2569 * Turns the given text into a Content object by unserializing it.
2571 * If the resulting Content object is not of a type that can be edited using
2572 * the text base EditPage, an exception will be raised. Set
2573 * $this->allowNonTextContent to true to allow editing of non-textual
2576 * @param string|null|bool $text Text to unserialize
2577 * @return Content|bool|null The content object created from $text. If $text was false
2578 * or null, false resp. null will be returned instead.
2580 * @throws MWException If unserializing the text results in a Content
2581 * object that is not an instance of TextContent and
2582 * $this->allowNonTextContent is not true.
2584 protected function toEditContent( $text ) {
2585 if ( $text === false ||
$text === null ) {
2589 $content = ContentHandler
::makeContent( $text, $this->getTitle(),
2590 $this->contentModel
, $this->contentFormat
);
2592 if ( !$this->isSupportedContentModel( $content->getModel() ) ) {
2593 throw new MWException( 'This content model is not supported: ' . $content->getModel() );
2600 * Send the edit form and related headers to $wgOut
2601 * @param callable|null $formCallback That takes an OutputPage parameter; will be called
2602 * during form output near the top, for captchas and the like.
2604 * The $formCallback parameter is deprecated since MediaWiki 1.25. Please
2605 * use the EditPage::showEditForm:fields hook instead.
2607 function showEditForm( $formCallback = null ) {
2608 global $wgOut, $wgUser;
2610 # need to parse the preview early so that we know which templates are used,
2611 # otherwise users with "show preview after edit box" will get a blank list
2612 # we parse this near the beginning so that setHeaders can do the title
2613 # setting work instead of leaving it in getPreviewText
2614 $previewOutput = '';
2615 if ( $this->formtype
== 'preview' ) {
2616 $previewOutput = $this->getPreviewText();
2619 Hooks
::run( 'EditPage::showEditForm:initial', [ &$this, &$wgOut ] );
2621 $this->setHeaders();
2623 if ( $this->showHeader() === false ) {
2627 $wgOut->addHTML( $this->editFormPageTop
);
2629 if ( $wgUser->getOption( 'previewontop' ) ) {
2630 $this->displayPreviewArea( $previewOutput, true );
2633 $wgOut->addHTML( $this->editFormTextTop
);
2635 $showToolbar = true;
2636 if ( $this->wasDeletedSinceLastEdit() ) {
2637 if ( $this->formtype
== 'save' ) {
2638 // Hide the toolbar and edit area, user can click preview to get it back
2639 // Add an confirmation checkbox and explanation.
2640 $showToolbar = false;
2642 $wgOut->wrapWikiMsg( "<div class='error mw-deleted-while-editing'>\n$1\n</div>",
2643 'deletedwhileediting' );
2647 // @todo add EditForm plugin interface and use it here!
2648 // search for textarea1 and textares2, and allow EditForm to override all uses.
2649 $wgOut->addHTML( Html
::openElement(
2652 'id' => self
::EDITFORM_ID
,
2653 'name' => self
::EDITFORM_ID
,
2655 'action' => $this->getActionURL( $this->getContextTitle() ),
2656 'enctype' => 'multipart/form-data'
2660 if ( is_callable( $formCallback ) ) {
2661 wfWarn( 'The $formCallback parameter to ' . __METHOD__
. 'is deprecated' );
2662 call_user_func_array( $formCallback, [ &$wgOut ] );
2665 // Add an empty field to trip up spambots
2667 Xml
::openElement( 'div', [ 'id' => 'antispam-container', 'style' => 'display: none;' ] )
2670 [ 'for' => 'wpAntispam' ],
2671 $this->context
->msg( 'simpleantispam-label' )->parse()
2677 'name' => 'wpAntispam',
2678 'id' => 'wpAntispam',
2682 . Xml
::closeElement( 'div' )
2685 Hooks
::run( 'EditPage::showEditForm:fields', [ &$this, &$wgOut ] );
2687 // Put these up at the top to ensure they aren't lost on early form submission
2688 $this->showFormBeforeText();
2690 if ( $this->wasDeletedSinceLastEdit() && 'save' == $this->formtype
) {
2691 $username = $this->lastDelete
->user_name
;
2692 $comment = $this->lastDelete
->log_comment
;
2694 // It is better to not parse the comment at all than to have templates expanded in the middle
2695 // TODO: can the checkLabel be moved outside of the div so that wrapWikiMsg could be used?
2696 $key = $comment === ''
2697 ?
'confirmrecreate-noreason'
2698 : 'confirmrecreate';
2700 '<div class="mw-confirm-recreate">' .
2701 $this->context
->msg( $key, $username, "<nowiki>$comment</nowiki>" )->parse() .
2702 Xml
::checkLabel( $this->context
->msg( 'recreate' )->text(), 'wpRecreate', 'wpRecreate', false,
2703 [ 'title' => Linker
::titleAttrib( 'recreate' ), 'tabindex' => 1, 'id' => 'wpRecreate' ]
2709 # When the summary is hidden, also hide them on preview/show changes
2710 if ( $this->nosummary
) {
2711 $wgOut->addHTML( Html
::hidden( 'nosummary', true ) );
2714 # If a blank edit summary was previously provided, and the appropriate
2715 # user preference is active, pass a hidden tag as wpIgnoreBlankSummary. This will stop the
2716 # user being bounced back more than once in the event that a summary
2719 # For a bit more sophisticated detection of blank summaries, hash the
2720 # automatic one and pass that in the hidden field wpAutoSummary.
2721 if ( $this->missingSummary ||
( $this->section
== 'new' && $this->nosummary
) ) {
2722 $wgOut->addHTML( Html
::hidden( 'wpIgnoreBlankSummary', true ) );
2725 if ( $this->undidRev
) {
2726 $wgOut->addHTML( Html
::hidden( 'wpUndidRevision', $this->undidRev
) );
2729 if ( $this->selfRedirect
) {
2730 $wgOut->addHTML( Html
::hidden( 'wpIgnoreSelfRedirect', true ) );
2733 if ( $this->hasPresetSummary
) {
2734 // If a summary has been preset using &summary= we don't want to prompt for
2735 // a different summary. Only prompt for a summary if the summary is blanked.
2737 $this->autoSumm
= md5( '' );
2740 $autosumm = $this->autoSumm ?
$this->autoSumm
: md5( $this->summary
);
2741 $wgOut->addHTML( Html
::hidden( 'wpAutoSummary', $autosumm ) );
2743 $wgOut->addHTML( Html
::hidden( 'oldid', $this->oldid
) );
2744 $wgOut->addHTML( Html
::hidden( 'parentRevId', $this->getParentRevId() ) );
2746 $wgOut->addHTML( Html
::hidden( 'format', $this->contentFormat
) );
2747 $wgOut->addHTML( Html
::hidden( 'model', $this->contentModel
) );
2749 if ( $this->section
== 'new' ) {
2750 $this->showSummaryInput( true, $this->summary
);
2751 $wgOut->addHTML( $this->getSummaryPreview( true, $this->summary
) );
2754 $wgOut->addHTML( $this->editFormTextBeforeContent
);
2756 if ( !$this->isCssJsSubpage
&& $showToolbar && $wgUser->getOption( 'showtoolbar' ) ) {
2757 $wgOut->addHTML( EditPage
::getEditToolbar( $this->mTitle
) );
2760 if ( $this->blankArticle
) {
2761 $wgOut->addHTML( Html
::hidden( 'wpIgnoreBlankArticle', true ) );
2764 if ( $this->isConflict
) {
2765 // In an edit conflict bypass the overridable content form method
2766 // and fallback to the raw wpTextbox1 since editconflicts can't be
2767 // resolved between page source edits and custom ui edits using the
2769 $this->textbox2
= $this->textbox1
;
2771 $content = $this->getCurrentContent();
2772 $this->textbox1
= $this->toEditText( $content );
2774 $this->showTextbox1();
2776 $this->showContentForm();
2779 $wgOut->addHTML( $this->editFormTextAfterContent
);
2781 $this->showStandardInputs();
2783 $this->showFormAfterText();
2785 $this->showTosSummary();
2787 $this->showEditTools();
2789 $wgOut->addHTML( $this->editFormTextAfterTools
. "\n" );
2791 $wgOut->addHTML( $this->makeTemplatesOnThisPageList( $this->getTemplates() ) );
2793 $wgOut->addHTML( Html
::rawElement( 'div', [ 'class' => 'hiddencats' ],
2794 Linker
::formatHiddenCategories( $this->page
->getHiddenCategories() ) ) );
2796 $wgOut->addHTML( Html
::rawElement( 'div', [ 'class' => 'limitreport' ],
2797 self
::getPreviewLimitReport( $this->mParserOutput
) ) );
2799 $wgOut->addModules( 'mediawiki.action.edit.collapsibleFooter' );
2801 if ( $this->isConflict
) {
2803 $this->showConflict();
2804 } catch ( MWContentSerializationException
$ex ) {
2805 // this can't really happen, but be nice if it does.
2806 $msg = $this->context
->msg(
2807 'content-failed-to-parse',
2808 $this->contentModel
,
2809 $this->contentFormat
,
2812 $wgOut->addWikiText( '<div class="error">' . $msg->text() . '</div>' );
2816 // Set a hidden field so JS knows what edit form mode we are in
2817 if ( $this->isConflict
) {
2819 } elseif ( $this->preview
) {
2821 } elseif ( $this->diff
) {
2826 $wgOut->addHTML( Html
::hidden( 'mode', $mode, [ 'id' => 'mw-edit-mode' ] ) );
2828 // Marker for detecting truncated form data. This must be the last
2829 // parameter sent in order to be of use, so do not move me.
2830 $wgOut->addHTML( Html
::hidden( 'wpUltimateParam', true ) );
2831 $wgOut->addHTML( $this->editFormTextBottom
. "\n</form>\n" );
2833 if ( !$wgUser->getOption( 'previewontop' ) ) {
2834 $this->displayPreviewArea( $previewOutput, false );
2840 * Wrapper around TemplatesOnThisPageFormatter to make
2841 * a "templates on this page" list.
2843 * @param Title[] $templates
2844 * @return string HTML
2846 protected function makeTemplatesOnThisPageList( array $templates ) {
2847 $templateListFormatter = new TemplatesOnThisPageFormatter(
2848 $this->context
, MediaWikiServices
::getInstance()->getLinkRenderer()
2851 // preview if preview, else section if section, else false
2853 if ( $this->preview
) {
2855 } elseif ( $this->section
!= '' ) {
2859 return Html
::rawElement( 'div', [ 'class' => 'templatesUsed' ],
2860 $templateListFormatter->format( $templates, $type )
2866 * Extract the section title from current section text, if any.
2868 * @param string $text
2869 * @return string|bool String or false
2871 public static function extractSectionTitle( $text ) {
2872 preg_match( "/^(=+)(.+)\\1\\s*(\n|$)/i", $text, $matches );
2873 if ( !empty( $matches[2] ) ) {
2875 return $wgParser->stripSectionName( trim( $matches[2] ) );
2884 protected function showHeader() {
2885 global $wgOut, $wgUser, $wgMaxArticleSize, $wgLang;
2886 global $wgAllowUserCss, $wgAllowUserJs;
2888 if ( $this->mTitle
->isTalkPage() ) {
2889 $wgOut->addWikiMsg( 'talkpagetext' );
2893 $editNotices = $this->mTitle
->getEditNotices( $this->oldid
);
2894 if ( count( $editNotices ) ) {
2895 $wgOut->addHTML( implode( "\n", $editNotices ) );
2897 $msg = $this->context
->msg( 'editnotice-notext' );
2898 if ( !$msg->isDisabled() ) {
2900 '<div class="mw-editnotice-notext">'
2901 . $msg->parseAsBlock()
2907 if ( $this->isConflict
) {
2908 $wgOut->wrapWikiMsg( "<div class='mw-explainconflict'>\n$1\n</div>", 'explainconflict' );
2909 $this->editRevId
= $this->page
->getLatest();
2911 if ( $this->section
!= '' && !$this->isSectionEditSupported() ) {
2912 // We use $this->section to much before this and getVal('wgSection') directly in other places
2913 // at this point we can't reset $this->section to '' to fallback to non-section editing.
2914 // Someone is welcome to try refactoring though
2915 $wgOut->showErrorPage( 'sectioneditnotsupported-title', 'sectioneditnotsupported-text' );
2919 if ( $this->section
!= '' && $this->section
!= 'new' ) {
2920 if ( !$this->summary
&& !$this->preview
&& !$this->diff
) {
2921 $sectionTitle = self
::extractSectionTitle( $this->textbox1
); // FIXME: use Content object
2922 if ( $sectionTitle !== false ) {
2923 $this->summary
= "/* $sectionTitle */ ";
2928 if ( $this->missingComment
) {
2929 $wgOut->wrapWikiMsg( "<div id='mw-missingcommenttext'>\n$1\n</div>", 'missingcommenttext' );
2932 if ( $this->missingSummary
&& $this->section
!= 'new' ) {
2933 $wgOut->wrapWikiMsg( "<div id='mw-missingsummary'>\n$1\n</div>", 'missingsummary' );
2936 if ( $this->missingSummary
&& $this->section
== 'new' ) {
2937 $wgOut->wrapWikiMsg( "<div id='mw-missingcommentheader'>\n$1\n</div>", 'missingcommentheader' );
2940 if ( $this->blankArticle
) {
2941 $wgOut->wrapWikiMsg( "<div id='mw-blankarticle'>\n$1\n</div>", 'blankarticle' );
2944 if ( $this->selfRedirect
) {
2945 $wgOut->wrapWikiMsg( "<div id='mw-selfredirect'>\n$1\n</div>", 'selfredirect' );
2948 if ( $this->hookError
!== '' ) {
2949 $wgOut->addWikiText( $this->hookError
);
2952 if ( !$this->checkUnicodeCompliantBrowser() ) {
2953 $wgOut->addWikiMsg( 'nonunicodebrowser' );
2956 if ( $this->section
!= 'new' ) {
2957 $revision = $this->mArticle
->getRevisionFetched();
2959 // Let sysop know that this will make private content public if saved
2961 if ( !$revision->userCan( Revision
::DELETED_TEXT
, $wgUser ) ) {
2962 $wgOut->wrapWikiMsg(
2963 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
2964 'rev-deleted-text-permission'
2966 } elseif ( $revision->isDeleted( Revision
::DELETED_TEXT
) ) {
2967 $wgOut->wrapWikiMsg(
2968 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
2969 'rev-deleted-text-view'
2973 if ( !$revision->isCurrent() ) {
2974 $this->mArticle
->setOldSubtitle( $revision->getId() );
2975 $wgOut->addWikiMsg( 'editingold' );
2976 $this->isOldRev
= true;
2978 } elseif ( $this->mTitle
->exists() ) {
2979 // Something went wrong
2981 $wgOut->wrapWikiMsg( "<div class='errorbox'>\n$1\n</div>\n",
2982 [ 'missing-revision', $this->oldid
] );
2987 if ( wfReadOnly() ) {
2988 $wgOut->wrapWikiMsg(
2989 "<div id=\"mw-read-only-warning\">\n$1\n</div>",
2990 [ 'readonlywarning', wfReadOnlyReason() ]
2992 } elseif ( $wgUser->isAnon() ) {
2993 if ( $this->formtype
!= 'preview' ) {
2994 $wgOut->wrapWikiMsg(
2995 "<div id='mw-anon-edit-warning' class='warningbox'>\n$1\n</div>",
2996 [ 'anoneditwarning',
2998 SpecialPage
::getTitleFor( 'Userlogin' )->getFullURL( [
2999 'returnto' => $this->getTitle()->getPrefixedDBkey()
3002 SpecialPage
::getTitleFor( 'CreateAccount' )->getFullURL( [
3003 'returnto' => $this->getTitle()->getPrefixedDBkey()
3008 $wgOut->wrapWikiMsg( "<div id=\"mw-anon-preview-warning\" class=\"warningbox\">\n$1</div>",
3009 'anonpreviewwarning'
3013 if ( $this->isCssJsSubpage
) {
3014 # Check the skin exists
3015 if ( $this->isWrongCaseCssJsPage
) {
3016 $wgOut->wrapWikiMsg(
3017 "<div class='error' id='mw-userinvalidcssjstitle'>\n$1\n</div>",
3018 [ 'userinvalidcssjstitle', $this->mTitle
->getSkinFromCssJsSubpage() ]
3021 if ( $this->getTitle()->isSubpageOf( $wgUser->getUserPage() ) ) {
3022 $wgOut->wrapWikiMsg( '<div class="mw-usercssjspublic">$1</div>',
3023 $this->isCssSubpage ?
'usercssispublic' : 'userjsispublic'
3025 if ( $this->formtype
!== 'preview' ) {
3026 if ( $this->isCssSubpage
&& $wgAllowUserCss ) {
3027 $wgOut->wrapWikiMsg(
3028 "<div id='mw-usercssyoucanpreview'>\n$1\n</div>",
3029 [ 'usercssyoucanpreview' ]
3033 if ( $this->isJsSubpage
&& $wgAllowUserJs ) {
3034 $wgOut->wrapWikiMsg(
3035 "<div id='mw-userjsyoucanpreview'>\n$1\n</div>",
3036 [ 'userjsyoucanpreview' ]
3044 if ( $this->mTitle
->isProtected( 'edit' ) &&
3045 MWNamespace
::getRestrictionLevels( $this->mTitle
->getNamespace() ) !== [ '' ]
3047 # Is the title semi-protected?
3048 if ( $this->mTitle
->isSemiProtected() ) {
3049 $noticeMsg = 'semiprotectedpagewarning';
3051 # Then it must be protected based on static groups (regular)
3052 $noticeMsg = 'protectedpagewarning';
3054 LogEventsList
::showLogExtract( $wgOut, 'protect', $this->mTitle
, '',
3055 [ 'lim' => 1, 'msgKey' => [ $noticeMsg ] ] );
3057 if ( $this->mTitle
->isCascadeProtected() ) {
3058 # Is this page under cascading protection from some source pages?
3059 /** @var Title[] $cascadeSources */
3060 list( $cascadeSources, /* $restrictions */ ) = $this->mTitle
->getCascadeProtectionSources();
3061 $notice = "<div class='mw-cascadeprotectedwarning'>\n$1\n";
3062 $cascadeSourcesCount = count( $cascadeSources );
3063 if ( $cascadeSourcesCount > 0 ) {
3064 # Explain, and list the titles responsible
3065 foreach ( $cascadeSources as $page ) {
3066 $notice .= '* [[:' . $page->getPrefixedText() . "]]\n";
3069 $notice .= '</div>';
3070 $wgOut->wrapWikiMsg( $notice, [ 'cascadeprotectedwarning', $cascadeSourcesCount ] );
3072 if ( !$this->mTitle
->exists() && $this->mTitle
->getRestrictions( 'create' ) ) {
3073 LogEventsList
::showLogExtract( $wgOut, 'protect', $this->mTitle
, '',
3075 'showIfEmpty' => false,
3076 'msgKey' => [ 'titleprotectedwarning' ],
3077 'wrap' => "<div class=\"mw-titleprotectedwarning\">\n$1</div>" ] );
3080 if ( $this->contentLength
=== false ) {
3081 $this->contentLength
= strlen( $this->textbox1
);
3084 if ( $this->tooBig ||
$this->contentLength
> $wgMaxArticleSize * 1024 ) {
3085 $wgOut->wrapWikiMsg( "<div class='error' id='mw-edit-longpageerror'>\n$1\n</div>",
3088 $wgLang->formatNum( round( $this->contentLength
/ 1024, 3 ) ),
3089 $wgLang->formatNum( $wgMaxArticleSize )
3093 if ( !$this->context
->msg( 'longpage-hint' )->isDisabled() ) {
3094 $wgOut->wrapWikiMsg( "<div id='mw-edit-longpage-hint'>\n$1\n</div>",
3097 $wgLang->formatSize( strlen( $this->textbox1
) ),
3098 strlen( $this->textbox1
)
3103 # Add header copyright warning
3104 $this->showHeaderCopyrightWarning();
3110 * Standard summary input and label (wgSummary), abstracted so EditPage
3111 * subclasses may reorganize the form.
3112 * Note that you do not need to worry about the label's for=, it will be
3113 * inferred by the id given to the input. You can remove them both by
3114 * passing [ 'id' => false ] to $userInputAttrs.
3116 * @param string $summary The value of the summary input
3117 * @param string $labelText The html to place inside the label
3118 * @param array $inputAttrs Array of attrs to use on the input
3119 * @param array $spanLabelAttrs Array of attrs to use on the span inside the label
3121 * @return array An array in the format [ $label, $input ]
3123 function getSummaryInput( $summary = "", $labelText = null,
3124 $inputAttrs = null, $spanLabelAttrs = null
3126 // Note: the maxlength is overridden in JS to 255 and to make it use UTF-8 bytes, not characters.
3127 $inputAttrs = ( is_array( $inputAttrs ) ?
$inputAttrs : [] ) +
[
3128 'id' => 'wpSummary',
3129 'maxlength' => '200',
3132 'spellcheck' => 'true',
3133 ] + Linker
::tooltipAndAccesskeyAttribs( 'summary' );
3135 $spanLabelAttrs = ( is_array( $spanLabelAttrs ) ?
$spanLabelAttrs : [] ) +
[
3136 'class' => $this->missingSummary ?
'mw-summarymissed' : 'mw-summary',
3137 'id' => "wpSummaryLabel"
3144 $inputAttrs['id'] ?
[ 'for' => $inputAttrs['id'] ] : null,
3147 $label = Xml
::tags( 'span', $spanLabelAttrs, $label );
3150 $input = Html
::input( 'wpSummary', $summary, 'text', $inputAttrs );
3152 return [ $label, $input ];
3156 * @param bool $isSubjectPreview True if this is the section subject/title
3157 * up top, or false if this is the comment summary
3158 * down below the textarea
3159 * @param string $summary The text of the summary to display
3161 protected function showSummaryInput( $isSubjectPreview, $summary = "" ) {
3163 # Add a class if 'missingsummary' is triggered to allow styling of the summary line
3164 $summaryClass = $this->missingSummary ?
'mw-summarymissed' : 'mw-summary';
3165 if ( $isSubjectPreview ) {
3166 if ( $this->nosummary
) {
3170 if ( !$this->mShowSummaryField
) {
3174 $labelText = $this->context
->msg( $isSubjectPreview ?
'subject' : 'summary' )->parse();
3175 list( $label, $input ) = $this->getSummaryInput(
3178 [ 'class' => $summaryClass ],
3181 $wgOut->addHTML( "{$label} {$input}" );
3185 * @param bool $isSubjectPreview True if this is the section subject/title
3186 * up top, or false if this is the comment summary
3187 * down below the textarea
3188 * @param string $summary The text of the summary to display
3191 protected function getSummaryPreview( $isSubjectPreview, $summary = "" ) {
3192 // avoid spaces in preview, gets always trimmed on save
3193 $summary = trim( $summary );
3194 if ( !$summary ||
( !$this->preview
&& !$this->diff
) ) {
3200 if ( $isSubjectPreview ) {
3201 $summary = $this->context
->msg( 'newsectionsummary' )
3202 ->rawParams( $wgParser->stripSectionName( $summary ) )
3203 ->inContentLanguage()->text();
3206 $message = $isSubjectPreview ?
'subject-preview' : 'summary-preview';
3208 $summary = $this->context
->msg( $message )->parse()
3209 . Linker
::commentBlock( $summary, $this->mTitle
, $isSubjectPreview );
3210 return Xml
::tags( 'div', [ 'class' => 'mw-summary-preview' ], $summary );
3213 protected function showFormBeforeText() {
3215 $section = htmlspecialchars( $this->section
);
3216 $wgOut->addHTML( <<<HTML
3217 <input type='hidden' value="{$section}" name="wpSection"/>
3218 <input type='hidden' value="{$this->starttime}" name="wpStarttime" />
3219 <input type='hidden' value="{$this->edittime}" name="wpEdittime" />
3220 <input type='hidden' value="{$this->editRevId}" name="editRevId" />
3221 <input type='hidden' value="{$this->scrolltop}" name="wpScrolltop" id="wpScrolltop" />
3225 if ( !$this->checkUnicodeCompliantBrowser() ) {
3226 $wgOut->addHTML( Html
::hidden( 'safemode', '1' ) );
3230 protected function showFormAfterText() {
3231 global $wgOut, $wgUser;
3233 * To make it harder for someone to slip a user a page
3234 * which submits an edit form to the wiki without their
3235 * knowledge, a random token is associated with the login
3236 * session. If it's not passed back with the submission,
3237 * we won't save the page, or render user JavaScript and
3240 * For anon editors, who may not have a session, we just
3241 * include the constant suffix to prevent editing from
3242 * broken text-mangling proxies.
3244 $wgOut->addHTML( "\n" . Html
::hidden( "wpEditToken", $wgUser->getEditToken() ) . "\n" );
3248 * Subpage overridable method for printing the form for page content editing
3249 * By default this simply outputs wpTextbox1
3250 * Subclasses can override this to provide a custom UI for editing;
3251 * be it a form, or simply wpTextbox1 with a modified content that will be
3252 * reverse modified when extracted from the post data.
3253 * Note that this is basically the inverse for importContentFormData
3255 protected function showContentForm() {
3256 $this->showTextbox1();
3260 * Method to output wpTextbox1
3261 * The $textoverride method can be used by subclasses overriding showContentForm
3262 * to pass back to this method.
3264 * @param array $customAttribs Array of html attributes to use in the textarea
3265 * @param string $textoverride Optional text to override $this->textarea1 with
3267 protected function showTextbox1( $customAttribs = null, $textoverride = null ) {
3268 if ( $this->wasDeletedSinceLastEdit() && $this->formtype
== 'save' ) {
3269 $attribs = [ 'style' => 'display:none;' ];
3271 $classes = []; // Textarea CSS
3272 if ( $this->mTitle
->isProtected( 'edit' ) &&
3273 MWNamespace
::getRestrictionLevels( $this->mTitle
->getNamespace() ) !== [ '' ]
3275 # Is the title semi-protected?
3276 if ( $this->mTitle
->isSemiProtected() ) {
3277 $classes[] = 'mw-textarea-sprotected';
3279 # Then it must be protected based on static groups (regular)
3280 $classes[] = 'mw-textarea-protected';
3282 # Is the title cascade-protected?
3283 if ( $this->mTitle
->isCascadeProtected() ) {
3284 $classes[] = 'mw-textarea-cprotected';
3287 # Is an old revision being edited?
3288 if ( $this->isOldRev
) {
3289 $classes[] = 'mw-textarea-oldrev';
3292 $attribs = [ 'tabindex' => 1 ];
3294 if ( is_array( $customAttribs ) ) {
3295 $attribs +
= $customAttribs;
3298 if ( count( $classes ) ) {
3299 if ( isset( $attribs['class'] ) ) {
3300 $classes[] = $attribs['class'];
3302 $attribs['class'] = implode( ' ', $classes );
3307 $textoverride !== null ?
$textoverride : $this->textbox1
,
3313 protected function showTextbox2() {
3314 $this->showTextbox( $this->textbox2
, 'wpTextbox2', [ 'tabindex' => 6, 'readonly' ] );
3317 protected function showTextbox( $text, $name, $customAttribs = [] ) {
3318 global $wgOut, $wgUser;
3320 $wikitext = $this->safeUnicodeOutput( $text );
3321 if ( strval( $wikitext ) !== '' ) {
3322 // Ensure there's a newline at the end, otherwise adding lines
3324 // But don't add a newline if the ext is empty, or Firefox in XHTML
3325 // mode will show an extra newline. A bit annoying.
3329 $attribs = $customAttribs +
[
3332 'cols' => $wgUser->getIntOption( 'cols' ),
3333 'rows' => $wgUser->getIntOption( 'rows' ),
3334 // Avoid PHP notices when appending preferences
3335 // (appending allows customAttribs['style'] to still work).
3339 // The following classes can be used here:
3340 // * mw-editfont-default
3341 // * mw-editfont-monospace
3342 // * mw-editfont-sans-serif
3343 // * mw-editfont-serif
3344 $class = 'mw-editfont-' . $wgUser->getOption( 'editfont' );
3346 if ( isset( $attribs['class'] ) ) {
3347 if ( is_string( $attribs['class'] ) ) {
3348 $attribs['class'] .= ' ' . $class;
3349 } elseif ( is_array( $attribs['class'] ) ) {
3350 $attribs['class'][] = $class;
3353 $attribs['class'] = $class;
3356 $pageLang = $this->mTitle
->getPageLanguage();
3357 $attribs['lang'] = $pageLang->getHtmlCode();
3358 $attribs['dir'] = $pageLang->getDir();
3360 $wgOut->addHTML( Html
::textarea( $name, $wikitext, $attribs ) );
3363 protected function displayPreviewArea( $previewOutput, $isOnTop = false ) {
3367 $classes[] = 'ontop';
3370 $attribs = [ 'id' => 'wikiPreview', 'class' => implode( ' ', $classes ) ];
3372 if ( $this->formtype
!= 'preview' ) {
3373 $attribs['style'] = 'display: none;';
3376 $wgOut->addHTML( Xml
::openElement( 'div', $attribs ) );
3378 if ( $this->formtype
== 'preview' ) {
3379 $this->showPreview( $previewOutput );
3381 // Empty content container for LivePreview
3382 $pageViewLang = $this->mTitle
->getPageViewLanguage();
3383 $attribs = [ 'lang' => $pageViewLang->getHtmlCode(), 'dir' => $pageViewLang->getDir(),
3384 'class' => 'mw-content-' . $pageViewLang->getDir() ];
3385 $wgOut->addHTML( Html
::rawElement( 'div', $attribs ) );
3388 $wgOut->addHTML( '</div>' );
3390 if ( $this->formtype
== 'diff' ) {
3393 } catch ( MWContentSerializationException
$ex ) {
3394 $msg = $this->context
->msg(
3395 'content-failed-to-parse',
3396 $this->contentModel
,
3397 $this->contentFormat
,
3400 $wgOut->addWikiText( '<div class="error">' . $msg->text() . '</div>' );
3406 * Append preview output to $wgOut.
3407 * Includes category rendering if this is a category page.
3409 * @param string $text The HTML to be output for the preview.
3411 protected function showPreview( $text ) {
3413 if ( $this->mTitle
->getNamespace() == NS_CATEGORY
) {
3414 $this->mArticle
->openShowCategory();
3416 # This hook seems slightly odd here, but makes things more
3417 # consistent for extensions.
3418 Hooks
::run( 'OutputPageBeforeHTML', [ &$wgOut, &$text ] );
3419 $wgOut->addHTML( $text );
3420 if ( $this->mTitle
->getNamespace() == NS_CATEGORY
) {
3421 $this->mArticle
->closeShowCategory();
3426 * Get a diff between the current contents of the edit box and the
3427 * version of the page we're editing from.
3429 * If this is a section edit, we'll replace the section as for final
3430 * save and then make a comparison.
3432 function showDiff() {
3433 global $wgUser, $wgContLang, $wgOut;
3435 $oldtitlemsg = 'currentrev';
3436 # if message does not exist, show diff against the preloaded default
3437 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
&& !$this->mTitle
->exists() ) {
3438 $oldtext = $this->mTitle
->getDefaultMessageText();
3439 if ( $oldtext !== false ) {
3440 $oldtitlemsg = 'defaultmessagetext';
3441 $oldContent = $this->toEditContent( $oldtext );
3446 $oldContent = $this->getCurrentContent();
3449 $textboxContent = $this->toEditContent( $this->textbox1
);
3450 if ( $this->editRevId
!== null ) {
3451 $newContent = $this->page
->replaceSectionAtRev(
3452 $this->section
, $textboxContent, $this->summary
, $this->editRevId
3455 $newContent = $this->page
->replaceSectionContent(
3456 $this->section
, $textboxContent, $this->summary
, $this->edittime
3460 if ( $newContent ) {
3461 ContentHandler
::runLegacyHooks( 'EditPageGetDiffText', [ $this, &$newContent ], '1.21' );
3462 Hooks
::run( 'EditPageGetDiffContent', [ $this, &$newContent ] );
3464 $popts = ParserOptions
::newFromUserAndLang( $wgUser, $wgContLang );
3465 $newContent = $newContent->preSaveTransform( $this->mTitle
, $wgUser, $popts );
3468 if ( ( $oldContent && !$oldContent->isEmpty() ) ||
( $newContent && !$newContent->isEmpty() ) ) {
3469 $oldtitle = $this->context
->msg( $oldtitlemsg )->parse();
3470 $newtitle = $this->context
->msg( 'yourtext' )->parse();
3472 if ( !$oldContent ) {
3473 $oldContent = $newContent->getContentHandler()->makeEmptyContent();
3476 if ( !$newContent ) {
3477 $newContent = $oldContent->getContentHandler()->makeEmptyContent();
3480 $de = $oldContent->getContentHandler()->createDifferenceEngine( $this->mArticle
->getContext() );
3481 $de->setContent( $oldContent, $newContent );
3483 $difftext = $de->getDiff( $oldtitle, $newtitle );
3484 $de->showDiffStyle();
3489 $wgOut->addHTML( '<div id="wikiDiff">' . $difftext . '</div>' );
3493 * Show the header copyright warning.
3495 protected function showHeaderCopyrightWarning() {
3496 $msg = 'editpage-head-copy-warn';
3497 if ( !$this->context
->msg( $msg )->isDisabled() ) {
3499 $wgOut->wrapWikiMsg( "<div class='editpage-head-copywarn'>\n$1\n</div>",
3500 'editpage-head-copy-warn' );
3505 * Give a chance for site and per-namespace customizations of
3506 * terms of service summary link that might exist separately
3507 * from the copyright notice.
3509 * This will display between the save button and the edit tools,
3510 * so should remain short!
3512 protected function showTosSummary() {
3513 $msg = 'editpage-tos-summary';
3514 Hooks
::run( 'EditPageTosSummary', [ $this->mTitle
, &$msg ] );
3515 if ( !$this->context
->msg( $msg )->isDisabled() ) {
3517 $wgOut->addHTML( '<div class="mw-tos-summary">' );
3518 $wgOut->addWikiMsg( $msg );
3519 $wgOut->addHTML( '</div>' );
3523 protected function showEditTools() {
3525 $wgOut->addHTML( '<div class="mw-editTools">' .
3526 $this->context
->msg( 'edittools' )->inContentLanguage()->parse() .
3531 * Get the copyright warning
3533 * Renamed to getCopyrightWarning(), old name kept around for backwards compatibility
3536 protected function getCopywarn() {
3537 return self
::getCopyrightWarning( $this->mTitle
);
3541 * Get the copyright warning, by default returns wikitext
3543 * @param Title $title
3544 * @param string $format Output format, valid values are any function of a Message object
3547 public static function getCopyrightWarning( $title, $format = 'plain', $langcode = null ) {
3548 global $wgRightsText;
3549 if ( $wgRightsText ) {
3550 $copywarnMsg = [ 'copyrightwarning',
3551 '[[' . wfMessage( 'copyrightpage' )->inContentLanguage()->text() . ']]',
3554 $copywarnMsg = [ 'copyrightwarning2',
3555 '[[' . wfMessage( 'copyrightpage' )->inContentLanguage()->text() . ']]' ];
3557 // Allow for site and per-namespace customization of contribution/copyright notice.
3558 Hooks
::run( 'EditPageCopyrightWarning', [ $title, &$copywarnMsg ] );
3560 $msg = call_user_func_array( 'wfMessage', $copywarnMsg )->title( $title );
3562 $msg->inLanguage( $langcode );
3564 return "<div id=\"editpage-copywarn\">\n" .
3565 $msg->$format() . "\n</div>";
3569 * Get the Limit report for page previews
3572 * @param ParserOutput $output ParserOutput object from the parse
3573 * @return string HTML
3575 public static function getPreviewLimitReport( $output ) {
3576 if ( !$output ||
!$output->getLimitReportData() ) {
3580 $limitReport = Html
::rawElement( 'div', [ 'class' => 'mw-limitReportExplanation' ],
3581 wfMessage( 'limitreport-title' )->parseAsBlock()
3584 // Show/hide animation doesn't work correctly on a table, so wrap it in a div.
3585 $limitReport .= Html
::openElement( 'div', [ 'class' => 'preview-limit-report-wrapper' ] );
3587 $limitReport .= Html
::openElement( 'table', [
3588 'class' => 'preview-limit-report wikitable'
3590 Html
::openElement( 'tbody' );
3592 foreach ( $output->getLimitReportData()['limitreport'] as $key => $value ) {
3593 if ( Hooks
::run( 'ParserLimitReportFormat',
3594 [ $key, &$value, &$limitReport, true, true ]
3596 $keyMsg = wfMessage( "limitreport-$key" );
3597 $valueMsg = wfMessage(
3598 [ "limitreport-$key-value-html", "limitreport-$key-value" ]
3600 if ( !$valueMsg->exists() ) {
3601 $valueMsg = new RawMessage( '$1' );
3603 if ( !$keyMsg->isDisabled() && !$valueMsg->isDisabled() ) {
3604 // If it's a value/limit array, convert it for $1/$2
3605 if ( is_array( $value ) && isset( $value['value'] ) ) {
3606 $value = [ $value['value'], $value['limit'] ];
3608 $limitReport .= Html
::openElement( 'tr' ) .
3609 Html
::rawElement( 'th', null, $keyMsg->parse() ) .
3610 Html
::rawElement( 'td', null, $valueMsg->params( $value )->parse() ) .
3611 Html
::closeElement( 'tr' );
3616 $limitReport .= Html
::closeElement( 'tbody' ) .
3617 Html
::closeElement( 'table' ) .
3618 Html
::closeElement( 'div' );
3620 return $limitReport;
3623 protected function showStandardInputs( &$tabindex = 2 ) {
3625 $wgOut->addHTML( "<div class='editOptions'>\n" );
3627 if ( $this->section
!= 'new' ) {
3628 $this->showSummaryInput( false, $this->summary
);
3629 $wgOut->addHTML( $this->getSummaryPreview( false, $this->summary
) );
3632 $checkboxes = $this->getCheckboxes( $tabindex,
3633 [ 'minor' => $this->minoredit
, 'watch' => $this->watchthis
] );
3634 $wgOut->addHTML( "<div class='editCheckboxes'>" . implode( $checkboxes, "\n" ) . "</div>\n" );
3636 // Show copyright warning.
3637 $wgOut->addWikiText( $this->getCopywarn() );
3638 $wgOut->addHTML( $this->editFormTextAfterWarn
);
3640 $wgOut->addHTML( "<div class='editButtons'>\n" );
3641 $wgOut->addHTML( implode( $this->getEditButtons( $tabindex ), "\n" ) . "\n" );
3643 $cancel = $this->getCancelLink();
3644 if ( $cancel !== '' ) {
3645 $cancel .= Html
::element( 'span',
3646 [ 'class' => 'mw-editButtons-pipe-separator' ],
3647 $this->context
->msg( 'pipe-separator' )->text() );
3650 $message = $this->context
->msg( 'edithelppage' )->inContentLanguage()->text();
3651 $edithelpurl = Skin
::makeInternalOrExternalUrl( $message );
3653 'target' => 'helpwindow',
3654 'href' => $edithelpurl,
3656 $edithelp = Html
::linkButton( $this->context
->msg( 'edithelp' )->text(),
3657 $attrs, [ 'mw-ui-quiet' ] ) .
3658 $this->context
->msg( 'word-separator' )->escaped() .
3659 $this->context
->msg( 'newwindow' )->parse();
3661 $wgOut->addHTML( " <span class='cancelLink'>{$cancel}</span>\n" );
3662 $wgOut->addHTML( " <span class='editHelp'>{$edithelp}</span>\n" );
3663 $wgOut->addHTML( "</div><!-- editButtons -->\n" );
3665 Hooks
::run( 'EditPage::showStandardInputs:options', [ $this, $wgOut, &$tabindex ] );
3667 $wgOut->addHTML( "</div><!-- editOptions -->\n" );
3671 * Show an edit conflict. textbox1 is already shown in showEditForm().
3672 * If you want to use another entry point to this function, be careful.
3674 protected function showConflict() {
3677 if ( Hooks
::run( 'EditPageBeforeConflictDiff', [ &$this, &$wgOut ] ) ) {
3678 $stats = $wgOut->getContext()->getStats();
3679 $stats->increment( 'edit.failures.conflict' );
3680 // Only include 'standard' namespaces to avoid creating unknown numbers of statsd metrics
3682 $this->mTitle
->getNamespace() >= NS_MAIN
&&
3683 $this->mTitle
->getNamespace() <= NS_CATEGORY_TALK
3685 $stats->increment( 'edit.failures.conflict.byNamespaceId.' . $this->mTitle
->getNamespace() );
3688 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
3690 $content1 = $this->toEditContent( $this->textbox1
);
3691 $content2 = $this->toEditContent( $this->textbox2
);
3693 $handler = ContentHandler
::getForModelID( $this->contentModel
);
3694 $de = $handler->createDifferenceEngine( $this->mArticle
->getContext() );
3695 $de->setContent( $content2, $content1 );
3697 $this->context
->msg( 'yourtext' )->parse(),
3698 $this->context
->msg( 'storedversion' )->text()
3701 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
3702 $this->showTextbox2();
3709 public function getCancelLink() {
3711 if ( !$this->isConflict
&& $this->oldid
> 0 ) {
3712 $cancelParams['oldid'] = $this->oldid
;
3713 } elseif ( $this->getContextTitle()->isRedirect() ) {
3714 $cancelParams['redirect'] = 'no';
3716 $attrs = [ 'id' => 'mw-editform-cancel' ];
3718 return Linker
::linkKnown(
3719 $this->getContextTitle(),
3720 $this->context
->msg( 'cancel' )->parse(),
3721 Html
::buttonAttributes( $attrs, [ 'mw-ui-quiet' ] ),
3727 * Returns the URL to use in the form's action attribute.
3728 * This is used by EditPage subclasses when simply customizing the action
3729 * variable in the constructor is not enough. This can be used when the
3730 * EditPage lives inside of a Special page rather than a custom page action.
3732 * @param Title $title Title object for which is being edited (where we go to for &action= links)
3735 protected function getActionURL( Title
$title ) {
3736 return $title->getLocalURL( [ 'action' => $this->action
] );
3740 * Check if a page was deleted while the user was editing it, before submit.
3741 * Note that we rely on the logging table, which hasn't been always there,
3742 * but that doesn't matter, because this only applies to brand new
3746 protected function wasDeletedSinceLastEdit() {
3747 if ( $this->deletedSinceEdit
!== null ) {
3748 return $this->deletedSinceEdit
;
3751 $this->deletedSinceEdit
= false;
3753 if ( !$this->mTitle
->exists() && $this->mTitle
->isDeletedQuick() ) {
3754 $this->lastDelete
= $this->getLastDelete();
3755 if ( $this->lastDelete
) {
3756 $deleteTime = wfTimestamp( TS_MW
, $this->lastDelete
->log_timestamp
);
3757 if ( $deleteTime > $this->starttime
) {
3758 $this->deletedSinceEdit
= true;
3763 return $this->deletedSinceEdit
;
3767 * @return bool|stdClass
3769 protected function getLastDelete() {
3770 $dbr = wfGetDB( DB_REPLICA
);
3771 $data = $dbr->selectRow(
3772 [ 'logging', 'user' ],
3785 'log_namespace' => $this->mTitle
->getNamespace(),
3786 'log_title' => $this->mTitle
->getDBkey(),
3787 'log_type' => 'delete',
3788 'log_action' => 'delete',
3792 [ 'LIMIT' => 1, 'ORDER BY' => 'log_timestamp DESC' ]
3794 // Quick paranoid permission checks...
3795 if ( is_object( $data ) ) {
3796 if ( $data->log_deleted
& LogPage
::DELETED_USER
) {
3797 $data->user_name
= $this->context
->msg( 'rev-deleted-user' )->escaped();
3800 if ( $data->log_deleted
& LogPage
::DELETED_COMMENT
) {
3801 $data->log_comment
= $this->context
->msg( 'rev-deleted-comment' )->escaped();
3809 * Get the rendered text for previewing.
3810 * @throws MWException
3813 function getPreviewText() {
3814 global $wgOut, $wgRawHtml, $wgLang;
3815 global $wgAllowUserCss, $wgAllowUserJs;
3817 $stats = $wgOut->getContext()->getStats();
3819 if ( $wgRawHtml && !$this->mTokenOk
) {
3820 // Could be an offsite preview attempt. This is very unsafe if
3821 // HTML is enabled, as it could be an attack.
3823 if ( $this->textbox1
!== '' ) {
3824 // Do not put big scary notice, if previewing the empty
3825 // string, which happens when you initially edit
3826 // a category page, due to automatic preview-on-open.
3827 $parsedNote = $wgOut->parse( "<div class='previewnote'>" .
3828 $this->context
->msg( 'session_fail_preview_html' )->text() . "</div>",
3829 true, /* interface */true );
3831 $stats->increment( 'edit.failures.session_loss' );
3838 $content = $this->toEditContent( $this->textbox1
);
3842 'AlternateEditPreview',
3843 [ $this, &$content, &$previewHTML, &$this->mParserOutput
] )
3845 return $previewHTML;
3848 # provide a anchor link to the editform
3849 $continueEditing = '<span class="mw-continue-editing">' .
3850 '[[#' . self
::EDITFORM_ID
. '|' . $wgLang->getArrow() . ' ' .
3851 $this->context
->msg( 'continue-editing' )->text() . ']]</span>';
3852 if ( $this->mTriedSave
&& !$this->mTokenOk
) {
3853 if ( $this->mTokenOkExceptSuffix
) {
3854 $note = $this->context
->msg( 'token_suffix_mismatch' )->plain();
3855 $stats->increment( 'edit.failures.bad_token' );
3857 $note = $this->context
->msg( 'session_fail_preview' )->plain();
3858 $stats->increment( 'edit.failures.session_loss' );
3860 } elseif ( $this->incompleteForm
) {
3861 $note = $this->context
->msg( 'edit_form_incomplete' )->plain();
3862 if ( $this->mTriedSave
) {
3863 $stats->increment( 'edit.failures.incomplete_form' );
3866 $note = $this->context
->msg( 'previewnote' )->plain() . ' ' . $continueEditing;
3869 # don't parse non-wikitext pages, show message about preview
3870 if ( $this->mTitle
->isCssJsSubpage() ||
$this->mTitle
->isCssOrJsPage() ) {
3871 if ( $this->mTitle
->isCssJsSubpage() ) {
3873 } elseif ( $this->mTitle
->isCssOrJsPage() ) {
3879 if ( $content->getModel() == CONTENT_MODEL_CSS
) {
3881 if ( $level === 'user' && !$wgAllowUserCss ) {
3884 } elseif ( $content->getModel() == CONTENT_MODEL_JAVASCRIPT
) {
3886 if ( $level === 'user' && !$wgAllowUserJs ) {
3893 # Used messages to make sure grep find them:
3894 # Messages: usercsspreview, userjspreview, sitecsspreview, sitejspreview
3895 if ( $level && $format ) {
3896 $note = "<div id='mw-{$level}{$format}preview'>" .
3897 $this->context
->msg( "{$level}{$format}preview" )->text() .
3898 ' ' . $continueEditing . "</div>";
3902 # If we're adding a comment, we need to show the
3903 # summary as the headline
3904 if ( $this->section
=== "new" && $this->summary
!== "" ) {
3905 $content = $content->addSectionHeader( $this->summary
);
3908 $hook_args = [ $this, &$content ];
3909 ContentHandler
::runLegacyHooks( 'EditPageGetPreviewText', $hook_args, '1.25' );
3910 Hooks
::run( 'EditPageGetPreviewContent', $hook_args );
3912 $parserResult = $this->doPreviewParse( $content );
3913 $parserOutput = $parserResult['parserOutput'];
3914 $previewHTML = $parserResult['html'];
3915 $this->mParserOutput
= $parserOutput;
3916 $wgOut->addParserOutputMetadata( $parserOutput );
3918 if ( count( $parserOutput->getWarnings() ) ) {
3919 $note .= "\n\n" . implode( "\n\n", $parserOutput->getWarnings() );
3922 } catch ( MWContentSerializationException
$ex ) {
3923 $m = $this->context
->msg(
3924 'content-failed-to-parse',
3925 $this->contentModel
,
3926 $this->contentFormat
,
3929 $note .= "\n\n" . $m->parse();
3933 if ( $this->isConflict
) {
3934 $conflict = '<h2 id="mw-previewconflict">'
3935 . $this->context
->msg( 'previewconflict' )->escaped() . "</h2>\n";
3937 $conflict = '<hr />';
3940 $previewhead = "<div class='previewnote'>\n" .
3941 '<h2 id="mw-previewheader">' . $this->context
->msg( 'preview' )->escaped() . "</h2>" .
3942 $wgOut->parse( $note, true, /* interface */true ) . $conflict . "</div>\n";
3944 $pageViewLang = $this->mTitle
->getPageViewLanguage();
3945 $attribs = [ 'lang' => $pageViewLang->getHtmlCode(), 'dir' => $pageViewLang->getDir(),
3946 'class' => 'mw-content-' . $pageViewLang->getDir() ];
3947 $previewHTML = Html
::rawElement( 'div', $attribs, $previewHTML );
3949 return $previewhead . $previewHTML . $this->previewTextAfterContent
;
3953 * Get parser options for a preview
3954 * @return ParserOptions
3956 protected function getPreviewParserOptions() {
3957 $parserOptions = $this->page
->makeParserOptions( $this->mArticle
->getContext() );
3958 $parserOptions->setIsPreview( true );
3959 $parserOptions->setIsSectionPreview( !is_null( $this->section
) && $this->section
!== '' );
3960 $parserOptions->enableLimitReport();
3961 return $parserOptions;
3965 * Parse the page for a preview. Subclasses may override this class, in order
3966 * to parse with different options, or to otherwise modify the preview HTML.
3968 * @param Content $content The page content
3969 * @return array with keys:
3970 * - parserOutput: The ParserOutput object
3971 * - html: The HTML to be displayed
3973 protected function doPreviewParse( Content
$content ) {
3975 $parserOptions = $this->getPreviewParserOptions();
3976 $pstContent = $content->preSaveTransform( $this->mTitle
, $wgUser, $parserOptions );
3977 $scopedCallback = $parserOptions->setupFakeRevision(
3978 $this->mTitle
, $pstContent, $wgUser );
3979 $parserOutput = $pstContent->getParserOutput( $this->mTitle
, null, $parserOptions );
3980 ScopedCallback
::consume( $scopedCallback );
3981 $parserOutput->setEditSectionTokens( false ); // no section edit links
3983 'parserOutput' => $parserOutput,
3984 'html' => $parserOutput->getText() ];
3990 function getTemplates() {
3991 if ( $this->preview ||
$this->section
!= '' ) {
3993 if ( !isset( $this->mParserOutput
) ) {
3996 foreach ( $this->mParserOutput
->getTemplates() as $ns => $template ) {
3997 foreach ( array_keys( $template ) as $dbk ) {
3998 $templates[] = Title
::makeTitle( $ns, $dbk );
4003 return $this->mTitle
->getTemplateLinksFrom();
4008 * Shows a bulletin board style toolbar for common editing functions.
4009 * It can be disabled in the user preferences.
4011 * @param Title $title Title object for the page being edited (optional)
4014 static function getEditToolbar( $title = null ) {
4015 global $wgContLang, $wgOut;
4016 global $wgEnableUploads, $wgForeignFileRepos;
4018 $imagesAvailable = $wgEnableUploads ||
count( $wgForeignFileRepos );
4019 $showSignature = true;
4021 $showSignature = MWNamespace
::wantSignatures( $title->getNamespace() );
4025 * $toolarray is an array of arrays each of which includes the
4026 * opening tag, the closing tag, optionally a sample text that is
4027 * inserted between the two when no selection is highlighted
4028 * and. The tip text is shown when the user moves the mouse
4031 * Images are defined in ResourceLoaderEditToolbarModule.
4035 'id' => 'mw-editbutton-bold',
4037 'close' => '\'\'\'',
4038 'sample' => wfMessage( 'bold_sample' )->text(),
4039 'tip' => wfMessage( 'bold_tip' )->text(),
4042 'id' => 'mw-editbutton-italic',
4045 'sample' => wfMessage( 'italic_sample' )->text(),
4046 'tip' => wfMessage( 'italic_tip' )->text(),
4049 'id' => 'mw-editbutton-link',
4052 'sample' => wfMessage( 'link_sample' )->text(),
4053 'tip' => wfMessage( 'link_tip' )->text(),
4056 'id' => 'mw-editbutton-extlink',
4059 'sample' => wfMessage( 'extlink_sample' )->text(),
4060 'tip' => wfMessage( 'extlink_tip' )->text(),
4063 'id' => 'mw-editbutton-headline',
4066 'sample' => wfMessage( 'headline_sample' )->text(),
4067 'tip' => wfMessage( 'headline_tip' )->text(),
4069 $imagesAvailable ?
[
4070 'id' => 'mw-editbutton-image',
4071 'open' => '[[' . $wgContLang->getNsText( NS_FILE
) . ':',
4073 'sample' => wfMessage( 'image_sample' )->text(),
4074 'tip' => wfMessage( 'image_tip' )->text(),
4076 $imagesAvailable ?
[
4077 'id' => 'mw-editbutton-media',
4078 'open' => '[[' . $wgContLang->getNsText( NS_MEDIA
) . ':',
4080 'sample' => wfMessage( 'media_sample' )->text(),
4081 'tip' => wfMessage( 'media_tip' )->text(),
4084 'id' => 'mw-editbutton-nowiki',
4085 'open' => "<nowiki>",
4086 'close' => "</nowiki>",
4087 'sample' => wfMessage( 'nowiki_sample' )->text(),
4088 'tip' => wfMessage( 'nowiki_tip' )->text(),
4091 'id' => 'mw-editbutton-signature',
4092 'open' => wfMessage( 'sig-text', '~~~~' )->inContentLanguage()->text(),
4095 'tip' => wfMessage( 'sig_tip' )->text(),
4098 'id' => 'mw-editbutton-hr',
4099 'open' => "\n----\n",
4102 'tip' => wfMessage( 'hr_tip' )->text(),
4106 $script = 'mw.loader.using("mediawiki.toolbar", function () {';
4107 foreach ( $toolarray as $tool ) {
4113 // Images are defined in ResourceLoaderEditToolbarModule
4115 // Note that we use the tip both for the ALT tag and the TITLE tag of the image.
4116 // Older browsers show a "speedtip" type message only for ALT.
4117 // Ideally these should be different, realistically they
4118 // probably don't need to be.
4126 $script .= Xml
::encodeJsCall(
4127 'mw.toolbar.addButton',
4129 ResourceLoader
::inDebugMode()
4134 $wgOut->addScript( ResourceLoader
::makeInlineScript( $script ) );
4136 $toolbar = '<div id="toolbar"></div>';
4138 Hooks
::run( 'EditPageBeforeEditToolbar', [ &$toolbar ] );
4144 * Returns an array of html code of the following checkboxes:
4147 * @param int $tabindex Current tabindex
4148 * @param array $checked Array of checkbox => bool, where bool indicates the checked
4149 * status of the checkbox
4153 public function getCheckboxes( &$tabindex, $checked ) {
4154 global $wgUser, $wgUseMediaWikiUIEverywhere;
4158 // don't show the minor edit checkbox if it's a new page or section
4159 if ( !$this->isNew
) {
4160 $checkboxes['minor'] = '';
4161 $minorLabel = $this->context
->msg( 'minoredit' )->parse();
4162 if ( $wgUser->isAllowed( 'minoredit' ) ) {
4164 'tabindex' => ++
$tabindex,
4165 'accesskey' => $this->context
->msg( 'accesskey-minoredit' )->text(),
4166 'id' => 'wpMinoredit',
4169 Xml
::check( 'wpMinoredit', $checked['minor'], $attribs ) .
4170 " <label for='wpMinoredit' id='mw-editpage-minoredit'" .
4171 Xml
::expandAttributes( [ 'title' => Linker
::titleAttrib( 'minoredit', 'withaccess' ) ] ) .
4172 ">{$minorLabel}</label>";
4174 if ( $wgUseMediaWikiUIEverywhere ) {
4175 $checkboxes['minor'] = Html
::openElement( 'div', [ 'class' => 'mw-ui-checkbox' ] ) .
4177 Html
::closeElement( 'div' );
4179 $checkboxes['minor'] = $minorEditHtml;
4184 $watchLabel = $this->context
->msg( 'watchthis' )->parse();
4185 $checkboxes['watch'] = '';
4186 if ( $wgUser->isLoggedIn() ) {
4188 'tabindex' => ++
$tabindex,
4189 'accesskey' => $this->context
->msg( 'accesskey-watch' )->text(),
4190 'id' => 'wpWatchthis',
4193 Xml
::check( 'wpWatchthis', $checked['watch'], $attribs ) .
4194 " <label for='wpWatchthis' id='mw-editpage-watch'" .
4195 Xml
::expandAttributes( [ 'title' => Linker
::titleAttrib( 'watch', 'withaccess' ) ] ) .
4196 ">{$watchLabel}</label>";
4197 if ( $wgUseMediaWikiUIEverywhere ) {
4198 $checkboxes['watch'] = Html
::openElement( 'div', [ 'class' => 'mw-ui-checkbox' ] ) .
4200 Html
::closeElement( 'div' );
4202 $checkboxes['watch'] = $watchThisHtml;
4205 Hooks
::run( 'EditPageBeforeEditChecks', [ &$this, &$checkboxes, &$tabindex ] );
4210 * Returns an array of html code of the following buttons:
4211 * save, diff, preview and live
4213 * @param int $tabindex Current tabindex
4217 public function getEditButtons( &$tabindex ) {
4221 $this->mArticle
->getContext()->getConfig()->get( 'EditSubmitButtonLabelPublish' );
4223 // Can't use $this->isNew as that's also true if we're adding a new section to an extant page
4224 if ( $labelAsPublish ) {
4225 $buttonLabelKey = !$this->mTitle
->exists() ?
'publishpage' : 'publishchanges';
4227 $buttonLabelKey = !$this->mTitle
->exists() ?
'savearticle' : 'savechanges';
4229 $buttonLabel = $this->context
->msg( $buttonLabelKey )->text();
4233 'tabindex' => ++
$tabindex,
4234 ] + Linker
::tooltipAndAccesskeyAttribs( 'save' );
4235 $buttons['save'] = Html
::submitButton( $buttonLabel, $attribs, [ 'mw-ui-progressive' ] );
4237 ++
$tabindex; // use the same for preview and live preview
4239 'id' => 'wpPreview',
4240 'name' => 'wpPreview',
4241 'tabindex' => $tabindex,
4242 ] + Linker
::tooltipAndAccesskeyAttribs( 'preview' );
4243 $buttons['preview'] = Html
::submitButton( $this->context
->msg( 'showpreview' )->text(),
4245 $buttons['live'] = '';
4250 'tabindex' => ++
$tabindex,
4251 ] + Linker
::tooltipAndAccesskeyAttribs( 'diff' );
4252 $buttons['diff'] = Html
::submitButton( $this->context
->msg( 'showdiff' )->text(),
4255 Hooks
::run( 'EditPageBeforeEditButtons', [ &$this, &$buttons, &$tabindex ] );
4260 * Creates a basic error page which informs the user that
4261 * they have attempted to edit a nonexistent section.
4263 function noSuchSectionPage() {
4266 $wgOut->prepareErrorPage( $this->context
->msg( 'nosuchsectiontitle' ) );
4268 $res = $this->context
->msg( 'nosuchsectiontext', $this->section
)->parseAsBlock();
4269 Hooks
::run( 'EditPageNoSuchSection', [ &$this, &$res ] );
4270 $wgOut->addHTML( $res );
4272 $wgOut->returnToMain( false, $this->mTitle
);
4276 * Show "your edit contains spam" page with your diff and text
4278 * @param string|array|bool $match Text (or array of texts) which triggered one or more filters
4280 public function spamPageWithContent( $match = false ) {
4281 global $wgOut, $wgLang;
4282 $this->textbox2
= $this->textbox1
;
4284 if ( is_array( $match ) ) {
4285 $match = $wgLang->listToText( $match );
4287 $wgOut->prepareErrorPage( $this->context
->msg( 'spamprotectiontitle' ) );
4289 $wgOut->addHTML( '<div id="spamprotected">' );
4290 $wgOut->addWikiMsg( 'spamprotectiontext' );
4292 $wgOut->addWikiMsg( 'spamprotectionmatch', wfEscapeWikiText( $match ) );
4294 $wgOut->addHTML( '</div>' );
4296 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
4299 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
4300 $this->showTextbox2();
4302 $wgOut->addReturnTo( $this->getContextTitle(), [ 'action' => 'edit' ] );
4306 * Check if the browser is on a blacklist of user-agents known to
4307 * mangle UTF-8 data on form submission. Returns true if Unicode
4308 * should make it through, false if it's known to be a problem.
4311 private function checkUnicodeCompliantBrowser() {
4312 global $wgBrowserBlackList, $wgRequest;
4314 $currentbrowser = $wgRequest->getHeader( 'User-Agent' );
4315 if ( $currentbrowser === false ) {
4316 // No User-Agent header sent? Trust it by default...
4320 foreach ( $wgBrowserBlackList as $browser ) {
4321 if ( preg_match( $browser, $currentbrowser ) ) {
4329 * Filter an input field through a Unicode de-armoring process if it
4330 * came from an old browser with known broken Unicode editing issues.
4332 * @param WebRequest $request
4333 * @param string $field
4336 protected function safeUnicodeInput( $request, $field ) {
4337 $text = rtrim( $request->getText( $field ) );
4338 return $request->getBool( 'safemode' )
4339 ?
$this->unmakeSafe( $text )
4344 * Filter an output field through a Unicode armoring process if it is
4345 * going to an old browser with known broken Unicode editing issues.
4347 * @param string $text
4350 protected function safeUnicodeOutput( $text ) {
4351 return $this->checkUnicodeCompliantBrowser()
4353 : $this->makeSafe( $text );
4357 * A number of web browsers are known to corrupt non-ASCII characters
4358 * in a UTF-8 text editing environment. To protect against this,
4359 * detected browsers will be served an armored version of the text,
4360 * with non-ASCII chars converted to numeric HTML character references.
4362 * Preexisting such character references will have a 0 added to them
4363 * to ensure that round-trips do not alter the original data.
4365 * @param string $invalue
4368 private function makeSafe( $invalue ) {
4369 // Armor existing references for reversibility.
4370 $invalue = strtr( $invalue, [ "&#x" => "�" ] );
4375 $valueLength = strlen( $invalue );
4376 for ( $i = 0; $i < $valueLength; $i++
) {
4377 $bytevalue = ord( $invalue[$i] );
4378 if ( $bytevalue <= 0x7F ) { // 0xxx xxxx
4379 $result .= chr( $bytevalue );
4381 } elseif ( $bytevalue <= 0xBF ) { // 10xx xxxx
4382 $working = $working << 6;
4383 $working +
= ( $bytevalue & 0x3F );
4385 if ( $bytesleft <= 0 ) {
4386 $result .= "&#x" . strtoupper( dechex( $working ) ) . ";";
4388 } elseif ( $bytevalue <= 0xDF ) { // 110x xxxx
4389 $working = $bytevalue & 0x1F;
4391 } elseif ( $bytevalue <= 0xEF ) { // 1110 xxxx
4392 $working = $bytevalue & 0x0F;
4394 } else { // 1111 0xxx
4395 $working = $bytevalue & 0x07;
4403 * Reverse the previously applied transliteration of non-ASCII characters
4404 * back to UTF-8. Used to protect data from corruption by broken web browsers
4405 * as listed in $wgBrowserBlackList.
4407 * @param string $invalue
4410 private function unmakeSafe( $invalue ) {
4412 $valueLength = strlen( $invalue );
4413 for ( $i = 0; $i < $valueLength; $i++
) {
4414 if ( ( substr( $invalue, $i, 3 ) == "&#x" ) && ( $invalue[$i +
3] != '0' ) ) {
4418 $hexstring .= $invalue[$i];
4420 } while ( ctype_xdigit( $invalue[$i] ) && ( $i < strlen( $invalue ) ) );
4422 // Do some sanity checks. These aren't needed for reversibility,
4423 // but should help keep the breakage down if the editor
4424 // breaks one of the entities whilst editing.
4425 if ( ( substr( $invalue, $i, 1 ) == ";" ) && ( strlen( $hexstring ) <= 6 ) ) {
4426 $codepoint = hexdec( $hexstring );
4427 $result .= UtfNormal\Utils
::codepointToUtf8( $codepoint );
4429 $result .= "&#x" . $hexstring . substr( $invalue, $i, 1 );
4432 $result .= substr( $invalue, $i, 1 );
4435 // reverse the transform that we made for reversibility reasons.
4436 return strtr( $result, [ "�" => "&#x" ] );