ApiQueryWatchlist: Handle empty wltypes
[mediawiki.git] / includes / EditPage.php
blob1f871e19417d50bf459edf6ea69149cb1c81ed9f
1 <?php
2 /**
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
20 * @file
23 use MediaWiki\Logger\LoggerFactory;
24 use MediaWiki\MediaWikiServices;
25 use Wikimedia\ScopedCallback;
27 /**
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
31 * interfaces.
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.
42 class EditPage {
43 /**
44 * Status: Article successfully updated
46 const AS_SUCCESS_UPDATE = 200;
48 /**
49 * Status: Article successfully created
51 const AS_SUCCESS_NEW_ARTICLE = 201;
53 /**
54 * Status: Article update aborted by a hook function
56 const AS_HOOK_ERROR = 210;
58 /**
59 * Status: A hook function returned an error
61 const AS_HOOK_ERROR_EXPECTED = 212;
63 /**
64 * Status: User is blocked from editing this page
66 const AS_BLOCKED_PAGE_FOR_USER = 215;
68 /**
69 * Status: Content too big (> $wgMaxArticleSize)
71 const AS_CONTENT_TOO_BIG = 216;
73 /**
74 * Status: this anonymous user is not allowed to edit this page
76 const AS_READ_ONLY_PAGE_ANON = 218;
78 /**
79 * Status: this logged in user is not allowed to edit this page
81 const AS_READ_ONLY_PAGE_LOGGED = 219;
83 /**
84 * Status: wiki is in readonly mode (wfReadOnly() == true)
86 const AS_READ_ONLY_PAGE = 220;
88 /**
89 * Status: rate limiter for action 'edit' was tripped
91 const AS_RATE_LIMITED = 221;
93 /**
94 * Status: article was deleted while editing and param wpRecreate == false or form
95 * was not posted
97 const AS_ARTICLE_WAS_DELETED = 222;
99 /**
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
134 const AS_END = 231;
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
165 * more details
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;
206 /** @var Article */
207 public $mArticle;
208 /** @var WikiPage */
209 private $page;
211 /** @var Title */
212 public $mTitle;
214 /** @var null|Title */
215 private $mContextTitle = null;
217 /** @var string */
218 public $action = 'submit';
220 /** @var bool */
221 public $isConflict = false;
223 /** @var bool */
224 public $isCssJsSubpage = false;
226 /** @var bool */
227 public $isCssSubpage = false;
229 /** @var bool */
230 public $isJsSubpage = false;
232 /** @var bool */
233 public $isWrongCaseCssJsPage = false;
235 /** @var bool New page or new section */
236 public $isNew = false;
238 /** @var bool */
239 public $deletedSinceEdit;
241 /** @var string */
242 public $formtype;
244 /** @var bool */
245 public $firsttime;
247 /** @var bool|stdClass */
248 public $lastDelete;
250 /** @var bool */
251 public $mTokenOk = false;
253 /** @var bool */
254 public $mTokenOkExceptSuffix = false;
256 /** @var bool */
257 public $mTriedSave = false;
259 /** @var bool */
260 public $incompleteForm = false;
262 /** @var bool */
263 public $tooBig = false;
265 /** @var bool */
266 public $missingComment = false;
268 /** @var bool */
269 public $missingSummary = false;
271 /** @var bool */
272 public $allowBlankSummary = false;
274 /** @var bool */
275 protected $blankArticle = false;
277 /** @var bool */
278 protected $allowBlankArticle = false;
280 /** @var bool */
281 protected $selfRedirect = false;
283 /** @var bool */
284 protected $allowSelfRedirect = false;
286 /** @var string */
287 public $autoSumm = '';
289 /** @var string */
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;
298 /** @var Revision|bool */
299 public $mBaseRevision = false;
301 /** @var bool */
302 public $mShowSummaryField = true;
304 # Form values
306 /** @var bool */
307 public $save = false;
309 /** @var bool */
310 public $preview = false;
312 /** @var bool */
313 public $diff = false;
315 /** @var bool */
316 public $minoredit = false;
318 /** @var bool */
319 public $watchthis = false;
321 /** @var bool */
322 public $recreate = false;
324 /** @var string */
325 public $textbox1 = '';
327 /** @var string */
328 public $textbox2 = '';
330 /** @var string */
331 public $summary = '';
333 /** @var bool */
334 public $nosummary = false;
336 /** @var string */
337 public $edittime = '';
339 /** @var integer */
340 private $editRevId = null;
342 /** @var string */
343 public $section = '';
345 /** @var string */
346 public $sectiontitle = '';
348 /** @var string */
349 public $starttime = '';
351 /** @var int */
352 public $oldid = 0;
354 /** @var int */
355 public $parentRevId = 0;
357 /** @var string */
358 public $editintro = '';
360 /** @var null */
361 public $scrolltop = null;
363 /** @var bool */
364 public $bot = true;
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;
395 /** @var bool */
396 protected $edit;
398 /** @var bool|int */
399 protected $contentLength = false;
402 * @var bool Set in ApiEditPage, based on ContentHandler::allowsDirectApiEditing
404 private $enableApiEditOverride = false;
407 * @var IContextSource
409 protected $context;
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();
432 * @return Article
434 public function getArticle() {
435 return $this->mArticle;
439 * @since 1.28
440 * @return IContextSource
442 public function getContext() {
443 return $this->context;
447 * @since 1.19
448 * @return Title
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.
468 * @return Title
470 public function getContextTitle() {
471 if ( is_null( $this->mContextTitle ) ) {
472 global $wgTitle;
473 return $wgTitle;
474 } else {
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.
483 * @return bool
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;
501 function submit() {
502 $this->edit();
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.
516 function edit() {
517 global $wgOut, $wgRequest, $wgUser;
518 // Allow extensions to modify/prevent this form or submission
519 if ( !Hooks::run( 'AlternateEdit', [ $this ] ) ) {
520 return;
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() );
528 return;
531 $this->importFormData( $wgRequest );
532 $this->firsttime = false;
534 if ( wfReadOnly() && $this->save ) {
535 // Force preview
536 $this->save = false;
537 $this->preview = true;
540 if ( $this->save ) {
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';
550 } else {
551 $this->formtype = 'initial';
555 $permErrors = $this->getEditPermissionErrors( $this->save ? 'secure' : 'full' );
556 if ( $permErrors ) {
557 wfDebug( __METHOD__ . ": User can't edit\n" );
558 // Auto-block user's IP if the account was "hard" blocked
559 if ( !wfReadOnly() ) {
560 $user = $wgUser;
561 DeferredUpdates::addCallableUpdate( function () use ( $user ) {
562 $user->spreadAnyEditBlock();
563 } );
565 $this->displayPermissionsError( $permErrors );
567 return;
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.
573 if ( $revision
574 && $revision->getContentModel() !== $this->contentModel
576 $prevRev = null;
577 if ( $this->undidRev ) {
578 $undidRevObj = Revision::newFromId( $this->undidRev );
579 $prevRev = $undidRevObj ? $undidRevObj->getPrevious() : null;
581 if ( !$this->undidRev
582 || !$prevRev
583 || $prevRev->getContentModel() !== $this->contentModel
585 $this->displayViewSourcePage(
586 $this->getContentObject(),
587 $this->context->msg(
588 'contentmodelediterror',
589 $revision->getContentModel(),
590 $this->contentModel
591 )->plain()
593 return;
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 ) {
607 $this->showIntro();
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 ) ) {
619 return;
623 # First time through: get contents, set time for conflict
624 # checking, etc.
625 if ( 'initial' == $this->formtype || $this->firsttime ) {
626 if ( $this->initialiseForm() === false ) {
627 $this->noSuchSectionPage();
628 return;
631 if ( !$this->mTitle->getArticleID() ) {
632 Hooks::run( 'EditFormPreloadText', [ &$this->textbox1, &$this->mTitle ] );
633 } else {
634 Hooks::run( 'EditFormInitialText', [ $this ] );
639 $this->showEditForm();
643 * @param string $rigor Same format as Title::getUserPermissionErrors()
644 * @return array
646 protected function getEditPermissionErrors( $rigor = 'secure' ) {
647 global $wgUser;
649 $permErrors = $this->mTitle->getUserPermissionsErrors( 'edit', $wgUser, $rigor );
650 # Can this title be created?
651 if ( !$this->mTitle->exists() ) {
652 $permErrors = array_merge(
653 $permErrors,
654 wfArrayDiff2(
655 $this->mTitle->getUserPermissionsErrors( 'create', $wgUser, $rigor ),
656 $permErrors
660 # Ignore some permissions errors when a user is just previewing/viewing diffs
661 $remove = [];
662 foreach ( $permErrors as $error ) {
663 if ( ( $this->preview || $this->diff )
664 && (
665 $error[0] == 'blockedtext' ||
666 $error[0] == 'autoblockedtext' ||
667 $error[0] == 'systemblockedtext'
670 $remove[] = $error;
673 $permErrors = wfArrayDiff2( $permErrors, $remove );
675 return $permErrors;
679 * Display a permissions error page, like OutputPage::showPermissionsErrorPage(),
680 * but with the following differences:
681 * - If redlink=1, the user will be redirected to the page
682 * - If there is content to display or the error occurs while either saving,
683 * previewing or showing the difference, it will be a
684 * "View source for ..." page displaying the source code after the error message.
686 * @since 1.19
687 * @param array $permErrors Array of permissions errors, as returned by
688 * Title::getUserPermissionsErrors().
689 * @throws PermissionsError
691 protected function displayPermissionsError( array $permErrors ) {
692 global $wgRequest, $wgOut;
694 if ( $wgRequest->getBool( 'redlink' ) ) {
695 // The edit page was reached via a red link.
696 // Redirect to the article page and let them click the edit tab if
697 // they really want a permission error.
698 $wgOut->redirect( $this->mTitle->getFullURL() );
699 return;
702 $content = $this->getContentObject();
704 # Use the normal message if there's nothing to display
705 if ( $this->firsttime && ( !$content || $content->isEmpty() ) ) {
706 $action = $this->mTitle->exists() ? 'edit' :
707 ( $this->mTitle->isTalkPage() ? 'createtalk' : 'createpage' );
708 throw new PermissionsError( $action, $permErrors );
711 $this->displayViewSourcePage(
712 $content,
713 $wgOut->formatPermissionsErrorMessage( $permErrors, 'edit' )
718 * Display a read-only View Source page
719 * @param Content $content content object
720 * @param string $errorMessage additional wikitext error message to display
722 protected function displayViewSourcePage( Content $content, $errorMessage = '' ) {
723 global $wgOut;
725 Hooks::run( 'EditPage::showReadOnlyForm:initial', [ $this, &$wgOut ] );
727 $wgOut->setRobotPolicy( 'noindex,nofollow' );
728 $wgOut->setPageTitle( $this->context->msg(
729 'viewsource-title',
730 $this->getContextTitle()->getPrefixedText()
731 ) );
732 $wgOut->addBacklinkSubtitle( $this->getContextTitle() );
733 $wgOut->addHTML( $this->editFormPageTop );
734 $wgOut->addHTML( $this->editFormTextTop );
736 if ( $errorMessage !== '' ) {
737 $wgOut->addWikiText( $errorMessage );
738 $wgOut->addHTML( "<hr />\n" );
741 # If the user made changes, preserve them when showing the markup
742 # (This happens when a user is blocked during edit, for instance)
743 if ( !$this->firsttime ) {
744 $text = $this->textbox1;
745 $wgOut->addWikiMsg( 'viewyourtext' );
746 } else {
747 try {
748 $text = $this->toEditText( $content );
749 } catch ( MWException $e ) {
750 # Serialize using the default format if the content model is not supported
751 # (e.g. for an old revision with a different model)
752 $text = $content->serialize();
754 $wgOut->addWikiMsg( 'viewsourcetext' );
757 $wgOut->addHTML( $this->editFormTextBeforeContent );
758 $this->showTextbox( $text, 'wpTextbox1', [ 'readonly' ] );
759 $wgOut->addHTML( $this->editFormTextAfterContent );
761 $wgOut->addHTML( $this->makeTemplatesOnThisPageList( $this->getTemplates() ) );
763 $wgOut->addModules( 'mediawiki.action.edit.collapsibleFooter' );
765 $wgOut->addHTML( $this->editFormTextBottom );
766 if ( $this->mTitle->exists() ) {
767 $wgOut->returnToMain( null, $this->mTitle );
772 * Should we show a preview when the edit form is first shown?
774 * @return bool
776 protected function previewOnOpen() {
777 global $wgRequest, $wgUser, $wgPreviewOnOpenNamespaces;
778 if ( $wgRequest->getVal( 'preview' ) == 'yes' ) {
779 // Explicit override from request
780 return true;
781 } elseif ( $wgRequest->getVal( 'preview' ) == 'no' ) {
782 // Explicit override from request
783 return false;
784 } elseif ( $this->section == 'new' ) {
785 // Nothing *to* preview for new sections
786 return false;
787 } elseif ( ( $wgRequest->getVal( 'preload' ) !== null || $this->mTitle->exists() )
788 && $wgUser->getOption( 'previewonfirst' )
790 // Standard preference behavior
791 return true;
792 } elseif ( !$this->mTitle->exists()
793 && isset( $wgPreviewOnOpenNamespaces[$this->mTitle->getNamespace()] )
794 && $wgPreviewOnOpenNamespaces[$this->mTitle->getNamespace()]
796 // Categories are special
797 return true;
798 } else {
799 return false;
804 * Checks whether the user entered a skin name in uppercase,
805 * e.g. "User:Example/Monobook.css" instead of "monobook.css"
807 * @return bool
809 protected function isWrongCaseCssJsPage() {
810 if ( $this->mTitle->isCssJsSubpage() ) {
811 $name = $this->mTitle->getSkinFromCssJsSubpage();
812 $skins = array_merge(
813 array_keys( Skin::getSkinNames() ),
814 [ 'common' ]
816 return !in_array( $name, $skins )
817 && in_array( strtolower( $name ), $skins );
818 } else {
819 return false;
824 * Returns whether section editing is supported for the current page.
825 * Subclasses may override this to replace the default behavior, which is
826 * to check ContentHandler::supportsSections.
828 * @return bool True if this edit page supports sections, false otherwise.
830 protected function isSectionEditSupported() {
831 $contentHandler = ContentHandler::getForTitle( $this->mTitle );
832 return $contentHandler->supportsSections();
836 * This function collects the form data and uses it to populate various member variables.
837 * @param WebRequest $request
838 * @throws ErrorPageError
840 function importFormData( &$request ) {
841 global $wgContLang, $wgUser;
843 # Section edit can come from either the form or a link
844 $this->section = $request->getVal( 'wpSection', $request->getVal( 'section' ) );
846 if ( $this->section !== null && $this->section !== '' && !$this->isSectionEditSupported() ) {
847 throw new ErrorPageError( 'sectioneditnotsupported-title', 'sectioneditnotsupported-text' );
850 $this->isNew = !$this->mTitle->exists() || $this->section == 'new';
852 if ( $request->wasPosted() ) {
853 # These fields need to be checked for encoding.
854 # Also remove trailing whitespace, but don't remove _initial_
855 # whitespace from the text boxes. This may be significant formatting.
856 $this->textbox1 = $this->safeUnicodeInput( $request, 'wpTextbox1' );
857 if ( !$request->getCheck( 'wpTextbox2' ) ) {
858 // Skip this if wpTextbox2 has input, it indicates that we came
859 // from a conflict page with raw page text, not a custom form
860 // modified by subclasses
861 $textbox1 = $this->importContentFormData( $request );
862 if ( $textbox1 !== null ) {
863 $this->textbox1 = $textbox1;
867 # Truncate for whole multibyte characters
868 $this->summary = $wgContLang->truncate( $request->getText( 'wpSummary' ), 255 );
870 # If the summary consists of a heading, e.g. '==Foobar==', extract the title from the
871 # header syntax, e.g. 'Foobar'. This is mainly an issue when we are using wpSummary for
872 # section titles.
873 $this->summary = preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->summary );
875 # Treat sectiontitle the same way as summary.
876 # Note that wpSectionTitle is not yet a part of the actual edit form, as wpSummary is
877 # currently doing double duty as both edit summary and section title. Right now this
878 # is just to allow API edits to work around this limitation, but this should be
879 # incorporated into the actual edit form when EditPage is rewritten (Bugs 18654, 26312).
880 $this->sectiontitle = $wgContLang->truncate( $request->getText( 'wpSectionTitle' ), 255 );
881 $this->sectiontitle = preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->sectiontitle );
883 $this->edittime = $request->getVal( 'wpEdittime' );
884 $this->editRevId = $request->getIntOrNull( 'editRevId' );
885 $this->starttime = $request->getVal( 'wpStarttime' );
887 $undidRev = $request->getInt( 'wpUndidRevision' );
888 if ( $undidRev ) {
889 $this->undidRev = $undidRev;
892 $this->scrolltop = $request->getIntOrNull( 'wpScrolltop' );
894 if ( $this->textbox1 === '' && $request->getVal( 'wpTextbox1' ) === null ) {
895 // wpTextbox1 field is missing, possibly due to being "too big"
896 // according to some filter rules such as Suhosin's setting for
897 // suhosin.request.max_value_length (d'oh)
898 $this->incompleteForm = true;
899 } else {
900 // If we receive the last parameter of the request, we can fairly
901 // claim the POST request has not been truncated.
903 // TODO: softened the check for cutover. Once we determine
904 // that it is safe, we should complete the transition by
905 // removing the "edittime" clause.
906 $this->incompleteForm = ( !$request->getVal( 'wpUltimateParam' )
907 && is_null( $this->edittime ) );
909 if ( $this->incompleteForm ) {
910 # If the form is incomplete, force to preview.
911 wfDebug( __METHOD__ . ": Form data appears to be incomplete\n" );
912 wfDebug( "POST DATA: " . var_export( $_POST, true ) . "\n" );
913 $this->preview = true;
914 } else {
915 $this->preview = $request->getCheck( 'wpPreview' );
916 $this->diff = $request->getCheck( 'wpDiff' );
918 // Remember whether a save was requested, so we can indicate
919 // if we forced preview due to session failure.
920 $this->mTriedSave = !$this->preview;
922 if ( $this->tokenOk( $request ) ) {
923 # Some browsers will not report any submit button
924 # if the user hits enter in the comment box.
925 # The unmarked state will be assumed to be a save,
926 # if the form seems otherwise complete.
927 wfDebug( __METHOD__ . ": Passed token check.\n" );
928 } elseif ( $this->diff ) {
929 # Failed token check, but only requested "Show Changes".
930 wfDebug( __METHOD__ . ": Failed token check; Show Changes requested.\n" );
931 } else {
932 # Page might be a hack attempt posted from
933 # an external site. Preview instead of saving.
934 wfDebug( __METHOD__ . ": Failed token check; forcing preview\n" );
935 $this->preview = true;
938 $this->save = !$this->preview && !$this->diff;
939 if ( !preg_match( '/^\d{14}$/', $this->edittime ) ) {
940 $this->edittime = null;
943 if ( !preg_match( '/^\d{14}$/', $this->starttime ) ) {
944 $this->starttime = null;
947 $this->recreate = $request->getCheck( 'wpRecreate' );
949 $this->minoredit = $request->getCheck( 'wpMinoredit' );
950 $this->watchthis = $request->getCheck( 'wpWatchthis' );
952 # Don't force edit summaries when a user is editing their own user or talk page
953 if ( ( $this->mTitle->mNamespace == NS_USER || $this->mTitle->mNamespace == NS_USER_TALK )
954 && $this->mTitle->getText() == $wgUser->getName()
956 $this->allowBlankSummary = true;
957 } else {
958 $this->allowBlankSummary = $request->getBool( 'wpIgnoreBlankSummary' )
959 || !$wgUser->getOption( 'forceeditsummary' );
962 $this->autoSumm = $request->getText( 'wpAutoSummary' );
964 $this->allowBlankArticle = $request->getBool( 'wpIgnoreBlankArticle' );
965 $this->allowSelfRedirect = $request->getBool( 'wpIgnoreSelfRedirect' );
967 $changeTags = $request->getVal( 'wpChangeTags' );
968 if ( is_null( $changeTags ) || $changeTags === '' ) {
969 $this->changeTags = [];
970 } else {
971 $this->changeTags = array_filter( array_map( 'trim', explode( ',',
972 $changeTags ) ) );
974 } else {
975 # Not a posted form? Start with nothing.
976 wfDebug( __METHOD__ . ": Not a posted form.\n" );
977 $this->textbox1 = '';
978 $this->summary = '';
979 $this->sectiontitle = '';
980 $this->edittime = '';
981 $this->editRevId = null;
982 $this->starttime = wfTimestampNow();
983 $this->edit = false;
984 $this->preview = false;
985 $this->save = false;
986 $this->diff = false;
987 $this->minoredit = false;
988 // Watch may be overridden by request parameters
989 $this->watchthis = $request->getBool( 'watchthis', false );
990 $this->recreate = false;
992 // When creating a new section, we can preload a section title by passing it as the
993 // preloadtitle parameter in the URL (Bug 13100)
994 if ( $this->section == 'new' && $request->getVal( 'preloadtitle' ) ) {
995 $this->sectiontitle = $request->getVal( 'preloadtitle' );
996 // Once wpSummary isn't being use for setting section titles, we should delete this.
997 $this->summary = $request->getVal( 'preloadtitle' );
998 } elseif ( $this->section != 'new' && $request->getVal( 'summary' ) ) {
999 $this->summary = $request->getText( 'summary' );
1000 if ( $this->summary !== '' ) {
1001 $this->hasPresetSummary = true;
1005 if ( $request->getVal( 'minor' ) ) {
1006 $this->minoredit = true;
1010 $this->oldid = $request->getInt( 'oldid' );
1011 $this->parentRevId = $request->getInt( 'parentRevId' );
1013 $this->bot = $request->getBool( 'bot', true );
1014 $this->nosummary = $request->getBool( 'nosummary' );
1016 // May be overridden by revision.
1017 $this->contentModel = $request->getText( 'model', $this->contentModel );
1018 // May be overridden by revision.
1019 $this->contentFormat = $request->getText( 'format', $this->contentFormat );
1021 try {
1022 $handler = ContentHandler::getForModelID( $this->contentModel );
1023 } catch ( MWUnknownContentModelException $e ) {
1024 throw new ErrorPageError(
1025 'editpage-invalidcontentmodel-title',
1026 'editpage-invalidcontentmodel-text',
1027 [ $this->contentModel ]
1031 if ( !$handler->isSupportedFormat( $this->contentFormat ) ) {
1032 throw new ErrorPageError(
1033 'editpage-notsupportedcontentformat-title',
1034 'editpage-notsupportedcontentformat-text',
1035 [ $this->contentFormat, ContentHandler::getLocalizedName( $this->contentModel ) ]
1040 * @todo Check if the desired model is allowed in this namespace, and if
1041 * a transition from the page's current model to the new model is
1042 * allowed.
1045 $this->editintro = $request->getText( 'editintro',
1046 // Custom edit intro for new sections
1047 $this->section === 'new' ? 'MediaWiki:addsection-editintro' : '' );
1049 // Allow extensions to modify form data
1050 Hooks::run( 'EditPage::importFormData', [ $this, $request ] );
1054 * Subpage overridable method for extracting the page content data from the
1055 * posted form to be placed in $this->textbox1, if using customized input
1056 * this method should be overridden and return the page text that will be used
1057 * for saving, preview parsing and so on...
1059 * @param WebRequest $request
1060 * @return string|null
1062 protected function importContentFormData( &$request ) {
1063 return; // Don't do anything, EditPage already extracted wpTextbox1
1067 * Initialise form fields in the object
1068 * Called on the first invocation, e.g. when a user clicks an edit link
1069 * @return bool If the requested section is valid
1071 function initialiseForm() {
1072 global $wgUser;
1073 $this->edittime = $this->page->getTimestamp();
1074 $this->editRevId = $this->page->getLatest();
1076 $content = $this->getContentObject( false ); # TODO: track content object?!
1077 if ( $content === false ) {
1078 return false;
1080 $this->textbox1 = $this->toEditText( $content );
1082 // activate checkboxes if user wants them to be always active
1083 # Sort out the "watch" checkbox
1084 if ( $wgUser->getOption( 'watchdefault' ) ) {
1085 # Watch all edits
1086 $this->watchthis = true;
1087 } elseif ( $wgUser->getOption( 'watchcreations' ) && !$this->mTitle->exists() ) {
1088 # Watch creations
1089 $this->watchthis = true;
1090 } elseif ( $wgUser->isWatched( $this->mTitle ) ) {
1091 # Already watched
1092 $this->watchthis = true;
1094 if ( $wgUser->getOption( 'minordefault' ) && !$this->isNew ) {
1095 $this->minoredit = true;
1097 if ( $this->textbox1 === false ) {
1098 return false;
1100 return true;
1104 * @param Content|null $def_content The default value to return
1106 * @return Content|null Content on success, $def_content for invalid sections
1108 * @since 1.21
1110 protected function getContentObject( $def_content = null ) {
1111 global $wgOut, $wgRequest, $wgUser, $wgContLang;
1113 $content = false;
1115 // For message page not locally set, use the i18n message.
1116 // For other non-existent articles, use preload text if any.
1117 if ( !$this->mTitle->exists() || $this->section == 'new' ) {
1118 if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI && $this->section != 'new' ) {
1119 # If this is a system message, get the default text.
1120 $msg = $this->mTitle->getDefaultMessageText();
1122 $content = $this->toEditContent( $msg );
1124 if ( $content === false ) {
1125 # If requested, preload some text.
1126 $preload = $wgRequest->getVal( 'preload',
1127 // Custom preload text for new sections
1128 $this->section === 'new' ? 'MediaWiki:addsection-preload' : '' );
1129 $params = $wgRequest->getArray( 'preloadparams', [] );
1131 $content = $this->getPreloadedContent( $preload, $params );
1133 // For existing pages, get text based on "undo" or section parameters.
1134 } else {
1135 if ( $this->section != '' ) {
1136 // Get section edit text (returns $def_text for invalid sections)
1137 $orig = $this->getOriginalContent( $wgUser );
1138 $content = $orig ? $orig->getSection( $this->section ) : null;
1140 if ( !$content ) {
1141 $content = $def_content;
1143 } else {
1144 $undoafter = $wgRequest->getInt( 'undoafter' );
1145 $undo = $wgRequest->getInt( 'undo' );
1147 if ( $undo > 0 && $undoafter > 0 ) {
1148 $undorev = Revision::newFromId( $undo );
1149 $oldrev = Revision::newFromId( $undoafter );
1151 # Sanity check, make sure it's the right page,
1152 # the revisions exist and they were not deleted.
1153 # Otherwise, $content will be left as-is.
1154 if ( !is_null( $undorev ) && !is_null( $oldrev ) &&
1155 !$undorev->isDeleted( Revision::DELETED_TEXT ) &&
1156 !$oldrev->isDeleted( Revision::DELETED_TEXT )
1158 $content = $this->page->getUndoContent( $undorev, $oldrev );
1160 if ( $content === false ) {
1161 # Warn the user that something went wrong
1162 $undoMsg = 'failure';
1163 } else {
1164 $oldContent = $this->page->getContent( Revision::RAW );
1165 $popts = ParserOptions::newFromUserAndLang( $wgUser, $wgContLang );
1166 $newContent = $content->preSaveTransform( $this->mTitle, $wgUser, $popts );
1167 if ( $newContent->getModel() !== $oldContent->getModel() ) {
1168 // The undo may change content
1169 // model if its reverting the top
1170 // edit. This can result in
1171 // mismatched content model/format.
1172 $this->contentModel = $newContent->getModel();
1173 $this->contentFormat = $oldrev->getContentFormat();
1176 if ( $newContent->equals( $oldContent ) ) {
1177 # Tell the user that the undo results in no change,
1178 # i.e. the revisions were already undone.
1179 $undoMsg = 'nochange';
1180 $content = false;
1181 } else {
1182 # Inform the user of our success and set an automatic edit summary
1183 $undoMsg = 'success';
1185 # If we just undid one rev, use an autosummary
1186 $firstrev = $oldrev->getNext();
1187 if ( $firstrev && $firstrev->getId() == $undo ) {
1188 $userText = $undorev->getUserText();
1189 if ( $userText === '' ) {
1190 $undoSummary = $this->context->msg(
1191 'undo-summary-username-hidden',
1192 $undo
1193 )->inContentLanguage()->text();
1194 } else {
1195 $undoSummary = $this->context->msg(
1196 'undo-summary',
1197 $undo,
1198 $userText
1199 )->inContentLanguage()->text();
1201 if ( $this->summary === '' ) {
1202 $this->summary = $undoSummary;
1203 } else {
1204 $this->summary = $undoSummary . $this->context->msg( 'colon-separator' )
1205 ->inContentLanguage()->text() . $this->summary;
1207 $this->undidRev = $undo;
1209 $this->formtype = 'diff';
1212 } else {
1213 // Failed basic sanity checks.
1214 // Older revisions may have been removed since the link
1215 // was created, or we may simply have got bogus input.
1216 $undoMsg = 'norev';
1219 // Messages: undo-success, undo-failure, undo-norev, undo-nochange
1220 $class = ( $undoMsg == 'success' ? '' : 'error ' ) . "mw-undo-{$undoMsg}";
1221 $this->editFormPageTop .= $wgOut->parse( "<div class=\"{$class}\">" .
1222 $this->context->msg( 'undo-' . $undoMsg )->plain() . '</div>', true, /* interface */true );
1225 if ( $content === false ) {
1226 $content = $this->getOriginalContent( $wgUser );
1231 return $content;
1235 * Get the content of the wanted revision, without section extraction.
1237 * The result of this function can be used to compare user's input with
1238 * section replaced in its context (using WikiPage::replaceSectionAtRev())
1239 * to the original text of the edit.
1241 * This differs from Article::getContent() that when a missing revision is
1242 * encountered the result will be null and not the
1243 * 'missing-revision' message.
1245 * @since 1.19
1246 * @param User $user The user to get the revision for
1247 * @return Content|null
1249 private function getOriginalContent( User $user ) {
1250 if ( $this->section == 'new' ) {
1251 return $this->getCurrentContent();
1253 $revision = $this->mArticle->getRevisionFetched();
1254 if ( $revision === null ) {
1255 if ( !$this->contentModel ) {
1256 $this->contentModel = $this->getTitle()->getContentModel();
1258 $handler = ContentHandler::getForModelID( $this->contentModel );
1260 return $handler->makeEmptyContent();
1262 $content = $revision->getContent( Revision::FOR_THIS_USER, $user );
1263 return $content;
1267 * Get the edit's parent revision ID
1269 * The "parent" revision is the ancestor that should be recorded in this
1270 * page's revision history. It is either the revision ID of the in-memory
1271 * article content, or in the case of a 3-way merge in order to rebase
1272 * across a recoverable edit conflict, the ID of the newer revision to
1273 * which we have rebased this page.
1275 * @since 1.27
1276 * @return int Revision ID
1278 public function getParentRevId() {
1279 if ( $this->parentRevId ) {
1280 return $this->parentRevId;
1281 } else {
1282 return $this->mArticle->getRevIdFetched();
1287 * Get the current content of the page. This is basically similar to
1288 * WikiPage::getContent( Revision::RAW ) except that when the page doesn't exist an empty
1289 * content object is returned instead of null.
1291 * @since 1.21
1292 * @return Content
1294 protected function getCurrentContent() {
1295 $rev = $this->page->getRevision();
1296 $content = $rev ? $rev->getContent( Revision::RAW ) : null;
1298 if ( $content === false || $content === null ) {
1299 if ( !$this->contentModel ) {
1300 $this->contentModel = $this->getTitle()->getContentModel();
1302 $handler = ContentHandler::getForModelID( $this->contentModel );
1304 return $handler->makeEmptyContent();
1305 } elseif ( !$this->undidRev ) {
1306 // Content models should always be the same since we error
1307 // out if they are different before this point (in ->edit()).
1308 // The exception being, during an undo, the current revision might
1309 // differ from the prior revision.
1310 $logger = LoggerFactory::getInstance( 'editpage' );
1311 if ( $this->contentModel !== $rev->getContentModel() ) {
1312 $logger->warning( "Overriding content model from current edit {prev} to {new}", [
1313 'prev' => $this->contentModel,
1314 'new' => $rev->getContentModel(),
1315 'title' => $this->getTitle()->getPrefixedDBkey(),
1316 'method' => __METHOD__
1317 ] );
1318 $this->contentModel = $rev->getContentModel();
1321 // Given that the content models should match, the current selected
1322 // format should be supported.
1323 if ( !$content->isSupportedFormat( $this->contentFormat ) ) {
1324 $logger->warning( "Current revision content format unsupported. Overriding {prev} to {new}", [
1326 'prev' => $this->contentFormat,
1327 'new' => $rev->getContentFormat(),
1328 'title' => $this->getTitle()->getPrefixedDBkey(),
1329 'method' => __METHOD__
1330 ] );
1331 $this->contentFormat = $rev->getContentFormat();
1334 return $content;
1338 * Use this method before edit() to preload some content into the edit box
1340 * @param Content $content
1342 * @since 1.21
1344 public function setPreloadedContent( Content $content ) {
1345 $this->mPreloadContent = $content;
1349 * Get the contents to be preloaded into the box, either set by
1350 * an earlier setPreloadText() or by loading the given page.
1352 * @param string $preload Representing the title to preload from.
1353 * @param array $params Parameters to use (interface-message style) in the preloaded text
1355 * @return Content
1357 * @since 1.21
1359 protected function getPreloadedContent( $preload, $params = [] ) {
1360 global $wgUser;
1362 if ( !empty( $this->mPreloadContent ) ) {
1363 return $this->mPreloadContent;
1366 $handler = ContentHandler::getForModelID( $this->contentModel );
1368 if ( $preload === '' ) {
1369 return $handler->makeEmptyContent();
1372 $title = Title::newFromText( $preload );
1373 # Check for existence to avoid getting MediaWiki:Noarticletext
1374 if ( $title === null || !$title->exists() || !$title->userCan( 'read', $wgUser ) ) {
1375 // TODO: somehow show a warning to the user!
1376 return $handler->makeEmptyContent();
1379 $page = WikiPage::factory( $title );
1380 if ( $page->isRedirect() ) {
1381 $title = $page->getRedirectTarget();
1382 # Same as before
1383 if ( $title === null || !$title->exists() || !$title->userCan( 'read', $wgUser ) ) {
1384 // TODO: somehow show a warning to the user!
1385 return $handler->makeEmptyContent();
1387 $page = WikiPage::factory( $title );
1390 $parserOptions = ParserOptions::newFromUser( $wgUser );
1391 $content = $page->getContent( Revision::RAW );
1393 if ( !$content ) {
1394 // TODO: somehow show a warning to the user!
1395 return $handler->makeEmptyContent();
1398 if ( $content->getModel() !== $handler->getModelID() ) {
1399 $converted = $content->convert( $handler->getModelID() );
1401 if ( !$converted ) {
1402 // TODO: somehow show a warning to the user!
1403 wfDebug( "Attempt to preload incompatible content: " .
1404 "can't convert " . $content->getModel() .
1405 " to " . $handler->getModelID() );
1407 return $handler->makeEmptyContent();
1410 $content = $converted;
1413 return $content->preloadTransform( $title, $parserOptions, $params );
1417 * Make sure the form isn't faking a user's credentials.
1419 * @param WebRequest $request
1420 * @return bool
1421 * @private
1423 function tokenOk( &$request ) {
1424 global $wgUser;
1425 $token = $request->getVal( 'wpEditToken' );
1426 $this->mTokenOk = $wgUser->matchEditToken( $token );
1427 $this->mTokenOkExceptSuffix = $wgUser->matchEditTokenNoSuffix( $token );
1428 return $this->mTokenOk;
1432 * Sets post-edit cookie indicating the user just saved a particular revision.
1434 * This uses a temporary cookie for each revision ID so separate saves will never
1435 * interfere with each other.
1437 * The cookie is deleted in the mediawiki.action.view.postEdit JS module after
1438 * the redirect. It must be clearable by JavaScript code, so it must not be
1439 * marked HttpOnly. The JavaScript code converts the cookie to a wgPostEdit config
1440 * variable.
1442 * If the variable were set on the server, it would be cached, which is unwanted
1443 * since the post-edit state should only apply to the load right after the save.
1445 * @param int $statusValue The status value (to check for new article status)
1447 protected function setPostEditCookie( $statusValue ) {
1448 $revisionId = $this->page->getLatest();
1449 $postEditKey = self::POST_EDIT_COOKIE_KEY_PREFIX . $revisionId;
1451 $val = 'saved';
1452 if ( $statusValue == self::AS_SUCCESS_NEW_ARTICLE ) {
1453 $val = 'created';
1454 } elseif ( $this->oldid ) {
1455 $val = 'restored';
1458 $response = RequestContext::getMain()->getRequest()->response();
1459 $response->setCookie( $postEditKey, $val, time() + self::POST_EDIT_COOKIE_DURATION, [
1460 'httpOnly' => false,
1461 ] );
1465 * Attempt submission
1466 * @param array|bool $resultDetails See docs for $result in internalAttemptSave
1467 * @throws UserBlockedError|ReadOnlyError|ThrottledError|PermissionsError
1468 * @return Status The resulting status object.
1470 public function attemptSave( &$resultDetails = false ) {
1471 global $wgUser;
1473 # Allow bots to exempt some edits from bot flagging
1474 $bot = $wgUser->isAllowed( 'bot' ) && $this->bot;
1475 $status = $this->internalAttemptSave( $resultDetails, $bot );
1477 Hooks::run( 'EditPage::attemptSave:after', [ $this, $status, $resultDetails ] );
1479 return $status;
1483 * Handle status, such as after attempt save
1485 * @param Status $status
1486 * @param array|bool $resultDetails
1488 * @throws ErrorPageError
1489 * @return bool False, if output is done, true if rest of the form should be displayed
1491 private function handleStatus( Status $status, $resultDetails ) {
1492 global $wgUser, $wgOut;
1495 * @todo FIXME: once the interface for internalAttemptSave() is made
1496 * nicer, this should use the message in $status
1498 if ( $status->value == self::AS_SUCCESS_UPDATE
1499 || $status->value == self::AS_SUCCESS_NEW_ARTICLE
1501 $this->didSave = true;
1502 if ( !$resultDetails['nullEdit'] ) {
1503 $this->setPostEditCookie( $status->value );
1507 // "wpExtraQueryRedirect" is a hidden input to modify
1508 // after save URL and is not used by actual edit form
1509 $request = RequestContext::getMain()->getRequest();
1510 $extraQueryRedirect = $request->getVal( 'wpExtraQueryRedirect' );
1512 switch ( $status->value ) {
1513 case self::AS_HOOK_ERROR_EXPECTED:
1514 case self::AS_CONTENT_TOO_BIG:
1515 case self::AS_ARTICLE_WAS_DELETED:
1516 case self::AS_CONFLICT_DETECTED:
1517 case self::AS_SUMMARY_NEEDED:
1518 case self::AS_TEXTBOX_EMPTY:
1519 case self::AS_MAX_ARTICLE_SIZE_EXCEEDED:
1520 case self::AS_END:
1521 case self::AS_BLANK_ARTICLE:
1522 case self::AS_SELF_REDIRECT:
1523 return true;
1525 case self::AS_HOOK_ERROR:
1526 return false;
1528 case self::AS_CANNOT_USE_CUSTOM_MODEL:
1529 case self::AS_PARSE_ERROR:
1530 $wgOut->addWikiText( '<div class="error">' . "\n" . $status->getWikiText() . '</div>' );
1531 return true;
1533 case self::AS_SUCCESS_NEW_ARTICLE:
1534 $query = $resultDetails['redirect'] ? 'redirect=no' : '';
1535 if ( $extraQueryRedirect ) {
1536 if ( $query === '' ) {
1537 $query = $extraQueryRedirect;
1538 } else {
1539 $query = $query . '&' . $extraQueryRedirect;
1542 $anchor = isset( $resultDetails['sectionanchor'] ) ? $resultDetails['sectionanchor'] : '';
1543 $wgOut->redirect( $this->mTitle->getFullURL( $query ) . $anchor );
1544 return false;
1546 case self::AS_SUCCESS_UPDATE:
1547 $extraQuery = '';
1548 $sectionanchor = $resultDetails['sectionanchor'];
1550 // Give extensions a chance to modify URL query on update
1551 Hooks::run(
1552 'ArticleUpdateBeforeRedirect',
1553 [ $this->mArticle, &$sectionanchor, &$extraQuery ]
1556 if ( $resultDetails['redirect'] ) {
1557 if ( $extraQuery == '' ) {
1558 $extraQuery = 'redirect=no';
1559 } else {
1560 $extraQuery = 'redirect=no&' . $extraQuery;
1563 if ( $extraQueryRedirect ) {
1564 if ( $extraQuery === '' ) {
1565 $extraQuery = $extraQueryRedirect;
1566 } else {
1567 $extraQuery = $extraQuery . '&' . $extraQueryRedirect;
1571 $wgOut->redirect( $this->mTitle->getFullURL( $extraQuery ) . $sectionanchor );
1572 return false;
1574 case self::AS_SPAM_ERROR:
1575 $this->spamPageWithContent( $resultDetails['spam'] );
1576 return false;
1578 case self::AS_BLOCKED_PAGE_FOR_USER:
1579 throw new UserBlockedError( $wgUser->getBlock() );
1581 case self::AS_IMAGE_REDIRECT_ANON:
1582 case self::AS_IMAGE_REDIRECT_LOGGED:
1583 throw new PermissionsError( 'upload' );
1585 case self::AS_READ_ONLY_PAGE_ANON:
1586 case self::AS_READ_ONLY_PAGE_LOGGED:
1587 throw new PermissionsError( 'edit' );
1589 case self::AS_READ_ONLY_PAGE:
1590 throw new ReadOnlyError;
1592 case self::AS_RATE_LIMITED:
1593 throw new ThrottledError();
1595 case self::AS_NO_CREATE_PERMISSION:
1596 $permission = $this->mTitle->isTalkPage() ? 'createtalk' : 'createpage';
1597 throw new PermissionsError( $permission );
1599 case self::AS_NO_CHANGE_CONTENT_MODEL:
1600 throw new PermissionsError( 'editcontentmodel' );
1602 default:
1603 // We don't recognize $status->value. The only way that can happen
1604 // is if an extension hook aborted from inside ArticleSave.
1605 // Render the status object into $this->hookError
1606 // FIXME this sucks, we should just use the Status object throughout
1607 $this->hookError = '<div class="error">' ."\n" . $status->getWikiText() .
1608 '</div>';
1609 return true;
1614 * Run hooks that can filter edits just before they get saved.
1616 * @param Content $content The Content to filter.
1617 * @param Status $status For reporting the outcome to the caller
1618 * @param User $user The user performing the edit
1620 * @return bool
1622 protected function runPostMergeFilters( Content $content, Status $status, User $user ) {
1623 // Run old style post-section-merge edit filter
1624 if ( !ContentHandler::runLegacyHooks( 'EditFilterMerged',
1625 [ $this, $content, &$this->hookError, $this->summary ],
1626 '1.21'
1627 ) ) {
1628 # Error messages etc. could be handled within the hook...
1629 $status->fatal( 'hookaborted' );
1630 $status->value = self::AS_HOOK_ERROR;
1631 return false;
1632 } elseif ( $this->hookError != '' ) {
1633 # ...or the hook could be expecting us to produce an error
1634 $status->fatal( 'hookaborted' );
1635 $status->value = self::AS_HOOK_ERROR_EXPECTED;
1636 return false;
1639 // Run new style post-section-merge edit filter
1640 if ( !Hooks::run( 'EditFilterMergedContent',
1641 [ $this->mArticle->getContext(), $content, $status, $this->summary,
1642 $user, $this->minoredit ] )
1644 # Error messages etc. could be handled within the hook...
1645 if ( $status->isGood() ) {
1646 $status->fatal( 'hookaborted' );
1647 // Not setting $this->hookError here is a hack to allow the hook
1648 // to cause a return to the edit page without $this->hookError
1649 // being set. This is used by ConfirmEdit to display a captcha
1650 // without any error message cruft.
1651 } else {
1652 $this->hookError = $status->getWikiText();
1654 // Use the existing $status->value if the hook set it
1655 if ( !$status->value ) {
1656 $status->value = self::AS_HOOK_ERROR;
1658 return false;
1659 } elseif ( !$status->isOK() ) {
1660 # ...or the hook could be expecting us to produce an error
1661 // FIXME this sucks, we should just use the Status object throughout
1662 $this->hookError = $status->getWikiText();
1663 $status->fatal( 'hookaborted' );
1664 $status->value = self::AS_HOOK_ERROR_EXPECTED;
1665 return false;
1668 return true;
1672 * Return the summary to be used for a new section.
1674 * @param string $sectionanchor Set to the section anchor text
1675 * @return string
1677 private function newSectionSummary( &$sectionanchor = null ) {
1678 global $wgParser;
1680 if ( $this->sectiontitle !== '' ) {
1681 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $this->sectiontitle );
1682 // If no edit summary was specified, create one automatically from the section
1683 // title and have it link to the new section. Otherwise, respect the summary as
1684 // passed.
1685 if ( $this->summary === '' ) {
1686 $cleanSectionTitle = $wgParser->stripSectionName( $this->sectiontitle );
1687 return $this->context->msg( 'newsectionsummary' )
1688 ->rawParams( $cleanSectionTitle )->inContentLanguage()->text();
1690 } elseif ( $this->summary !== '' ) {
1691 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $this->summary );
1692 # This is a new section, so create a link to the new section
1693 # in the revision summary.
1694 $cleanSummary = $wgParser->stripSectionName( $this->summary );
1695 return $this->context->msg( 'newsectionsummary' )
1696 ->rawParams( $cleanSummary )->inContentLanguage()->text();
1698 return $this->summary;
1702 * Attempt submission (no UI)
1704 * @param array $result Array to add statuses to, currently with the
1705 * possible keys:
1706 * - spam (string): Spam string from content if any spam is detected by
1707 * matchSpamRegex.
1708 * - sectionanchor (string): Section anchor for a section save.
1709 * - nullEdit (boolean): Set if doEditContent is OK. True if null edit,
1710 * false otherwise.
1711 * - redirect (bool): Set if doEditContent is OK. True if resulting
1712 * revision is a redirect.
1713 * @param bool $bot True if edit is being made under the bot right.
1715 * @return Status Status object, possibly with a message, but always with
1716 * one of the AS_* constants in $status->value,
1718 * @todo FIXME: This interface is TERRIBLE, but hard to get rid of due to
1719 * various error display idiosyncrasies. There are also lots of cases
1720 * where error metadata is set in the object and retrieved later instead
1721 * of being returned, e.g. AS_CONTENT_TOO_BIG and
1722 * AS_BLOCKED_PAGE_FOR_USER. All that stuff needs to be cleaned up some
1723 * time.
1725 function internalAttemptSave( &$result, $bot = false ) {
1726 global $wgUser, $wgRequest, $wgParser, $wgMaxArticleSize;
1727 global $wgContentHandlerUseDB;
1729 $status = Status::newGood();
1731 if ( !Hooks::run( 'EditPage::attemptSave', [ $this ] ) ) {
1732 wfDebug( "Hook 'EditPage::attemptSave' aborted article saving\n" );
1733 $status->fatal( 'hookaborted' );
1734 $status->value = self::AS_HOOK_ERROR;
1735 return $status;
1738 $spam = $wgRequest->getText( 'wpAntispam' );
1739 if ( $spam !== '' ) {
1740 wfDebugLog(
1741 'SimpleAntiSpam',
1742 $wgUser->getName() .
1743 ' editing "' .
1744 $this->mTitle->getPrefixedText() .
1745 '" submitted bogus field "' .
1746 $spam .
1749 $status->fatal( 'spamprotectionmatch', false );
1750 $status->value = self::AS_SPAM_ERROR;
1751 return $status;
1754 try {
1755 # Construct Content object
1756 $textbox_content = $this->toEditContent( $this->textbox1 );
1757 } catch ( MWContentSerializationException $ex ) {
1758 $status->fatal(
1759 'content-failed-to-parse',
1760 $this->contentModel,
1761 $this->contentFormat,
1762 $ex->getMessage()
1764 $status->value = self::AS_PARSE_ERROR;
1765 return $status;
1768 # Check image redirect
1769 if ( $this->mTitle->getNamespace() == NS_FILE &&
1770 $textbox_content->isRedirect() &&
1771 !$wgUser->isAllowed( 'upload' )
1773 $code = $wgUser->isAnon() ? self::AS_IMAGE_REDIRECT_ANON : self::AS_IMAGE_REDIRECT_LOGGED;
1774 $status->setResult( false, $code );
1776 return $status;
1779 # Check for spam
1780 $match = self::matchSummarySpamRegex( $this->summary );
1781 if ( $match === false && $this->section == 'new' ) {
1782 # $wgSpamRegex is enforced on this new heading/summary because, unlike
1783 # regular summaries, it is added to the actual wikitext.
1784 if ( $this->sectiontitle !== '' ) {
1785 # This branch is taken when the API is used with the 'sectiontitle' parameter.
1786 $match = self::matchSpamRegex( $this->sectiontitle );
1787 } else {
1788 # This branch is taken when the "Add Topic" user interface is used, or the API
1789 # is used with the 'summary' parameter.
1790 $match = self::matchSpamRegex( $this->summary );
1793 if ( $match === false ) {
1794 $match = self::matchSpamRegex( $this->textbox1 );
1796 if ( $match !== false ) {
1797 $result['spam'] = $match;
1798 $ip = $wgRequest->getIP();
1799 $pdbk = $this->mTitle->getPrefixedDBkey();
1800 $match = str_replace( "\n", '', $match );
1801 wfDebugLog( 'SpamRegex', "$ip spam regex hit [[$pdbk]]: \"$match\"" );
1802 $status->fatal( 'spamprotectionmatch', $match );
1803 $status->value = self::AS_SPAM_ERROR;
1804 return $status;
1806 if ( !Hooks::run(
1807 'EditFilter',
1808 [ $this, $this->textbox1, $this->section, &$this->hookError, $this->summary ] )
1810 # Error messages etc. could be handled within the hook...
1811 $status->fatal( 'hookaborted' );
1812 $status->value = self::AS_HOOK_ERROR;
1813 return $status;
1814 } elseif ( $this->hookError != '' ) {
1815 # ...or the hook could be expecting us to produce an error
1816 $status->fatal( 'hookaborted' );
1817 $status->value = self::AS_HOOK_ERROR_EXPECTED;
1818 return $status;
1821 if ( $wgUser->isBlockedFrom( $this->mTitle, false ) ) {
1822 // Auto-block user's IP if the account was "hard" blocked
1823 if ( !wfReadOnly() ) {
1824 $wgUser->spreadAnyEditBlock();
1826 # Check block state against master, thus 'false'.
1827 $status->setResult( false, self::AS_BLOCKED_PAGE_FOR_USER );
1828 return $status;
1831 $this->contentLength = strlen( $this->textbox1 );
1832 if ( $this->contentLength > $wgMaxArticleSize * 1024 ) {
1833 // Error will be displayed by showEditForm()
1834 $this->tooBig = true;
1835 $status->setResult( false, self::AS_CONTENT_TOO_BIG );
1836 return $status;
1839 if ( !$wgUser->isAllowed( 'edit' ) ) {
1840 if ( $wgUser->isAnon() ) {
1841 $status->setResult( false, self::AS_READ_ONLY_PAGE_ANON );
1842 return $status;
1843 } else {
1844 $status->fatal( 'readonlytext' );
1845 $status->value = self::AS_READ_ONLY_PAGE_LOGGED;
1846 return $status;
1850 $changingContentModel = false;
1851 if ( $this->contentModel !== $this->mTitle->getContentModel() ) {
1852 if ( !$wgContentHandlerUseDB ) {
1853 $status->fatal( 'editpage-cannot-use-custom-model' );
1854 $status->value = self::AS_CANNOT_USE_CUSTOM_MODEL;
1855 return $status;
1856 } elseif ( !$wgUser->isAllowed( 'editcontentmodel' ) ) {
1857 $status->setResult( false, self::AS_NO_CHANGE_CONTENT_MODEL );
1858 return $status;
1860 // Make sure the user can edit the page under the new content model too
1861 $titleWithNewContentModel = clone $this->mTitle;
1862 $titleWithNewContentModel->setContentModel( $this->contentModel );
1863 if ( !$titleWithNewContentModel->userCan( 'editcontentmodel', $wgUser )
1864 || !$titleWithNewContentModel->userCan( 'edit', $wgUser )
1866 $status->setResult( false, self::AS_NO_CHANGE_CONTENT_MODEL );
1867 return $status;
1870 $changingContentModel = true;
1871 $oldContentModel = $this->mTitle->getContentModel();
1874 if ( $this->changeTags ) {
1875 $changeTagsStatus = ChangeTags::canAddTagsAccompanyingChange(
1876 $this->changeTags, $wgUser );
1877 if ( !$changeTagsStatus->isOK() ) {
1878 $changeTagsStatus->value = self::AS_CHANGE_TAG_ERROR;
1879 return $changeTagsStatus;
1883 if ( wfReadOnly() ) {
1884 $status->fatal( 'readonlytext' );
1885 $status->value = self::AS_READ_ONLY_PAGE;
1886 return $status;
1888 if ( $wgUser->pingLimiter() || $wgUser->pingLimiter( 'linkpurge', 0 )
1889 || ( $changingContentModel && $wgUser->pingLimiter( 'editcontentmodel' ) )
1891 $status->fatal( 'actionthrottledtext' );
1892 $status->value = self::AS_RATE_LIMITED;
1893 return $status;
1896 # If the article has been deleted while editing, don't save it without
1897 # confirmation
1898 if ( $this->wasDeletedSinceLastEdit() && !$this->recreate ) {
1899 $status->setResult( false, self::AS_ARTICLE_WAS_DELETED );
1900 return $status;
1903 # Load the page data from the master. If anything changes in the meantime,
1904 # we detect it by using page_latest like a token in a 1 try compare-and-swap.
1905 $this->page->loadPageData( 'fromdbmaster' );
1906 $new = !$this->page->exists();
1908 if ( $new ) {
1909 // Late check for create permission, just in case *PARANOIA*
1910 if ( !$this->mTitle->userCan( 'create', $wgUser ) ) {
1911 $status->fatal( 'nocreatetext' );
1912 $status->value = self::AS_NO_CREATE_PERMISSION;
1913 wfDebug( __METHOD__ . ": no create permission\n" );
1914 return $status;
1917 // Don't save a new page if it's blank or if it's a MediaWiki:
1918 // message with content equivalent to default (allow empty pages
1919 // in this case to disable messages, see bug 50124)
1920 $defaultMessageText = $this->mTitle->getDefaultMessageText();
1921 if ( $this->mTitle->getNamespace() === NS_MEDIAWIKI && $defaultMessageText !== false ) {
1922 $defaultText = $defaultMessageText;
1923 } else {
1924 $defaultText = '';
1927 if ( !$this->allowBlankArticle && $this->textbox1 === $defaultText ) {
1928 $this->blankArticle = true;
1929 $status->fatal( 'blankarticle' );
1930 $status->setResult( false, self::AS_BLANK_ARTICLE );
1931 return $status;
1934 if ( !$this->runPostMergeFilters( $textbox_content, $status, $wgUser ) ) {
1935 return $status;
1938 $content = $textbox_content;
1940 $result['sectionanchor'] = '';
1941 if ( $this->section == 'new' ) {
1942 if ( $this->sectiontitle !== '' ) {
1943 // Insert the section title above the content.
1944 $content = $content->addSectionHeader( $this->sectiontitle );
1945 } elseif ( $this->summary !== '' ) {
1946 // Insert the section title above the content.
1947 $content = $content->addSectionHeader( $this->summary );
1949 $this->summary = $this->newSectionSummary( $result['sectionanchor'] );
1952 $status->value = self::AS_SUCCESS_NEW_ARTICLE;
1954 } else { # not $new
1956 # Article exists. Check for edit conflict.
1958 $this->page->clear(); # Force reload of dates, etc.
1959 $timestamp = $this->page->getTimestamp();
1960 $latest = $this->page->getLatest();
1962 wfDebug( "timestamp: {$timestamp}, edittime: {$this->edittime}\n" );
1964 // Check editRevId if set, which handles same-second timestamp collisions
1965 if ( $timestamp != $this->edittime
1966 || ( $this->editRevId !== null && $this->editRevId != $latest )
1968 $this->isConflict = true;
1969 if ( $this->section == 'new' ) {
1970 if ( $this->page->getUserText() == $wgUser->getName() &&
1971 $this->page->getComment() == $this->newSectionSummary()
1973 // Probably a duplicate submission of a new comment.
1974 // This can happen when CDN resends a request after
1975 // a timeout but the first one actually went through.
1976 wfDebug( __METHOD__
1977 . ": duplicate new section submission; trigger edit conflict!\n" );
1978 } else {
1979 // New comment; suppress conflict.
1980 $this->isConflict = false;
1981 wfDebug( __METHOD__ . ": conflict suppressed; new section\n" );
1983 } elseif ( $this->section == ''
1984 && Revision::userWasLastToEdit(
1985 DB_MASTER, $this->mTitle->getArticleID(),
1986 $wgUser->getId(), $this->edittime
1989 # Suppress edit conflict with self, except for section edits where merging is required.
1990 wfDebug( __METHOD__ . ": Suppressing edit conflict, same user.\n" );
1991 $this->isConflict = false;
1995 // If sectiontitle is set, use it, otherwise use the summary as the section title.
1996 if ( $this->sectiontitle !== '' ) {
1997 $sectionTitle = $this->sectiontitle;
1998 } else {
1999 $sectionTitle = $this->summary;
2002 $content = null;
2004 if ( $this->isConflict ) {
2005 wfDebug( __METHOD__
2006 . ": conflict! getting section '{$this->section}' for time '{$this->edittime}'"
2007 . " (id '{$this->editRevId}') (article time '{$timestamp}')\n" );
2008 // @TODO: replaceSectionAtRev() with base ID (not prior current) for ?oldid=X case
2009 // ...or disable section editing for non-current revisions (not exposed anyway).
2010 if ( $this->editRevId !== null ) {
2011 $content = $this->page->replaceSectionAtRev(
2012 $this->section,
2013 $textbox_content,
2014 $sectionTitle,
2015 $this->editRevId
2017 } else {
2018 $content = $this->page->replaceSectionContent(
2019 $this->section,
2020 $textbox_content,
2021 $sectionTitle,
2022 $this->edittime
2025 } else {
2026 wfDebug( __METHOD__ . ": getting section '{$this->section}'\n" );
2027 $content = $this->page->replaceSectionContent(
2028 $this->section,
2029 $textbox_content,
2030 $sectionTitle
2034 if ( is_null( $content ) ) {
2035 wfDebug( __METHOD__ . ": activating conflict; section replace failed.\n" );
2036 $this->isConflict = true;
2037 $content = $textbox_content; // do not try to merge here!
2038 } elseif ( $this->isConflict ) {
2039 # Attempt merge
2040 if ( $this->mergeChangesIntoContent( $content ) ) {
2041 // Successful merge! Maybe we should tell the user the good news?
2042 $this->isConflict = false;
2043 wfDebug( __METHOD__ . ": Suppressing edit conflict, successful merge.\n" );
2044 } else {
2045 $this->section = '';
2046 $this->textbox1 = ContentHandler::getContentText( $content );
2047 wfDebug( __METHOD__ . ": Keeping edit conflict, failed merge.\n" );
2051 if ( $this->isConflict ) {
2052 $status->setResult( false, self::AS_CONFLICT_DETECTED );
2053 return $status;
2056 if ( !$this->runPostMergeFilters( $content, $status, $wgUser ) ) {
2057 return $status;
2060 if ( $this->section == 'new' ) {
2061 // Handle the user preference to force summaries here
2062 if ( !$this->allowBlankSummary && trim( $this->summary ) == '' ) {
2063 $this->missingSummary = true;
2064 $status->fatal( 'missingsummary' ); // or 'missingcommentheader' if $section == 'new'. Blegh
2065 $status->value = self::AS_SUMMARY_NEEDED;
2066 return $status;
2069 // Do not allow the user to post an empty comment
2070 if ( $this->textbox1 == '' ) {
2071 $this->missingComment = true;
2072 $status->fatal( 'missingcommenttext' );
2073 $status->value = self::AS_TEXTBOX_EMPTY;
2074 return $status;
2076 } elseif ( !$this->allowBlankSummary
2077 && !$content->equals( $this->getOriginalContent( $wgUser ) )
2078 && !$content->isRedirect()
2079 && md5( $this->summary ) == $this->autoSumm
2081 $this->missingSummary = true;
2082 $status->fatal( 'missingsummary' );
2083 $status->value = self::AS_SUMMARY_NEEDED;
2084 return $status;
2087 # All's well
2088 $sectionanchor = '';
2089 if ( $this->section == 'new' ) {
2090 $this->summary = $this->newSectionSummary( $sectionanchor );
2091 } elseif ( $this->section != '' ) {
2092 # Try to get a section anchor from the section source, redirect
2093 # to edited section if header found.
2094 # XXX: Might be better to integrate this into Article::replaceSectionAtRev
2095 # for duplicate heading checking and maybe parsing.
2096 $hasmatch = preg_match( "/^ *([=]{1,6})(.*?)(\\1) *\\n/i", $this->textbox1, $matches );
2097 # We can't deal with anchors, includes, html etc in the header for now,
2098 # headline would need to be parsed to improve this.
2099 if ( $hasmatch && strlen( $matches[2] ) > 0 ) {
2100 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $matches[2] );
2103 $result['sectionanchor'] = $sectionanchor;
2105 // Save errors may fall down to the edit form, but we've now
2106 // merged the section into full text. Clear the section field
2107 // so that later submission of conflict forms won't try to
2108 // replace that into a duplicated mess.
2109 $this->textbox1 = $this->toEditText( $content );
2110 $this->section = '';
2112 $status->value = self::AS_SUCCESS_UPDATE;
2115 if ( !$this->allowSelfRedirect
2116 && $content->isRedirect()
2117 && $content->getRedirectTarget()->equals( $this->getTitle() )
2119 // If the page already redirects to itself, don't warn.
2120 $currentTarget = $this->getCurrentContent()->getRedirectTarget();
2121 if ( !$currentTarget || !$currentTarget->equals( $this->getTitle() ) ) {
2122 $this->selfRedirect = true;
2123 $status->fatal( 'selfredirect' );
2124 $status->value = self::AS_SELF_REDIRECT;
2125 return $status;
2129 // Check for length errors again now that the section is merged in
2130 $this->contentLength = strlen( $this->toEditText( $content ) );
2131 if ( $this->contentLength > $wgMaxArticleSize * 1024 ) {
2132 $this->tooBig = true;
2133 $status->setResult( false, self::AS_MAX_ARTICLE_SIZE_EXCEEDED );
2134 return $status;
2137 $flags = EDIT_AUTOSUMMARY |
2138 ( $new ? EDIT_NEW : EDIT_UPDATE ) |
2139 ( ( $this->minoredit && !$this->isNew ) ? EDIT_MINOR : 0 ) |
2140 ( $bot ? EDIT_FORCE_BOT : 0 );
2142 $doEditStatus = $this->page->doEditContent(
2143 $content,
2144 $this->summary,
2145 $flags,
2146 false,
2147 $wgUser,
2148 $content->getDefaultFormat(),
2149 $this->changeTags,
2150 $this->undidRev
2153 if ( !$doEditStatus->isOK() ) {
2154 // Failure from doEdit()
2155 // Show the edit conflict page for certain recognized errors from doEdit(),
2156 // but don't show it for errors from extension hooks
2157 $errors = $doEditStatus->getErrorsArray();
2158 if ( in_array( $errors[0][0],
2159 [ 'edit-gone-missing', 'edit-conflict', 'edit-already-exists' ] )
2161 $this->isConflict = true;
2162 // Destroys data doEdit() put in $status->value but who cares
2163 $doEditStatus->value = self::AS_END;
2165 return $doEditStatus;
2168 $result['nullEdit'] = $doEditStatus->hasMessage( 'edit-no-change' );
2169 if ( $result['nullEdit'] ) {
2170 // We don't know if it was a null edit until now, so increment here
2171 $wgUser->pingLimiter( 'linkpurge' );
2173 $result['redirect'] = $content->isRedirect();
2175 $this->updateWatchlist();
2177 // If the content model changed, add a log entry
2178 if ( $changingContentModel ) {
2179 $this->addContentModelChangeLogEntry(
2180 $wgUser,
2181 $new ? false : $oldContentModel,
2182 $this->contentModel,
2183 $this->summary
2187 return $status;
2191 * @param User $user
2192 * @param string|false $oldModel false if the page is being newly created
2193 * @param string $newModel
2194 * @param string $reason
2196 protected function addContentModelChangeLogEntry( User $user, $oldModel, $newModel, $reason ) {
2197 $new = $oldModel === false;
2198 $log = new ManualLogEntry( 'contentmodel', $new ? 'new' : 'change' );
2199 $log->setPerformer( $user );
2200 $log->setTarget( $this->mTitle );
2201 $log->setComment( $reason );
2202 $log->setParameters( [
2203 '4::oldmodel' => $oldModel,
2204 '5::newmodel' => $newModel
2205 ] );
2206 $logid = $log->insert();
2207 $log->publish( $logid );
2211 * Register the change of watch status
2213 protected function updateWatchlist() {
2214 global $wgUser;
2216 if ( !$wgUser->isLoggedIn() ) {
2217 return;
2220 $user = $wgUser;
2221 $title = $this->mTitle;
2222 $watch = $this->watchthis;
2223 // Do this in its own transaction to reduce contention...
2224 DeferredUpdates::addCallableUpdate( function () use ( $user, $title, $watch ) {
2225 if ( $watch == $user->isWatched( $title, User::IGNORE_USER_RIGHTS ) ) {
2226 return; // nothing to change
2228 WatchAction::doWatchOrUnwatch( $watch, $title, $user );
2229 } );
2233 * Attempts to do 3-way merge of edit content with a base revision
2234 * and current content, in case of edit conflict, in whichever way appropriate
2235 * for the content type.
2237 * @since 1.21
2239 * @param Content $editContent
2241 * @return bool
2243 private function mergeChangesIntoContent( &$editContent ) {
2244 $db = wfGetDB( DB_MASTER );
2246 // This is the revision the editor started from
2247 $baseRevision = $this->getBaseRevision();
2248 $baseContent = $baseRevision ? $baseRevision->getContent() : null;
2250 if ( is_null( $baseContent ) ) {
2251 return false;
2254 // The current state, we want to merge updates into it
2255 $currentRevision = Revision::loadFromTitle( $db, $this->mTitle );
2256 $currentContent = $currentRevision ? $currentRevision->getContent() : null;
2258 if ( is_null( $currentContent ) ) {
2259 return false;
2262 $handler = ContentHandler::getForModelID( $baseContent->getModel() );
2264 $result = $handler->merge3( $baseContent, $editContent, $currentContent );
2266 if ( $result ) {
2267 $editContent = $result;
2268 // Update parentRevId to what we just merged.
2269 $this->parentRevId = $currentRevision->getId();
2270 return true;
2273 return false;
2277 * @note: this method is very poorly named. If the user opened the form with ?oldid=X,
2278 * one might think of X as the "base revision", which is NOT what this returns.
2279 * @return Revision Current version when the edit was started
2281 function getBaseRevision() {
2282 if ( !$this->mBaseRevision ) {
2283 $db = wfGetDB( DB_MASTER );
2284 $this->mBaseRevision = $this->editRevId
2285 ? Revision::newFromId( $this->editRevId, Revision::READ_LATEST )
2286 : Revision::loadFromTimestamp( $db, $this->mTitle, $this->edittime );
2288 return $this->mBaseRevision;
2292 * Check given input text against $wgSpamRegex, and return the text of the first match.
2294 * @param string $text
2296 * @return string|bool Matching string or false
2298 public static function matchSpamRegex( $text ) {
2299 global $wgSpamRegex;
2300 // For back compatibility, $wgSpamRegex may be a single string or an array of regexes.
2301 $regexes = (array)$wgSpamRegex;
2302 return self::matchSpamRegexInternal( $text, $regexes );
2306 * Check given input text against $wgSummarySpamRegex, and return the text of the first match.
2308 * @param string $text
2310 * @return string|bool Matching string or false
2312 public static function matchSummarySpamRegex( $text ) {
2313 global $wgSummarySpamRegex;
2314 $regexes = (array)$wgSummarySpamRegex;
2315 return self::matchSpamRegexInternal( $text, $regexes );
2319 * @param string $text
2320 * @param array $regexes
2321 * @return bool|string
2323 protected static function matchSpamRegexInternal( $text, $regexes ) {
2324 foreach ( $regexes as $regex ) {
2325 $matches = [];
2326 if ( preg_match( $regex, $text, $matches ) ) {
2327 return $matches[0];
2330 return false;
2333 function setHeaders() {
2334 global $wgOut, $wgUser, $wgAjaxEditStash, $wgCookieSetOnAutoblock;
2336 $wgOut->addModules( 'mediawiki.action.edit' );
2337 if ( $wgCookieSetOnAutoblock === true ) {
2338 $wgOut->addModules( 'mediawiki.user.blockcookie' );
2340 $wgOut->addModuleStyles( 'mediawiki.action.edit.styles' );
2342 if ( $wgUser->getOption( 'showtoolbar' ) ) {
2343 // The addition of default buttons is handled by getEditToolbar() which
2344 // has its own dependency on this module. The call here ensures the module
2345 // is loaded in time (it has position "top") for other modules to register
2346 // buttons (e.g. extensions, gadgets, user scripts).
2347 $wgOut->addModules( 'mediawiki.toolbar' );
2350 if ( $wgUser->getOption( 'uselivepreview' ) ) {
2351 $wgOut->addModules( 'mediawiki.action.edit.preview' );
2354 if ( $wgUser->getOption( 'useeditwarning' ) ) {
2355 $wgOut->addModules( 'mediawiki.action.edit.editWarning' );
2358 # Enabled article-related sidebar, toplinks, etc.
2359 $wgOut->setArticleRelated( true );
2361 $contextTitle = $this->getContextTitle();
2362 if ( $this->isConflict ) {
2363 $msg = 'editconflict';
2364 } elseif ( $contextTitle->exists() && $this->section != '' ) {
2365 $msg = $this->section == 'new' ? 'editingcomment' : 'editingsection';
2366 } else {
2367 $msg = $contextTitle->exists()
2368 || ( $contextTitle->getNamespace() == NS_MEDIAWIKI
2369 && $contextTitle->getDefaultMessageText() !== false
2371 ? 'editing'
2372 : 'creating';
2375 # Use the title defined by DISPLAYTITLE magic word when present
2376 # NOTE: getDisplayTitle() returns HTML while getPrefixedText() returns plain text.
2377 # setPageTitle() treats the input as wikitext, which should be safe in either case.
2378 $displayTitle = isset( $this->mParserOutput ) ? $this->mParserOutput->getDisplayTitle() : false;
2379 if ( $displayTitle === false ) {
2380 $displayTitle = $contextTitle->getPrefixedText();
2382 $wgOut->setPageTitle( $this->context->msg( $msg, $displayTitle ) );
2383 # Transmit the name of the message to JavaScript for live preview
2384 # Keep Resources.php/mediawiki.action.edit.preview in sync with the possible keys
2385 $wgOut->addJsConfigVars( [
2386 'wgEditMessage' => $msg,
2387 'wgAjaxEditStash' => $wgAjaxEditStash,
2388 ] );
2392 * Show all applicable editing introductions
2394 protected function showIntro() {
2395 global $wgOut, $wgUser;
2396 if ( $this->suppressIntro ) {
2397 return;
2400 $namespace = $this->mTitle->getNamespace();
2402 if ( $namespace == NS_MEDIAWIKI ) {
2403 # Show a warning if editing an interface message
2404 $wgOut->wrapWikiMsg( "<div class='mw-editinginterface'>\n$1\n</div>", 'editinginterface' );
2405 # If this is a default message (but not css or js),
2406 # show a hint that it is translatable on translatewiki.net
2407 if ( !$this->mTitle->hasContentModel( CONTENT_MODEL_CSS )
2408 && !$this->mTitle->hasContentModel( CONTENT_MODEL_JAVASCRIPT )
2410 $defaultMessageText = $this->mTitle->getDefaultMessageText();
2411 if ( $defaultMessageText !== false ) {
2412 $wgOut->wrapWikiMsg( "<div class='mw-translateinterface'>\n$1\n</div>",
2413 'translateinterface' );
2416 } elseif ( $namespace == NS_FILE ) {
2417 # Show a hint to shared repo
2418 $file = wfFindFile( $this->mTitle );
2419 if ( $file && !$file->isLocal() ) {
2420 $descUrl = $file->getDescriptionUrl();
2421 # there must be a description url to show a hint to shared repo
2422 if ( $descUrl ) {
2423 if ( !$this->mTitle->exists() ) {
2424 $wgOut->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-create\">\n$1\n</div>", [
2425 'sharedupload-desc-create', $file->getRepo()->getDisplayName(), $descUrl
2426 ] );
2427 } else {
2428 $wgOut->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-edit\">\n$1\n</div>", [
2429 'sharedupload-desc-edit', $file->getRepo()->getDisplayName(), $descUrl
2430 ] );
2436 # Show a warning message when someone creates/edits a user (talk) page but the user does not exist
2437 # Show log extract when the user is currently blocked
2438 if ( $namespace == NS_USER || $namespace == NS_USER_TALK ) {
2439 $username = explode( '/', $this->mTitle->getText(), 2 )[0];
2440 $user = User::newFromName( $username, false /* allow IP users*/ );
2441 $ip = User::isIP( $username );
2442 $block = Block::newFromTarget( $user, $user );
2443 if ( !( $user && $user->isLoggedIn() ) && !$ip ) { # User does not exist
2444 $wgOut->wrapWikiMsg( "<div class=\"mw-userpage-userdoesnotexist error\">\n$1\n</div>",
2445 [ 'userpage-userdoesnotexist', wfEscapeWikiText( $username ) ] );
2446 } elseif ( !is_null( $block ) && $block->getType() != Block::TYPE_AUTO ) {
2447 # Show log extract if the user is currently blocked
2448 LogEventsList::showLogExtract(
2449 $wgOut,
2450 'block',
2451 MWNamespace::getCanonicalName( NS_USER ) . ':' . $block->getTarget(),
2454 'lim' => 1,
2455 'showIfEmpty' => false,
2456 'msgKey' => [
2457 'blocked-notice-logextract',
2458 $user->getName() # Support GENDER in notice
2464 # Try to add a custom edit intro, or use the standard one if this is not possible.
2465 if ( !$this->showCustomIntro() && !$this->mTitle->exists() ) {
2466 $helpLink = wfExpandUrl( Skin::makeInternalOrExternalUrl(
2467 $this->context->msg( 'helppage' )->inContentLanguage()->text()
2468 ) );
2469 if ( $wgUser->isLoggedIn() ) {
2470 $wgOut->wrapWikiMsg(
2471 // Suppress the external link icon, consider the help url an internal one
2472 "<div class=\"mw-newarticletext plainlinks\">\n$1\n</div>",
2474 'newarticletext',
2475 $helpLink
2478 } else {
2479 $wgOut->wrapWikiMsg(
2480 // Suppress the external link icon, consider the help url an internal one
2481 "<div class=\"mw-newarticletextanon plainlinks\">\n$1\n</div>",
2483 'newarticletextanon',
2484 $helpLink
2489 # Give a notice if the user is editing a deleted/moved page...
2490 if ( !$this->mTitle->exists() ) {
2491 LogEventsList::showLogExtract( $wgOut, [ 'delete', 'move' ], $this->mTitle,
2494 'lim' => 10,
2495 'conds' => [ "log_action != 'revision'" ],
2496 'showIfEmpty' => false,
2497 'msgKey' => [ 'recreate-moveddeleted-warn' ]
2504 * Attempt to show a custom editing introduction, if supplied
2506 * @return bool
2508 protected function showCustomIntro() {
2509 if ( $this->editintro ) {
2510 $title = Title::newFromText( $this->editintro );
2511 if ( $title instanceof Title && $title->exists() && $title->userCan( 'read' ) ) {
2512 global $wgOut;
2513 // Added using template syntax, to take <noinclude>'s into account.
2514 $wgOut->addWikiTextTitleTidy(
2515 '<div class="mw-editintro">{{:' . $title->getFullText() . '}}</div>',
2516 $this->mTitle
2518 return true;
2521 return false;
2525 * Gets an editable textual representation of $content.
2526 * The textual representation can be turned by into a Content object by the
2527 * toEditContent() method.
2529 * If $content is null or false or a string, $content is returned unchanged.
2531 * If the given Content object is not of a type that can be edited using
2532 * the text base EditPage, an exception will be raised. Set
2533 * $this->allowNonTextContent to true to allow editing of non-textual
2534 * content.
2536 * @param Content|null|bool|string $content
2537 * @return string The editable text form of the content.
2539 * @throws MWException If $content is not an instance of TextContent and
2540 * $this->allowNonTextContent is not true.
2542 protected function toEditText( $content ) {
2543 if ( $content === null || $content === false || is_string( $content ) ) {
2544 return $content;
2547 if ( !$this->isSupportedContentModel( $content->getModel() ) ) {
2548 throw new MWException( 'This content model is not supported: ' . $content->getModel() );
2551 return $content->serialize( $this->contentFormat );
2555 * Turns the given text into a Content object by unserializing it.
2557 * If the resulting Content object is not of a type that can be edited using
2558 * the text base EditPage, an exception will be raised. Set
2559 * $this->allowNonTextContent to true to allow editing of non-textual
2560 * content.
2562 * @param string|null|bool $text Text to unserialize
2563 * @return Content|bool|null The content object created from $text. If $text was false
2564 * or null, false resp. null will be returned instead.
2566 * @throws MWException If unserializing the text results in a Content
2567 * object that is not an instance of TextContent and
2568 * $this->allowNonTextContent is not true.
2570 protected function toEditContent( $text ) {
2571 if ( $text === false || $text === null ) {
2572 return $text;
2575 $content = ContentHandler::makeContent( $text, $this->getTitle(),
2576 $this->contentModel, $this->contentFormat );
2578 if ( !$this->isSupportedContentModel( $content->getModel() ) ) {
2579 throw new MWException( 'This content model is not supported: ' . $content->getModel() );
2582 return $content;
2586 * Send the edit form and related headers to $wgOut
2587 * @param callable|null $formCallback That takes an OutputPage parameter; will be called
2588 * during form output near the top, for captchas and the like.
2590 * The $formCallback parameter is deprecated since MediaWiki 1.25. Please
2591 * use the EditPage::showEditForm:fields hook instead.
2593 function showEditForm( $formCallback = null ) {
2594 global $wgOut, $wgUser;
2596 # need to parse the preview early so that we know which templates are used,
2597 # otherwise users with "show preview after edit box" will get a blank list
2598 # we parse this near the beginning so that setHeaders can do the title
2599 # setting work instead of leaving it in getPreviewText
2600 $previewOutput = '';
2601 if ( $this->formtype == 'preview' ) {
2602 $previewOutput = $this->getPreviewText();
2605 Hooks::run( 'EditPage::showEditForm:initial', [ &$this, &$wgOut ] );
2607 $this->setHeaders();
2609 $this->addTalkPageText();
2610 $this->addEditNotices();
2612 if ( !$this->isConflict &&
2613 $this->section != '' &&
2614 !$this->isSectionEditSupported() ) {
2615 // We use $this->section to much before this and getVal('wgSection') directly in other places
2616 // at this point we can't reset $this->section to '' to fallback to non-section editing.
2617 // Someone is welcome to try refactoring though
2618 $wgOut->showErrorPage( 'sectioneditnotsupported-title', 'sectioneditnotsupported-text' );
2619 return;
2622 $this->showHeader();
2624 $wgOut->addHTML( $this->editFormPageTop );
2626 if ( $wgUser->getOption( 'previewontop' ) ) {
2627 $this->displayPreviewArea( $previewOutput, true );
2630 $wgOut->addHTML( $this->editFormTextTop );
2632 $showToolbar = true;
2633 if ( $this->wasDeletedSinceLastEdit() ) {
2634 if ( $this->formtype == 'save' ) {
2635 // Hide the toolbar and edit area, user can click preview to get it back
2636 // Add an confirmation checkbox and explanation.
2637 $showToolbar = false;
2638 } else {
2639 $wgOut->wrapWikiMsg( "<div class='error mw-deleted-while-editing'>\n$1\n</div>",
2640 'deletedwhileediting' );
2644 // @todo add EditForm plugin interface and use it here!
2645 // search for textarea1 and textares2, and allow EditForm to override all uses.
2646 $wgOut->addHTML( Html::openElement(
2647 'form',
2649 'id' => self::EDITFORM_ID,
2650 'name' => self::EDITFORM_ID,
2651 'method' => 'post',
2652 'action' => $this->getActionURL( $this->getContextTitle() ),
2653 'enctype' => 'multipart/form-data'
2655 ) );
2657 if ( is_callable( $formCallback ) ) {
2658 wfWarn( 'The $formCallback parameter to ' . __METHOD__ . 'is deprecated' );
2659 call_user_func_array( $formCallback, [ &$wgOut ] );
2662 // Add an empty field to trip up spambots
2663 $wgOut->addHTML(
2664 Xml::openElement( 'div', [ 'id' => 'antispam-container', 'style' => 'display: none;' ] )
2665 . Html::rawElement(
2666 'label',
2667 [ 'for' => 'wpAntispam' ],
2668 $this->context->msg( 'simpleantispam-label' )->parse()
2670 . Xml::element(
2671 'input',
2673 'type' => 'text',
2674 'name' => 'wpAntispam',
2675 'id' => 'wpAntispam',
2676 'value' => ''
2679 . Xml::closeElement( 'div' )
2682 Hooks::run( 'EditPage::showEditForm:fields', [ &$this, &$wgOut ] );
2684 // Put these up at the top to ensure they aren't lost on early form submission
2685 $this->showFormBeforeText();
2687 if ( $this->wasDeletedSinceLastEdit() && 'save' == $this->formtype ) {
2688 $username = $this->lastDelete->user_name;
2689 $comment = $this->lastDelete->log_comment;
2691 // It is better to not parse the comment at all than to have templates expanded in the middle
2692 // TODO: can the checkLabel be moved outside of the div so that wrapWikiMsg could be used?
2693 $key = $comment === ''
2694 ? 'confirmrecreate-noreason'
2695 : 'confirmrecreate';
2696 $wgOut->addHTML(
2697 '<div class="mw-confirm-recreate">' .
2698 $this->context->msg( $key, $username, "<nowiki>$comment</nowiki>" )->parse() .
2699 Xml::checkLabel( $this->context->msg( 'recreate' )->text(), 'wpRecreate', 'wpRecreate', false,
2700 [ 'title' => Linker::titleAttrib( 'recreate' ), 'tabindex' => 1, 'id' => 'wpRecreate' ]
2702 '</div>'
2706 # When the summary is hidden, also hide them on preview/show changes
2707 if ( $this->nosummary ) {
2708 $wgOut->addHTML( Html::hidden( 'nosummary', true ) );
2711 # If a blank edit summary was previously provided, and the appropriate
2712 # user preference is active, pass a hidden tag as wpIgnoreBlankSummary. This will stop the
2713 # user being bounced back more than once in the event that a summary
2714 # is not required.
2715 # ####
2716 # For a bit more sophisticated detection of blank summaries, hash the
2717 # automatic one and pass that in the hidden field wpAutoSummary.
2718 if ( $this->missingSummary || ( $this->section == 'new' && $this->nosummary ) ) {
2719 $wgOut->addHTML( Html::hidden( 'wpIgnoreBlankSummary', true ) );
2722 if ( $this->undidRev ) {
2723 $wgOut->addHTML( Html::hidden( 'wpUndidRevision', $this->undidRev ) );
2726 if ( $this->selfRedirect ) {
2727 $wgOut->addHTML( Html::hidden( 'wpIgnoreSelfRedirect', true ) );
2730 if ( $this->hasPresetSummary ) {
2731 // If a summary has been preset using &summary= we don't want to prompt for
2732 // a different summary. Only prompt for a summary if the summary is blanked.
2733 // (Bug 17416)
2734 $this->autoSumm = md5( '' );
2737 $autosumm = $this->autoSumm ? $this->autoSumm : md5( $this->summary );
2738 $wgOut->addHTML( Html::hidden( 'wpAutoSummary', $autosumm ) );
2740 $wgOut->addHTML( Html::hidden( 'oldid', $this->oldid ) );
2741 $wgOut->addHTML( Html::hidden( 'parentRevId', $this->getParentRevId() ) );
2743 $wgOut->addHTML( Html::hidden( 'format', $this->contentFormat ) );
2744 $wgOut->addHTML( Html::hidden( 'model', $this->contentModel ) );
2746 if ( $this->section == 'new' ) {
2747 $this->showSummaryInput( true, $this->summary );
2748 $wgOut->addHTML( $this->getSummaryPreview( true, $this->summary ) );
2751 $wgOut->addHTML( $this->editFormTextBeforeContent );
2753 if ( !$this->isCssJsSubpage && $showToolbar && $wgUser->getOption( 'showtoolbar' ) ) {
2754 $wgOut->addHTML( EditPage::getEditToolbar( $this->mTitle ) );
2757 if ( $this->blankArticle ) {
2758 $wgOut->addHTML( Html::hidden( 'wpIgnoreBlankArticle', true ) );
2761 if ( $this->isConflict ) {
2762 // In an edit conflict bypass the overridable content form method
2763 // and fallback to the raw wpTextbox1 since editconflicts can't be
2764 // resolved between page source edits and custom ui edits using the
2765 // custom edit ui.
2766 $this->textbox2 = $this->textbox1;
2768 $content = $this->getCurrentContent();
2769 $this->textbox1 = $this->toEditText( $content );
2771 $this->showTextbox1();
2772 } else {
2773 $this->showContentForm();
2776 $wgOut->addHTML( $this->editFormTextAfterContent );
2778 $this->showStandardInputs();
2780 $this->showFormAfterText();
2782 $this->showTosSummary();
2784 $this->showEditTools();
2786 $wgOut->addHTML( $this->editFormTextAfterTools . "\n" );
2788 $wgOut->addHTML( $this->makeTemplatesOnThisPageList( $this->getTemplates() ) );
2790 $wgOut->addHTML( Html::rawElement( 'div', [ 'class' => 'hiddencats' ],
2791 Linker::formatHiddenCategories( $this->page->getHiddenCategories() ) ) );
2793 $wgOut->addHTML( Html::rawElement( 'div', [ 'class' => 'limitreport' ],
2794 self::getPreviewLimitReport( $this->mParserOutput ) ) );
2796 $wgOut->addModules( 'mediawiki.action.edit.collapsibleFooter' );
2798 if ( $this->isConflict ) {
2799 try {
2800 $this->showConflict();
2801 } catch ( MWContentSerializationException $ex ) {
2802 // this can't really happen, but be nice if it does.
2803 $msg = $this->context->msg(
2804 'content-failed-to-parse',
2805 $this->contentModel,
2806 $this->contentFormat,
2807 $ex->getMessage()
2809 $wgOut->addWikiText( '<div class="error">' . $msg->text() . '</div>' );
2813 // Set a hidden field so JS knows what edit form mode we are in
2814 if ( $this->isConflict ) {
2815 $mode = 'conflict';
2816 } elseif ( $this->preview ) {
2817 $mode = 'preview';
2818 } elseif ( $this->diff ) {
2819 $mode = 'diff';
2820 } else {
2821 $mode = 'text';
2823 $wgOut->addHTML( Html::hidden( 'mode', $mode, [ 'id' => 'mw-edit-mode' ] ) );
2825 // Marker for detecting truncated form data. This must be the last
2826 // parameter sent in order to be of use, so do not move me.
2827 $wgOut->addHTML( Html::hidden( 'wpUltimateParam', true ) );
2828 $wgOut->addHTML( $this->editFormTextBottom . "\n</form>\n" );
2830 if ( !$wgUser->getOption( 'previewontop' ) ) {
2831 $this->displayPreviewArea( $previewOutput, false );
2836 * Wrapper around TemplatesOnThisPageFormatter to make
2837 * a "templates on this page" list.
2839 * @param Title[] $templates
2840 * @return string HTML
2842 protected function makeTemplatesOnThisPageList( array $templates ) {
2843 $templateListFormatter = new TemplatesOnThisPageFormatter(
2844 $this->context, MediaWikiServices::getInstance()->getLinkRenderer()
2847 // preview if preview, else section if section, else false
2848 $type = false;
2849 if ( $this->preview ) {
2850 $type = 'preview';
2851 } elseif ( $this->section != '' ) {
2852 $type = 'section';
2855 return Html::rawElement( 'div', [ 'class' => 'templatesUsed' ],
2856 $templateListFormatter->format( $templates, $type )
2861 * Extract the section title from current section text, if any.
2863 * @param string $text
2864 * @return string|bool String or false
2866 public static function extractSectionTitle( $text ) {
2867 preg_match( "/^(=+)(.+)\\1\\s*(\n|$)/i", $text, $matches );
2868 if ( !empty( $matches[2] ) ) {
2869 global $wgParser;
2870 return $wgParser->stripSectionName( trim( $matches[2] ) );
2871 } else {
2872 return false;
2876 protected function showHeader() {
2877 global $wgOut, $wgUser;
2878 global $wgAllowUserCss, $wgAllowUserJs;
2880 if ( $this->isConflict ) {
2881 $this->addExplainConflictHeader( $wgOut );
2882 $this->editRevId = $this->page->getLatest();
2883 } else {
2884 if ( $this->section != '' && $this->section != 'new' ) {
2885 if ( !$this->summary && !$this->preview && !$this->diff ) {
2886 $sectionTitle = self::extractSectionTitle( $this->textbox1 ); // FIXME: use Content object
2887 if ( $sectionTitle !== false ) {
2888 $this->summary = "/* $sectionTitle */ ";
2893 if ( $this->missingComment ) {
2894 $wgOut->wrapWikiMsg( "<div id='mw-missingcommenttext'>\n$1\n</div>", 'missingcommenttext' );
2897 if ( $this->missingSummary && $this->section != 'new' ) {
2898 $wgOut->wrapWikiMsg( "<div id='mw-missingsummary'>\n$1\n</div>", 'missingsummary' );
2901 if ( $this->missingSummary && $this->section == 'new' ) {
2902 $wgOut->wrapWikiMsg( "<div id='mw-missingcommentheader'>\n$1\n</div>", 'missingcommentheader' );
2905 if ( $this->blankArticle ) {
2906 $wgOut->wrapWikiMsg( "<div id='mw-blankarticle'>\n$1\n</div>", 'blankarticle' );
2909 if ( $this->selfRedirect ) {
2910 $wgOut->wrapWikiMsg( "<div id='mw-selfredirect'>\n$1\n</div>", 'selfredirect' );
2913 if ( $this->hookError !== '' ) {
2914 $wgOut->addWikiText( $this->hookError );
2917 if ( !$this->checkUnicodeCompliantBrowser() ) {
2918 $wgOut->addWikiMsg( 'nonunicodebrowser' );
2921 if ( $this->section != 'new' ) {
2922 $revision = $this->mArticle->getRevisionFetched();
2923 if ( $revision ) {
2924 // Let sysop know that this will make private content public if saved
2926 if ( !$revision->userCan( Revision::DELETED_TEXT, $wgUser ) ) {
2927 $wgOut->wrapWikiMsg(
2928 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
2929 'rev-deleted-text-permission'
2931 } elseif ( $revision->isDeleted( Revision::DELETED_TEXT ) ) {
2932 $wgOut->wrapWikiMsg(
2933 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
2934 'rev-deleted-text-view'
2938 if ( !$revision->isCurrent() ) {
2939 $this->mArticle->setOldSubtitle( $revision->getId() );
2940 $wgOut->addWikiMsg( 'editingold' );
2941 $this->isOldRev = true;
2943 } elseif ( $this->mTitle->exists() ) {
2944 // Something went wrong
2946 $wgOut->wrapWikiMsg( "<div class='errorbox'>\n$1\n</div>\n",
2947 [ 'missing-revision', $this->oldid ] );
2952 if ( wfReadOnly() ) {
2953 $wgOut->wrapWikiMsg(
2954 "<div id=\"mw-read-only-warning\">\n$1\n</div>",
2955 [ 'readonlywarning', wfReadOnlyReason() ]
2957 } elseif ( $wgUser->isAnon() ) {
2958 if ( $this->formtype != 'preview' ) {
2959 $wgOut->wrapWikiMsg(
2960 "<div id='mw-anon-edit-warning' class='warningbox'>\n$1\n</div>",
2961 [ 'anoneditwarning',
2962 // Log-in link
2963 SpecialPage::getTitleFor( 'Userlogin' )->getFullURL( [
2964 'returnto' => $this->getTitle()->getPrefixedDBkey()
2965 ] ),
2966 // Sign-up link
2967 SpecialPage::getTitleFor( 'CreateAccount' )->getFullURL( [
2968 'returnto' => $this->getTitle()->getPrefixedDBkey()
2972 } else {
2973 $wgOut->wrapWikiMsg( "<div id=\"mw-anon-preview-warning\" class=\"warningbox\">\n$1</div>",
2974 'anonpreviewwarning'
2977 } else {
2978 if ( $this->isCssJsSubpage ) {
2979 # Check the skin exists
2980 if ( $this->isWrongCaseCssJsPage ) {
2981 $wgOut->wrapWikiMsg(
2982 "<div class='error' id='mw-userinvalidcssjstitle'>\n$1\n</div>",
2983 [ 'userinvalidcssjstitle', $this->mTitle->getSkinFromCssJsSubpage() ]
2986 if ( $this->getTitle()->isSubpageOf( $wgUser->getUserPage() ) ) {
2987 $wgOut->wrapWikiMsg( '<div class="mw-usercssjspublic">$1</div>',
2988 $this->isCssSubpage ? 'usercssispublic' : 'userjsispublic'
2990 if ( $this->formtype !== 'preview' ) {
2991 if ( $this->isCssSubpage && $wgAllowUserCss ) {
2992 $wgOut->wrapWikiMsg(
2993 "<div id='mw-usercssyoucanpreview'>\n$1\n</div>",
2994 [ 'usercssyoucanpreview' ]
2998 if ( $this->isJsSubpage && $wgAllowUserJs ) {
2999 $wgOut->wrapWikiMsg(
3000 "<div id='mw-userjsyoucanpreview'>\n$1\n</div>",
3001 [ 'userjsyoucanpreview' ]
3009 $this->addPageProtectionWarningHeaders();
3011 $this->addLongPageWarningHeader();
3013 # Add header copyright warning
3014 $this->showHeaderCopyrightWarning();
3018 * Standard summary input and label (wgSummary), abstracted so EditPage
3019 * subclasses may reorganize the form.
3020 * Note that you do not need to worry about the label's for=, it will be
3021 * inferred by the id given to the input. You can remove them both by
3022 * passing [ 'id' => false ] to $userInputAttrs.
3024 * @param string $summary The value of the summary input
3025 * @param string $labelText The html to place inside the label
3026 * @param array $inputAttrs Array of attrs to use on the input
3027 * @param array $spanLabelAttrs Array of attrs to use on the span inside the label
3029 * @return array An array in the format [ $label, $input ]
3031 function getSummaryInput( $summary = "", $labelText = null,
3032 $inputAttrs = null, $spanLabelAttrs = null
3034 // Note: the maxlength is overridden in JS to 255 and to make it use UTF-8 bytes, not characters.
3035 $inputAttrs = ( is_array( $inputAttrs ) ? $inputAttrs : [] ) + [
3036 'id' => 'wpSummary',
3037 'maxlength' => '200',
3038 'tabindex' => '1',
3039 'size' => 60,
3040 'spellcheck' => 'true',
3041 ] + Linker::tooltipAndAccesskeyAttribs( 'summary' );
3043 $spanLabelAttrs = ( is_array( $spanLabelAttrs ) ? $spanLabelAttrs : [] ) + [
3044 'class' => $this->missingSummary ? 'mw-summarymissed' : 'mw-summary',
3045 'id' => "wpSummaryLabel"
3048 $label = null;
3049 if ( $labelText ) {
3050 $label = Xml::tags(
3051 'label',
3052 $inputAttrs['id'] ? [ 'for' => $inputAttrs['id'] ] : null,
3053 $labelText
3055 $label = Xml::tags( 'span', $spanLabelAttrs, $label );
3058 $input = Html::input( 'wpSummary', $summary, 'text', $inputAttrs );
3060 return [ $label, $input ];
3064 * @param bool $isSubjectPreview True if this is the section subject/title
3065 * up top, or false if this is the comment summary
3066 * down below the textarea
3067 * @param string $summary The text of the summary to display
3069 protected function showSummaryInput( $isSubjectPreview, $summary = "" ) {
3070 global $wgOut;
3071 # Add a class if 'missingsummary' is triggered to allow styling of the summary line
3072 $summaryClass = $this->missingSummary ? 'mw-summarymissed' : 'mw-summary';
3073 if ( $isSubjectPreview ) {
3074 if ( $this->nosummary ) {
3075 return;
3077 } else {
3078 if ( !$this->mShowSummaryField ) {
3079 return;
3082 $labelText = $this->context->msg( $isSubjectPreview ? 'subject' : 'summary' )->parse();
3083 list( $label, $input ) = $this->getSummaryInput(
3084 $summary,
3085 $labelText,
3086 [ 'class' => $summaryClass ],
3089 $wgOut->addHTML( "{$label} {$input}" );
3093 * @param bool $isSubjectPreview True if this is the section subject/title
3094 * up top, or false if this is the comment summary
3095 * down below the textarea
3096 * @param string $summary The text of the summary to display
3097 * @return string
3099 protected function getSummaryPreview( $isSubjectPreview, $summary = "" ) {
3100 // avoid spaces in preview, gets always trimmed on save
3101 $summary = trim( $summary );
3102 if ( !$summary || ( !$this->preview && !$this->diff ) ) {
3103 return "";
3106 global $wgParser;
3108 if ( $isSubjectPreview ) {
3109 $summary = $this->context->msg( 'newsectionsummary' )
3110 ->rawParams( $wgParser->stripSectionName( $summary ) )
3111 ->inContentLanguage()->text();
3114 $message = $isSubjectPreview ? 'subject-preview' : 'summary-preview';
3116 $summary = $this->context->msg( $message )->parse()
3117 . Linker::commentBlock( $summary, $this->mTitle, $isSubjectPreview );
3118 return Xml::tags( 'div', [ 'class' => 'mw-summary-preview' ], $summary );
3121 protected function showFormBeforeText() {
3122 global $wgOut;
3123 $section = htmlspecialchars( $this->section );
3124 $wgOut->addHTML( <<<HTML
3125 <input type='hidden' value="{$section}" name="wpSection"/>
3126 <input type='hidden' value="{$this->starttime}" name="wpStarttime" />
3127 <input type='hidden' value="{$this->edittime}" name="wpEdittime" />
3128 <input type='hidden' value="{$this->editRevId}" name="editRevId" />
3129 <input type='hidden' value="{$this->scrolltop}" name="wpScrolltop" id="wpScrolltop" />
3131 HTML
3133 if ( !$this->checkUnicodeCompliantBrowser() ) {
3134 $wgOut->addHTML( Html::hidden( 'safemode', '1' ) );
3138 protected function showFormAfterText() {
3139 global $wgOut, $wgUser;
3141 * To make it harder for someone to slip a user a page
3142 * which submits an edit form to the wiki without their
3143 * knowledge, a random token is associated with the login
3144 * session. If it's not passed back with the submission,
3145 * we won't save the page, or render user JavaScript and
3146 * CSS previews.
3148 * For anon editors, who may not have a session, we just
3149 * include the constant suffix to prevent editing from
3150 * broken text-mangling proxies.
3152 $wgOut->addHTML( "\n" . Html::hidden( "wpEditToken", $wgUser->getEditToken() ) . "\n" );
3156 * Subpage overridable method for printing the form for page content editing
3157 * By default this simply outputs wpTextbox1
3158 * Subclasses can override this to provide a custom UI for editing;
3159 * be it a form, or simply wpTextbox1 with a modified content that will be
3160 * reverse modified when extracted from the post data.
3161 * Note that this is basically the inverse for importContentFormData
3163 protected function showContentForm() {
3164 $this->showTextbox1();
3168 * Method to output wpTextbox1
3169 * The $textoverride method can be used by subclasses overriding showContentForm
3170 * to pass back to this method.
3172 * @param array $customAttribs Array of html attributes to use in the textarea
3173 * @param string $textoverride Optional text to override $this->textarea1 with
3175 protected function showTextbox1( $customAttribs = null, $textoverride = null ) {
3176 if ( $this->wasDeletedSinceLastEdit() && $this->formtype == 'save' ) {
3177 $attribs = [ 'style' => 'display:none;' ];
3178 } else {
3179 $classes = []; // Textarea CSS
3180 if ( $this->mTitle->isProtected( 'edit' ) &&
3181 MWNamespace::getRestrictionLevels( $this->mTitle->getNamespace() ) !== [ '' ]
3183 # Is the title semi-protected?
3184 if ( $this->mTitle->isSemiProtected() ) {
3185 $classes[] = 'mw-textarea-sprotected';
3186 } else {
3187 # Then it must be protected based on static groups (regular)
3188 $classes[] = 'mw-textarea-protected';
3190 # Is the title cascade-protected?
3191 if ( $this->mTitle->isCascadeProtected() ) {
3192 $classes[] = 'mw-textarea-cprotected';
3195 # Is an old revision being edited?
3196 if ( $this->isOldRev ) {
3197 $classes[] = 'mw-textarea-oldrev';
3200 $attribs = [ 'tabindex' => 1 ];
3202 if ( is_array( $customAttribs ) ) {
3203 $attribs += $customAttribs;
3206 if ( count( $classes ) ) {
3207 if ( isset( $attribs['class'] ) ) {
3208 $classes[] = $attribs['class'];
3210 $attribs['class'] = implode( ' ', $classes );
3214 $this->showTextbox(
3215 $textoverride !== null ? $textoverride : $this->textbox1,
3216 'wpTextbox1',
3217 $attribs
3221 protected function showTextbox2() {
3222 $this->showTextbox( $this->textbox2, 'wpTextbox2', [ 'tabindex' => 6, 'readonly' ] );
3225 protected function showTextbox( $text, $name, $customAttribs = [] ) {
3226 global $wgOut, $wgUser;
3228 $wikitext = $this->safeUnicodeOutput( $text );
3229 $wikitext = $this->addNewLineAtEnd( $wikitext );
3231 $attribs = $this->buildTextboxAttribs( $name, $customAttribs, $wgUser );
3233 $wgOut->addHTML( Html::textarea( $name, $wikitext, $attribs ) );
3236 protected function displayPreviewArea( $previewOutput, $isOnTop = false ) {
3237 global $wgOut;
3238 $classes = [];
3239 if ( $isOnTop ) {
3240 $classes[] = 'ontop';
3243 $attribs = [ 'id' => 'wikiPreview', 'class' => implode( ' ', $classes ) ];
3245 if ( $this->formtype != 'preview' ) {
3246 $attribs['style'] = 'display: none;';
3249 $wgOut->addHTML( Xml::openElement( 'div', $attribs ) );
3251 if ( $this->formtype == 'preview' ) {
3252 $this->showPreview( $previewOutput );
3253 } else {
3254 // Empty content container for LivePreview
3255 $pageViewLang = $this->mTitle->getPageViewLanguage();
3256 $attribs = [ 'lang' => $pageViewLang->getHtmlCode(), 'dir' => $pageViewLang->getDir(),
3257 'class' => 'mw-content-' . $pageViewLang->getDir() ];
3258 $wgOut->addHTML( Html::rawElement( 'div', $attribs ) );
3261 $wgOut->addHTML( '</div>' );
3263 if ( $this->formtype == 'diff' ) {
3264 try {
3265 $this->showDiff();
3266 } catch ( MWContentSerializationException $ex ) {
3267 $msg = $this->context->msg(
3268 'content-failed-to-parse',
3269 $this->contentModel,
3270 $this->contentFormat,
3271 $ex->getMessage()
3273 $wgOut->addWikiText( '<div class="error">' . $msg->text() . '</div>' );
3279 * Append preview output to $wgOut.
3280 * Includes category rendering if this is a category page.
3282 * @param string $text The HTML to be output for the preview.
3284 protected function showPreview( $text ) {
3285 global $wgOut;
3286 if ( $this->mTitle->getNamespace() == NS_CATEGORY ) {
3287 $this->mArticle->openShowCategory();
3289 # This hook seems slightly odd here, but makes things more
3290 # consistent for extensions.
3291 Hooks::run( 'OutputPageBeforeHTML', [ &$wgOut, &$text ] );
3292 $wgOut->addHTML( $text );
3293 if ( $this->mTitle->getNamespace() == NS_CATEGORY ) {
3294 $this->mArticle->closeShowCategory();
3299 * Get a diff between the current contents of the edit box and the
3300 * version of the page we're editing from.
3302 * If this is a section edit, we'll replace the section as for final
3303 * save and then make a comparison.
3305 function showDiff() {
3306 global $wgUser, $wgContLang, $wgOut;
3308 $oldtitlemsg = 'currentrev';
3309 # if message does not exist, show diff against the preloaded default
3310 if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI && !$this->mTitle->exists() ) {
3311 $oldtext = $this->mTitle->getDefaultMessageText();
3312 if ( $oldtext !== false ) {
3313 $oldtitlemsg = 'defaultmessagetext';
3314 $oldContent = $this->toEditContent( $oldtext );
3315 } else {
3316 $oldContent = null;
3318 } else {
3319 $oldContent = $this->getCurrentContent();
3322 $textboxContent = $this->toEditContent( $this->textbox1 );
3323 if ( $this->editRevId !== null ) {
3324 $newContent = $this->page->replaceSectionAtRev(
3325 $this->section, $textboxContent, $this->summary, $this->editRevId
3327 } else {
3328 $newContent = $this->page->replaceSectionContent(
3329 $this->section, $textboxContent, $this->summary, $this->edittime
3333 if ( $newContent ) {
3334 Hooks::run( 'EditPageGetDiffContent', [ $this, &$newContent ] );
3336 $popts = ParserOptions::newFromUserAndLang( $wgUser, $wgContLang );
3337 $newContent = $newContent->preSaveTransform( $this->mTitle, $wgUser, $popts );
3340 if ( ( $oldContent && !$oldContent->isEmpty() ) || ( $newContent && !$newContent->isEmpty() ) ) {
3341 $oldtitle = $this->context->msg( $oldtitlemsg )->parse();
3342 $newtitle = $this->context->msg( 'yourtext' )->parse();
3344 if ( !$oldContent ) {
3345 $oldContent = $newContent->getContentHandler()->makeEmptyContent();
3348 if ( !$newContent ) {
3349 $newContent = $oldContent->getContentHandler()->makeEmptyContent();
3352 $de = $oldContent->getContentHandler()->createDifferenceEngine( $this->mArticle->getContext() );
3353 $de->setContent( $oldContent, $newContent );
3355 $difftext = $de->getDiff( $oldtitle, $newtitle );
3356 $de->showDiffStyle();
3357 } else {
3358 $difftext = '';
3361 $wgOut->addHTML( '<div id="wikiDiff">' . $difftext . '</div>' );
3365 * Show the header copyright warning.
3367 protected function showHeaderCopyrightWarning() {
3368 $msg = 'editpage-head-copy-warn';
3369 if ( !$this->context->msg( $msg )->isDisabled() ) {
3370 global $wgOut;
3371 $wgOut->wrapWikiMsg( "<div class='editpage-head-copywarn'>\n$1\n</div>",
3372 'editpage-head-copy-warn' );
3377 * Give a chance for site and per-namespace customizations of
3378 * terms of service summary link that might exist separately
3379 * from the copyright notice.
3381 * This will display between the save button and the edit tools,
3382 * so should remain short!
3384 protected function showTosSummary() {
3385 $msg = 'editpage-tos-summary';
3386 Hooks::run( 'EditPageTosSummary', [ $this->mTitle, &$msg ] );
3387 if ( !$this->context->msg( $msg )->isDisabled() ) {
3388 global $wgOut;
3389 $wgOut->addHTML( '<div class="mw-tos-summary">' );
3390 $wgOut->addWikiMsg( $msg );
3391 $wgOut->addHTML( '</div>' );
3395 protected function showEditTools() {
3396 global $wgOut;
3397 $wgOut->addHTML( '<div class="mw-editTools">' .
3398 $this->context->msg( 'edittools' )->inContentLanguage()->parse() .
3399 '</div>' );
3403 * Get the copyright warning
3405 * Renamed to getCopyrightWarning(), old name kept around for backwards compatibility
3406 * @return string
3408 protected function getCopywarn() {
3409 return self::getCopyrightWarning( $this->mTitle );
3413 * Get the copyright warning, by default returns wikitext
3415 * @param Title $title
3416 * @param string $format Output format, valid values are any function of a Message object
3417 * @param Language|string|null $langcode Language code or Language object.
3418 * @return string
3420 public static function getCopyrightWarning( $title, $format = 'plain', $langcode = null ) {
3421 global $wgRightsText;
3422 if ( $wgRightsText ) {
3423 $copywarnMsg = [ 'copyrightwarning',
3424 '[[' . wfMessage( 'copyrightpage' )->inContentLanguage()->text() . ']]',
3425 $wgRightsText ];
3426 } else {
3427 $copywarnMsg = [ 'copyrightwarning2',
3428 '[[' . wfMessage( 'copyrightpage' )->inContentLanguage()->text() . ']]' ];
3430 // Allow for site and per-namespace customization of contribution/copyright notice.
3431 Hooks::run( 'EditPageCopyrightWarning', [ $title, &$copywarnMsg ] );
3433 $msg = call_user_func_array( 'wfMessage', $copywarnMsg )->title( $title );
3434 if ( $langcode ) {
3435 $msg->inLanguage( $langcode );
3437 return "<div id=\"editpage-copywarn\">\n" .
3438 $msg->$format() . "\n</div>";
3442 * Get the Limit report for page previews
3444 * @since 1.22
3445 * @param ParserOutput $output ParserOutput object from the parse
3446 * @return string HTML
3448 public static function getPreviewLimitReport( $output ) {
3449 if ( !$output || !$output->getLimitReportData() ) {
3450 return '';
3453 $limitReport = Html::rawElement( 'div', [ 'class' => 'mw-limitReportExplanation' ],
3454 wfMessage( 'limitreport-title' )->parseAsBlock()
3457 // Show/hide animation doesn't work correctly on a table, so wrap it in a div.
3458 $limitReport .= Html::openElement( 'div', [ 'class' => 'preview-limit-report-wrapper' ] );
3460 $limitReport .= Html::openElement( 'table', [
3461 'class' => 'preview-limit-report wikitable'
3462 ] ) .
3463 Html::openElement( 'tbody' );
3465 foreach ( $output->getLimitReportData() as $key => $value ) {
3466 if ( Hooks::run( 'ParserLimitReportFormat',
3467 [ $key, &$value, &$limitReport, true, true ]
3468 ) ) {
3469 $keyMsg = wfMessage( $key );
3470 $valueMsg = wfMessage( [ "$key-value-html", "$key-value" ] );
3471 if ( !$valueMsg->exists() ) {
3472 $valueMsg = new RawMessage( '$1' );
3474 if ( !$keyMsg->isDisabled() && !$valueMsg->isDisabled() ) {
3475 $limitReport .= Html::openElement( 'tr' ) .
3476 Html::rawElement( 'th', null, $keyMsg->parse() ) .
3477 Html::rawElement( 'td', null, $valueMsg->params( $value )->parse() ) .
3478 Html::closeElement( 'tr' );
3483 $limitReport .= Html::closeElement( 'tbody' ) .
3484 Html::closeElement( 'table' ) .
3485 Html::closeElement( 'div' );
3487 return $limitReport;
3490 protected function showStandardInputs( &$tabindex = 2 ) {
3491 global $wgOut;
3492 $wgOut->addHTML( "<div class='editOptions'>\n" );
3494 if ( $this->section != 'new' ) {
3495 $this->showSummaryInput( false, $this->summary );
3496 $wgOut->addHTML( $this->getSummaryPreview( false, $this->summary ) );
3499 $checkboxes = $this->getCheckboxes( $tabindex,
3500 [ 'minor' => $this->minoredit, 'watch' => $this->watchthis ] );
3501 $wgOut->addHTML( "<div class='editCheckboxes'>" . implode( $checkboxes, "\n" ) . "</div>\n" );
3503 // Show copyright warning.
3504 $wgOut->addWikiText( $this->getCopywarn() );
3505 $wgOut->addHTML( $this->editFormTextAfterWarn );
3507 $wgOut->addHTML( "<div class='editButtons'>\n" );
3508 $wgOut->addHTML( implode( $this->getEditButtons( $tabindex ), "\n" ) . "\n" );
3510 $cancel = $this->getCancelLink();
3511 if ( $cancel !== '' ) {
3512 $cancel .= Html::element( 'span',
3513 [ 'class' => 'mw-editButtons-pipe-separator' ],
3514 $this->context->msg( 'pipe-separator' )->text() );
3517 $message = $this->context->msg( 'edithelppage' )->inContentLanguage()->text();
3518 $edithelpurl = Skin::makeInternalOrExternalUrl( $message );
3519 $attrs = [
3520 'target' => 'helpwindow',
3521 'href' => $edithelpurl,
3523 $edithelp = Html::linkButton( $this->context->msg( 'edithelp' )->text(),
3524 $attrs, [ 'mw-ui-quiet' ] ) .
3525 $this->context->msg( 'word-separator' )->escaped() .
3526 $this->context->msg( 'newwindow' )->parse();
3528 $wgOut->addHTML( " <span class='cancelLink'>{$cancel}</span>\n" );
3529 $wgOut->addHTML( " <span class='editHelp'>{$edithelp}</span>\n" );
3530 $wgOut->addHTML( "</div><!-- editButtons -->\n" );
3532 Hooks::run( 'EditPage::showStandardInputs:options', [ $this, $wgOut, &$tabindex ] );
3534 $wgOut->addHTML( "</div><!-- editOptions -->\n" );
3538 * Show an edit conflict. textbox1 is already shown in showEditForm().
3539 * If you want to use another entry point to this function, be careful.
3541 protected function showConflict() {
3542 global $wgOut;
3544 if ( Hooks::run( 'EditPageBeforeConflictDiff', [ &$this, &$wgOut ] ) ) {
3545 $stats = MediaWikiServices::getInstance()->getStatsdDataFactory();
3546 $stats->increment( 'edit.failures.conflict' );
3547 // Only include 'standard' namespaces to avoid creating unknown numbers of statsd metrics
3548 if (
3549 $this->mTitle->getNamespace() >= NS_MAIN &&
3550 $this->mTitle->getNamespace() <= NS_CATEGORY_TALK
3552 $stats->increment( 'edit.failures.conflict.byNamespaceId.' . $this->mTitle->getNamespace() );
3555 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
3557 $content1 = $this->toEditContent( $this->textbox1 );
3558 $content2 = $this->toEditContent( $this->textbox2 );
3560 $handler = ContentHandler::getForModelID( $this->contentModel );
3561 $de = $handler->createDifferenceEngine( $this->mArticle->getContext() );
3562 $de->setContent( $content2, $content1 );
3563 $de->showDiff(
3564 $this->context->msg( 'yourtext' )->parse(),
3565 $this->context->msg( 'storedversion' )->text()
3568 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
3569 $this->showTextbox2();
3574 * @return string
3576 public function getCancelLink() {
3577 $cancelParams = [];
3578 if ( !$this->isConflict && $this->oldid > 0 ) {
3579 $cancelParams['oldid'] = $this->oldid;
3580 } elseif ( $this->getContextTitle()->isRedirect() ) {
3581 $cancelParams['redirect'] = 'no';
3583 $attrs = [ 'id' => 'mw-editform-cancel' ];
3585 return Linker::linkKnown(
3586 $this->getContextTitle(),
3587 $this->context->msg( 'cancel' )->parse(),
3588 Html::buttonAttributes( $attrs, [ 'mw-ui-quiet' ] ),
3589 $cancelParams
3594 * Returns the URL to use in the form's action attribute.
3595 * This is used by EditPage subclasses when simply customizing the action
3596 * variable in the constructor is not enough. This can be used when the
3597 * EditPage lives inside of a Special page rather than a custom page action.
3599 * @param Title $title Title object for which is being edited (where we go to for &action= links)
3600 * @return string
3602 protected function getActionURL( Title $title ) {
3603 return $title->getLocalURL( [ 'action' => $this->action ] );
3607 * Check if a page was deleted while the user was editing it, before submit.
3608 * Note that we rely on the logging table, which hasn't been always there,
3609 * but that doesn't matter, because this only applies to brand new
3610 * deletes.
3611 * @return bool
3613 protected function wasDeletedSinceLastEdit() {
3614 if ( $this->deletedSinceEdit !== null ) {
3615 return $this->deletedSinceEdit;
3618 $this->deletedSinceEdit = false;
3620 if ( !$this->mTitle->exists() && $this->mTitle->isDeletedQuick() ) {
3621 $this->lastDelete = $this->getLastDelete();
3622 if ( $this->lastDelete ) {
3623 $deleteTime = wfTimestamp( TS_MW, $this->lastDelete->log_timestamp );
3624 if ( $deleteTime > $this->starttime ) {
3625 $this->deletedSinceEdit = true;
3630 return $this->deletedSinceEdit;
3634 * @return bool|stdClass
3636 protected function getLastDelete() {
3637 $dbr = wfGetDB( DB_REPLICA );
3638 $data = $dbr->selectRow(
3639 [ 'logging', 'user' ],
3641 'log_type',
3642 'log_action',
3643 'log_timestamp',
3644 'log_user',
3645 'log_namespace',
3646 'log_title',
3647 'log_comment',
3648 'log_params',
3649 'log_deleted',
3650 'user_name'
3651 ], [
3652 'log_namespace' => $this->mTitle->getNamespace(),
3653 'log_title' => $this->mTitle->getDBkey(),
3654 'log_type' => 'delete',
3655 'log_action' => 'delete',
3656 'user_id=log_user'
3658 __METHOD__,
3659 [ 'LIMIT' => 1, 'ORDER BY' => 'log_timestamp DESC' ]
3661 // Quick paranoid permission checks...
3662 if ( is_object( $data ) ) {
3663 if ( $data->log_deleted & LogPage::DELETED_USER ) {
3664 $data->user_name = $this->context->msg( 'rev-deleted-user' )->escaped();
3667 if ( $data->log_deleted & LogPage::DELETED_COMMENT ) {
3668 $data->log_comment = $this->context->msg( 'rev-deleted-comment' )->escaped();
3672 return $data;
3676 * Get the rendered text for previewing.
3677 * @throws MWException
3678 * @return string
3680 function getPreviewText() {
3681 global $wgOut, $wgRawHtml, $wgLang;
3682 global $wgAllowUserCss, $wgAllowUserJs;
3684 $stats = MediaWikiServices::getInstance()->getStatsdDataFactory();
3686 if ( $wgRawHtml && !$this->mTokenOk ) {
3687 // Could be an offsite preview attempt. This is very unsafe if
3688 // HTML is enabled, as it could be an attack.
3689 $parsedNote = '';
3690 if ( $this->textbox1 !== '' ) {
3691 // Do not put big scary notice, if previewing the empty
3692 // string, which happens when you initially edit
3693 // a category page, due to automatic preview-on-open.
3694 $parsedNote = $wgOut->parse( "<div class='previewnote'>" .
3695 $this->context->msg( 'session_fail_preview_html' )->text() . "</div>",
3696 true, /* interface */true );
3698 $stats->increment( 'edit.failures.session_loss' );
3699 return $parsedNote;
3702 $note = '';
3704 try {
3705 $content = $this->toEditContent( $this->textbox1 );
3707 $previewHTML = '';
3708 if ( !Hooks::run(
3709 'AlternateEditPreview',
3710 [ $this, &$content, &$previewHTML, &$this->mParserOutput ] )
3712 return $previewHTML;
3715 # provide a anchor link to the editform
3716 $continueEditing = '<span class="mw-continue-editing">' .
3717 '[[#' . self::EDITFORM_ID . '|' . $wgLang->getArrow() . ' ' .
3718 $this->context->msg( 'continue-editing' )->text() . ']]</span>';
3719 if ( $this->mTriedSave && !$this->mTokenOk ) {
3720 if ( $this->mTokenOkExceptSuffix ) {
3721 $note = $this->context->msg( 'token_suffix_mismatch' )->plain();
3722 $stats->increment( 'edit.failures.bad_token' );
3723 } else {
3724 $note = $this->context->msg( 'session_fail_preview' )->plain();
3725 $stats->increment( 'edit.failures.session_loss' );
3727 } elseif ( $this->incompleteForm ) {
3728 $note = $this->context->msg( 'edit_form_incomplete' )->plain();
3729 if ( $this->mTriedSave ) {
3730 $stats->increment( 'edit.failures.incomplete_form' );
3732 } else {
3733 $note = $this->context->msg( 'previewnote' )->plain() . ' ' . $continueEditing;
3736 # don't parse non-wikitext pages, show message about preview
3737 if ( $this->mTitle->isCssJsSubpage() || $this->mTitle->isCssOrJsPage() ) {
3738 if ( $this->mTitle->isCssJsSubpage() ) {
3739 $level = 'user';
3740 } elseif ( $this->mTitle->isCssOrJsPage() ) {
3741 $level = 'site';
3742 } else {
3743 $level = false;
3746 if ( $content->getModel() == CONTENT_MODEL_CSS ) {
3747 $format = 'css';
3748 if ( $level === 'user' && !$wgAllowUserCss ) {
3749 $format = false;
3751 } elseif ( $content->getModel() == CONTENT_MODEL_JAVASCRIPT ) {
3752 $format = 'js';
3753 if ( $level === 'user' && !$wgAllowUserJs ) {
3754 $format = false;
3756 } else {
3757 $format = false;
3760 # Used messages to make sure grep find them:
3761 # Messages: usercsspreview, userjspreview, sitecsspreview, sitejspreview
3762 if ( $level && $format ) {
3763 $note = "<div id='mw-{$level}{$format}preview'>" .
3764 $this->context->msg( "{$level}{$format}preview" )->text() .
3765 ' ' . $continueEditing . "</div>";
3769 # If we're adding a comment, we need to show the
3770 # summary as the headline
3771 if ( $this->section === "new" && $this->summary !== "" ) {
3772 $content = $content->addSectionHeader( $this->summary );
3775 $hook_args = [ $this, &$content ];
3776 ContentHandler::runLegacyHooks( 'EditPageGetPreviewText', $hook_args, '1.25' );
3777 Hooks::run( 'EditPageGetPreviewContent', $hook_args );
3779 $parserResult = $this->doPreviewParse( $content );
3780 $parserOutput = $parserResult['parserOutput'];
3781 $previewHTML = $parserResult['html'];
3782 $this->mParserOutput = $parserOutput;
3783 $wgOut->addParserOutputMetadata( $parserOutput );
3785 if ( count( $parserOutput->getWarnings() ) ) {
3786 $note .= "\n\n" . implode( "\n\n", $parserOutput->getWarnings() );
3789 } catch ( MWContentSerializationException $ex ) {
3790 $m = $this->context->msg(
3791 'content-failed-to-parse',
3792 $this->contentModel,
3793 $this->contentFormat,
3794 $ex->getMessage()
3796 $note .= "\n\n" . $m->parse();
3797 $previewHTML = '';
3800 if ( $this->isConflict ) {
3801 $conflict = '<h2 id="mw-previewconflict">'
3802 . $this->context->msg( 'previewconflict' )->escaped() . "</h2>\n";
3803 } else {
3804 $conflict = '<hr />';
3807 $previewhead = "<div class='previewnote'>\n" .
3808 '<h2 id="mw-previewheader">' . $this->context->msg( 'preview' )->escaped() . "</h2>" .
3809 $wgOut->parse( $note, true, /* interface */true ) . $conflict . "</div>\n";
3811 $pageViewLang = $this->mTitle->getPageViewLanguage();
3812 $attribs = [ 'lang' => $pageViewLang->getHtmlCode(), 'dir' => $pageViewLang->getDir(),
3813 'class' => 'mw-content-' . $pageViewLang->getDir() ];
3814 $previewHTML = Html::rawElement( 'div', $attribs, $previewHTML );
3816 return $previewhead . $previewHTML . $this->previewTextAfterContent;
3820 * Get parser options for a preview
3821 * @return ParserOptions
3823 protected function getPreviewParserOptions() {
3824 $parserOptions = $this->page->makeParserOptions( $this->mArticle->getContext() );
3825 $parserOptions->setIsPreview( true );
3826 $parserOptions->setIsSectionPreview( !is_null( $this->section ) && $this->section !== '' );
3827 $parserOptions->enableLimitReport();
3828 return $parserOptions;
3832 * Parse the page for a preview. Subclasses may override this class, in order
3833 * to parse with different options, or to otherwise modify the preview HTML.
3835 * @param Content $content The page content
3836 * @return array with keys:
3837 * - parserOutput: The ParserOutput object
3838 * - html: The HTML to be displayed
3840 protected function doPreviewParse( Content $content ) {
3841 global $wgUser;
3842 $parserOptions = $this->getPreviewParserOptions();
3843 $pstContent = $content->preSaveTransform( $this->mTitle, $wgUser, $parserOptions );
3844 $scopedCallback = $parserOptions->setupFakeRevision(
3845 $this->mTitle, $pstContent, $wgUser );
3846 $parserOutput = $pstContent->getParserOutput( $this->mTitle, null, $parserOptions );
3847 ScopedCallback::consume( $scopedCallback );
3848 $parserOutput->setEditSectionTokens( false ); // no section edit links
3849 return [
3850 'parserOutput' => $parserOutput,
3851 'html' => $parserOutput->getText() ];
3855 * @return array
3857 function getTemplates() {
3858 if ( $this->preview || $this->section != '' ) {
3859 $templates = [];
3860 if ( !isset( $this->mParserOutput ) ) {
3861 return $templates;
3863 foreach ( $this->mParserOutput->getTemplates() as $ns => $template ) {
3864 foreach ( array_keys( $template ) as $dbk ) {
3865 $templates[] = Title::makeTitle( $ns, $dbk );
3868 return $templates;
3869 } else {
3870 return $this->mTitle->getTemplateLinksFrom();
3875 * Shows a bulletin board style toolbar for common editing functions.
3876 * It can be disabled in the user preferences.
3878 * @param Title $title Title object for the page being edited (optional)
3879 * @return string
3881 static function getEditToolbar( $title = null ) {
3882 global $wgContLang, $wgOut;
3883 global $wgEnableUploads, $wgForeignFileRepos;
3885 $imagesAvailable = $wgEnableUploads || count( $wgForeignFileRepos );
3886 $showSignature = true;
3887 if ( $title ) {
3888 $showSignature = MWNamespace::wantSignatures( $title->getNamespace() );
3892 * $toolarray is an array of arrays each of which includes the
3893 * opening tag, the closing tag, optionally a sample text that is
3894 * inserted between the two when no selection is highlighted
3895 * and. The tip text is shown when the user moves the mouse
3896 * over the button.
3898 * Images are defined in ResourceLoaderEditToolbarModule.
3900 $toolarray = [
3902 'id' => 'mw-editbutton-bold',
3903 'open' => '\'\'\'',
3904 'close' => '\'\'\'',
3905 'sample' => wfMessage( 'bold_sample' )->text(),
3906 'tip' => wfMessage( 'bold_tip' )->text(),
3909 'id' => 'mw-editbutton-italic',
3910 'open' => '\'\'',
3911 'close' => '\'\'',
3912 'sample' => wfMessage( 'italic_sample' )->text(),
3913 'tip' => wfMessage( 'italic_tip' )->text(),
3916 'id' => 'mw-editbutton-link',
3917 'open' => '[[',
3918 'close' => ']]',
3919 'sample' => wfMessage( 'link_sample' )->text(),
3920 'tip' => wfMessage( 'link_tip' )->text(),
3923 'id' => 'mw-editbutton-extlink',
3924 'open' => '[',
3925 'close' => ']',
3926 'sample' => wfMessage( 'extlink_sample' )->text(),
3927 'tip' => wfMessage( 'extlink_tip' )->text(),
3930 'id' => 'mw-editbutton-headline',
3931 'open' => "\n== ",
3932 'close' => " ==\n",
3933 'sample' => wfMessage( 'headline_sample' )->text(),
3934 'tip' => wfMessage( 'headline_tip' )->text(),
3936 $imagesAvailable ? [
3937 'id' => 'mw-editbutton-image',
3938 'open' => '[[' . $wgContLang->getNsText( NS_FILE ) . ':',
3939 'close' => ']]',
3940 'sample' => wfMessage( 'image_sample' )->text(),
3941 'tip' => wfMessage( 'image_tip' )->text(),
3942 ] : false,
3943 $imagesAvailable ? [
3944 'id' => 'mw-editbutton-media',
3945 'open' => '[[' . $wgContLang->getNsText( NS_MEDIA ) . ':',
3946 'close' => ']]',
3947 'sample' => wfMessage( 'media_sample' )->text(),
3948 'tip' => wfMessage( 'media_tip' )->text(),
3949 ] : false,
3951 'id' => 'mw-editbutton-nowiki',
3952 'open' => "<nowiki>",
3953 'close' => "</nowiki>",
3954 'sample' => wfMessage( 'nowiki_sample' )->text(),
3955 'tip' => wfMessage( 'nowiki_tip' )->text(),
3957 $showSignature ? [
3958 'id' => 'mw-editbutton-signature',
3959 'open' => wfMessage( 'sig-text', '~~~~' )->inContentLanguage()->text(),
3960 'close' => '',
3961 'sample' => '',
3962 'tip' => wfMessage( 'sig_tip' )->text(),
3963 ] : false,
3965 'id' => 'mw-editbutton-hr',
3966 'open' => "\n----\n",
3967 'close' => '',
3968 'sample' => '',
3969 'tip' => wfMessage( 'hr_tip' )->text(),
3973 $script = 'mw.loader.using("mediawiki.toolbar", function () {';
3974 foreach ( $toolarray as $tool ) {
3975 if ( !$tool ) {
3976 continue;
3979 $params = [
3980 // Images are defined in ResourceLoaderEditToolbarModule
3981 false,
3982 // Note that we use the tip both for the ALT tag and the TITLE tag of the image.
3983 // Older browsers show a "speedtip" type message only for ALT.
3984 // Ideally these should be different, realistically they
3985 // probably don't need to be.
3986 $tool['tip'],
3987 $tool['open'],
3988 $tool['close'],
3989 $tool['sample'],
3990 $tool['id'],
3993 $script .= Xml::encodeJsCall(
3994 'mw.toolbar.addButton',
3995 $params,
3996 ResourceLoader::inDebugMode()
4000 $script .= '});';
4001 $wgOut->addScript( ResourceLoader::makeInlineScript( $script ) );
4003 $toolbar = '<div id="toolbar"></div>';
4005 Hooks::run( 'EditPageBeforeEditToolbar', [ &$toolbar ] );
4007 return $toolbar;
4011 * Returns an array of html code of the following checkboxes:
4012 * minor and watch
4014 * @param int $tabindex Current tabindex
4015 * @param array $checked Array of checkbox => bool, where bool indicates the checked
4016 * status of the checkbox
4018 * @return array
4020 public function getCheckboxes( &$tabindex, $checked ) {
4021 global $wgUser, $wgUseMediaWikiUIEverywhere;
4023 $checkboxes = [];
4025 // don't show the minor edit checkbox if it's a new page or section
4026 if ( !$this->isNew ) {
4027 $checkboxes['minor'] = '';
4028 $minorLabel = $this->context->msg( 'minoredit' )->parse();
4029 if ( $wgUser->isAllowed( 'minoredit' ) ) {
4030 $attribs = [
4031 'tabindex' => ++$tabindex,
4032 'accesskey' => $this->context->msg( 'accesskey-minoredit' )->text(),
4033 'id' => 'wpMinoredit',
4035 $minorEditHtml =
4036 Xml::check( 'wpMinoredit', $checked['minor'], $attribs ) .
4037 "&#160;<label for='wpMinoredit' id='mw-editpage-minoredit'" .
4038 Xml::expandAttributes( [ 'title' => Linker::titleAttrib( 'minoredit', 'withaccess' ) ] ) .
4039 ">{$minorLabel}</label>";
4041 if ( $wgUseMediaWikiUIEverywhere ) {
4042 $checkboxes['minor'] = Html::openElement( 'div', [ 'class' => 'mw-ui-checkbox' ] ) .
4043 $minorEditHtml .
4044 Html::closeElement( 'div' );
4045 } else {
4046 $checkboxes['minor'] = $minorEditHtml;
4051 $watchLabel = $this->context->msg( 'watchthis' )->parse();
4052 $checkboxes['watch'] = '';
4053 if ( $wgUser->isLoggedIn() ) {
4054 $attribs = [
4055 'tabindex' => ++$tabindex,
4056 'accesskey' => $this->context->msg( 'accesskey-watch' )->text(),
4057 'id' => 'wpWatchthis',
4059 $watchThisHtml =
4060 Xml::check( 'wpWatchthis', $checked['watch'], $attribs ) .
4061 "&#160;<label for='wpWatchthis' id='mw-editpage-watch'" .
4062 Xml::expandAttributes( [ 'title' => Linker::titleAttrib( 'watch', 'withaccess' ) ] ) .
4063 ">{$watchLabel}</label>";
4064 if ( $wgUseMediaWikiUIEverywhere ) {
4065 $checkboxes['watch'] = Html::openElement( 'div', [ 'class' => 'mw-ui-checkbox' ] ) .
4066 $watchThisHtml .
4067 Html::closeElement( 'div' );
4068 } else {
4069 $checkboxes['watch'] = $watchThisHtml;
4072 Hooks::run( 'EditPageBeforeEditChecks', [ &$this, &$checkboxes, &$tabindex ] );
4073 return $checkboxes;
4077 * Returns an array of html code of the following buttons:
4078 * save, diff and preview
4080 * @param int $tabindex Current tabindex
4082 * @return array
4084 public function getEditButtons( &$tabindex ) {
4085 $buttons = [];
4087 $labelAsPublish =
4088 $this->mArticle->getContext()->getConfig()->get( 'EditSubmitButtonLabelPublish' );
4090 // Can't use $this->isNew as that's also true if we're adding a new section to an extant page
4091 if ( $labelAsPublish ) {
4092 $buttonLabelKey = !$this->mTitle->exists() ? 'publishpage' : 'publishchanges';
4093 } else {
4094 $buttonLabelKey = !$this->mTitle->exists() ? 'savearticle' : 'savechanges';
4096 $buttonLabel = $this->context->msg( $buttonLabelKey )->text();
4097 $attribs = [
4098 'id' => 'wpSave',
4099 'name' => 'wpSave',
4100 'tabindex' => ++$tabindex,
4101 ] + Linker::tooltipAndAccesskeyAttribs( 'save' );
4102 $buttons['save'] = Html::submitButton( $buttonLabel, $attribs, [ 'mw-ui-progressive' ] );
4104 ++$tabindex; // use the same for preview and live preview
4105 $attribs = [
4106 'id' => 'wpPreview',
4107 'name' => 'wpPreview',
4108 'tabindex' => $tabindex,
4109 ] + Linker::tooltipAndAccesskeyAttribs( 'preview' );
4110 $buttons['preview'] = Html::submitButton( $this->context->msg( 'showpreview' )->text(),
4111 $attribs );
4113 $attribs = [
4114 'id' => 'wpDiff',
4115 'name' => 'wpDiff',
4116 'tabindex' => ++$tabindex,
4117 ] + Linker::tooltipAndAccesskeyAttribs( 'diff' );
4118 $buttons['diff'] = Html::submitButton( $this->context->msg( 'showdiff' )->text(),
4119 $attribs );
4121 Hooks::run( 'EditPageBeforeEditButtons', [ &$this, &$buttons, &$tabindex ] );
4122 return $buttons;
4126 * Creates a basic error page which informs the user that
4127 * they have attempted to edit a nonexistent section.
4129 function noSuchSectionPage() {
4130 global $wgOut;
4132 $wgOut->prepareErrorPage( $this->context->msg( 'nosuchsectiontitle' ) );
4134 $res = $this->context->msg( 'nosuchsectiontext', $this->section )->parseAsBlock();
4135 Hooks::run( 'EditPageNoSuchSection', [ &$this, &$res ] );
4136 $wgOut->addHTML( $res );
4138 $wgOut->returnToMain( false, $this->mTitle );
4142 * Show "your edit contains spam" page with your diff and text
4144 * @param string|array|bool $match Text (or array of texts) which triggered one or more filters
4146 public function spamPageWithContent( $match = false ) {
4147 global $wgOut, $wgLang;
4148 $this->textbox2 = $this->textbox1;
4150 if ( is_array( $match ) ) {
4151 $match = $wgLang->listToText( $match );
4153 $wgOut->prepareErrorPage( $this->context->msg( 'spamprotectiontitle' ) );
4155 $wgOut->addHTML( '<div id="spamprotected">' );
4156 $wgOut->addWikiMsg( 'spamprotectiontext' );
4157 if ( $match ) {
4158 $wgOut->addWikiMsg( 'spamprotectionmatch', wfEscapeWikiText( $match ) );
4160 $wgOut->addHTML( '</div>' );
4162 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
4163 $this->showDiff();
4165 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
4166 $this->showTextbox2();
4168 $wgOut->addReturnTo( $this->getContextTitle(), [ 'action' => 'edit' ] );
4172 * Check if the browser is on a blacklist of user-agents known to
4173 * mangle UTF-8 data on form submission. Returns true if Unicode
4174 * should make it through, false if it's known to be a problem.
4175 * @return bool
4177 private function checkUnicodeCompliantBrowser() {
4178 global $wgBrowserBlackList, $wgRequest;
4180 $currentbrowser = $wgRequest->getHeader( 'User-Agent' );
4181 if ( $currentbrowser === false ) {
4182 // No User-Agent header sent? Trust it by default...
4183 return true;
4186 foreach ( $wgBrowserBlackList as $browser ) {
4187 if ( preg_match( $browser, $currentbrowser ) ) {
4188 return false;
4191 return true;
4195 * Filter an input field through a Unicode de-armoring process if it
4196 * came from an old browser with known broken Unicode editing issues.
4198 * @param WebRequest $request
4199 * @param string $field
4200 * @return string
4202 protected function safeUnicodeInput( $request, $field ) {
4203 $text = rtrim( $request->getText( $field ) );
4204 return $request->getBool( 'safemode' )
4205 ? $this->unmakeSafe( $text )
4206 : $text;
4210 * Filter an output field through a Unicode armoring process if it is
4211 * going to an old browser with known broken Unicode editing issues.
4213 * @param string $text
4214 * @return string
4216 protected function safeUnicodeOutput( $text ) {
4217 return $this->checkUnicodeCompliantBrowser()
4218 ? $text
4219 : $this->makeSafe( $text );
4223 * A number of web browsers are known to corrupt non-ASCII characters
4224 * in a UTF-8 text editing environment. To protect against this,
4225 * detected browsers will be served an armored version of the text,
4226 * with non-ASCII chars converted to numeric HTML character references.
4228 * Preexisting such character references will have a 0 added to them
4229 * to ensure that round-trips do not alter the original data.
4231 * @param string $invalue
4232 * @return string
4234 private function makeSafe( $invalue ) {
4235 // Armor existing references for reversibility.
4236 $invalue = strtr( $invalue, [ "&#x" => "&#x0" ] );
4238 $bytesleft = 0;
4239 $result = "";
4240 $working = 0;
4241 $valueLength = strlen( $invalue );
4242 for ( $i = 0; $i < $valueLength; $i++ ) {
4243 $bytevalue = ord( $invalue[$i] );
4244 if ( $bytevalue <= 0x7F ) { // 0xxx xxxx
4245 $result .= chr( $bytevalue );
4246 $bytesleft = 0;
4247 } elseif ( $bytevalue <= 0xBF ) { // 10xx xxxx
4248 $working = $working << 6;
4249 $working += ( $bytevalue & 0x3F );
4250 $bytesleft--;
4251 if ( $bytesleft <= 0 ) {
4252 $result .= "&#x" . strtoupper( dechex( $working ) ) . ";";
4254 } elseif ( $bytevalue <= 0xDF ) { // 110x xxxx
4255 $working = $bytevalue & 0x1F;
4256 $bytesleft = 1;
4257 } elseif ( $bytevalue <= 0xEF ) { // 1110 xxxx
4258 $working = $bytevalue & 0x0F;
4259 $bytesleft = 2;
4260 } else { // 1111 0xxx
4261 $working = $bytevalue & 0x07;
4262 $bytesleft = 3;
4265 return $result;
4269 * Reverse the previously applied transliteration of non-ASCII characters
4270 * back to UTF-8. Used to protect data from corruption by broken web browsers
4271 * as listed in $wgBrowserBlackList.
4273 * @param string $invalue
4274 * @return string
4276 private function unmakeSafe( $invalue ) {
4277 $result = "";
4278 $valueLength = strlen( $invalue );
4279 for ( $i = 0; $i < $valueLength; $i++ ) {
4280 if ( ( substr( $invalue, $i, 3 ) == "&#x" ) && ( $invalue[$i + 3] != '0' ) ) {
4281 $i += 3;
4282 $hexstring = "";
4283 do {
4284 $hexstring .= $invalue[$i];
4285 $i++;
4286 } while ( ctype_xdigit( $invalue[$i] ) && ( $i < strlen( $invalue ) ) );
4288 // Do some sanity checks. These aren't needed for reversibility,
4289 // but should help keep the breakage down if the editor
4290 // breaks one of the entities whilst editing.
4291 if ( ( substr( $invalue, $i, 1 ) == ";" ) && ( strlen( $hexstring ) <= 6 ) ) {
4292 $codepoint = hexdec( $hexstring );
4293 $result .= UtfNormal\Utils::codepointToUtf8( $codepoint );
4294 } else {
4295 $result .= "&#x" . $hexstring . substr( $invalue, $i, 1 );
4297 } else {
4298 $result .= substr( $invalue, $i, 1 );
4301 // reverse the transform that we made for reversibility reasons.
4302 return strtr( $result, [ "&#x0" => "&#x" ] );
4306 * @since 1.29
4308 protected function addEditNotices() {
4309 global $wgOut;
4311 $editNotices = $this->mTitle->getEditNotices( $this->oldid );
4312 if ( count( $editNotices ) ) {
4313 $wgOut->addHTML( implode( "\n", $editNotices ) );
4314 } else {
4315 $msg = $this->context->msg( 'editnotice-notext' );
4316 if ( !$msg->isDisabled() ) {
4317 $wgOut->addHTML(
4318 '<div class="mw-editnotice-notext">'
4319 . $msg->parseAsBlock()
4320 . '</div>'
4327 * @since 1.29
4329 protected function addTalkPageText() {
4330 global $wgOut;
4332 if ( $this->mTitle->isTalkPage() ) {
4333 $wgOut->addWikiMsg( 'talkpagetext' );
4338 * @since 1.29
4340 protected function addLongPageWarningHeader() {
4341 global $wgMaxArticleSize, $wgOut, $wgLang;
4343 if ( $this->contentLength === false ) {
4344 $this->contentLength = strlen( $this->textbox1 );
4347 if ( $this->tooBig || $this->contentLength > $wgMaxArticleSize * 1024 ) {
4348 $wgOut->wrapWikiMsg( "<div class='error' id='mw-edit-longpageerror'>\n$1\n</div>",
4350 'longpageerror',
4351 $wgLang->formatNum( round( $this->contentLength / 1024, 3 ) ),
4352 $wgLang->formatNum( $wgMaxArticleSize )
4355 } else {
4356 if ( !$this->context->msg( 'longpage-hint' )->isDisabled() ) {
4357 $wgOut->wrapWikiMsg( "<div id='mw-edit-longpage-hint'>\n$1\n</div>",
4359 'longpage-hint',
4360 $wgLang->formatSize( strlen( $this->textbox1 ) ),
4361 strlen( $this->textbox1 )
4369 * @since 1.29
4371 protected function addPageProtectionWarningHeaders() {
4372 global $wgOut;
4374 if ( $this->mTitle->isProtected( 'edit' ) &&
4375 MWNamespace::getRestrictionLevels( $this->mTitle->getNamespace() ) !== [ '' ]
4377 # Is the title semi-protected?
4378 if ( $this->mTitle->isSemiProtected() ) {
4379 $noticeMsg = 'semiprotectedpagewarning';
4380 } else {
4381 # Then it must be protected based on static groups (regular)
4382 $noticeMsg = 'protectedpagewarning';
4384 LogEventsList::showLogExtract( $wgOut, 'protect', $this->mTitle, '',
4385 [ 'lim' => 1, 'msgKey' => [ $noticeMsg ] ] );
4387 if ( $this->mTitle->isCascadeProtected() ) {
4388 # Is this page under cascading protection from some source pages?
4389 /** @var Title[] $cascadeSources */
4390 list( $cascadeSources, /* $restrictions */ ) = $this->mTitle->getCascadeProtectionSources();
4391 $notice = "<div class='mw-cascadeprotectedwarning'>\n$1\n";
4392 $cascadeSourcesCount = count( $cascadeSources );
4393 if ( $cascadeSourcesCount > 0 ) {
4394 # Explain, and list the titles responsible
4395 foreach ( $cascadeSources as $page ) {
4396 $notice .= '* [[:' . $page->getPrefixedText() . "]]\n";
4399 $notice .= '</div>';
4400 $wgOut->wrapWikiMsg( $notice, [ 'cascadeprotectedwarning', $cascadeSourcesCount ] );
4402 if ( !$this->mTitle->exists() && $this->mTitle->getRestrictions( 'create' ) ) {
4403 LogEventsList::showLogExtract( $wgOut, 'protect', $this->mTitle, '',
4404 [ 'lim' => 1,
4405 'showIfEmpty' => false,
4406 'msgKey' => [ 'titleprotectedwarning' ],
4407 'wrap' => "<div class=\"mw-titleprotectedwarning\">\n$1</div>" ] );
4412 * @param OutputPage $out
4413 * @since 1.29
4415 protected function addExplainConflictHeader( OutputPage $out ) {
4416 $out->wrapWikiMsg( "<div class='mw-explainconflict'>\n$1\n</div>", 'explainconflict' );
4420 * @param string $name
4421 * @param mixed[] $customAttribs
4422 * @param User $user
4423 * @return mixed[]
4424 * @since 1.29
4426 protected function buildTextboxAttribs( $name, array $customAttribs, User $user ) {
4427 $attribs = $customAttribs + [
4428 'accesskey' => ',',
4429 'id' => $name,
4430 'cols' => $user->getIntOption( 'cols' ),
4431 'rows' => $user->getIntOption( 'rows' ),
4432 // Avoid PHP notices when appending preferences
4433 // (appending allows customAttribs['style'] to still work).
4434 'style' => ''
4437 // The following classes can be used here:
4438 // * mw-editfont-default
4439 // * mw-editfont-monospace
4440 // * mw-editfont-sans-serif
4441 // * mw-editfont-serif
4442 $class = 'mw-editfont-' . $user->getOption( 'editfont' );
4444 if ( isset( $attribs['class'] ) ) {
4445 if ( is_string( $attribs['class'] ) ) {
4446 $attribs['class'] .= ' ' . $class;
4447 } elseif ( is_array( $attribs['class'] ) ) {
4448 $attribs['class'][] = $class;
4450 } else {
4451 $attribs['class'] = $class;
4454 $pageLang = $this->mTitle->getPageLanguage();
4455 $attribs['lang'] = $pageLang->getHtmlCode();
4456 $attribs['dir'] = $pageLang->getDir();
4458 return $attribs;
4462 * @param string $wikitext
4463 * @return string
4464 * @since 1.29
4466 protected function addNewLineAtEnd( $wikitext ) {
4467 if ( strval( $wikitext ) !== '' ) {
4468 // Ensure there's a newline at the end, otherwise adding lines
4469 // is awkward.
4470 // But don't add a newline if the text is empty, or Firefox in XHTML
4471 // mode will show an extra newline. A bit annoying.
4472 $wikitext .= "\n";
4473 return $wikitext;
4475 return $wikitext;