Merge "Remove parameter 'options' from hook 'SkinEditSectionLinks'"
[lhc/web/wiklou.git] / includes / EditPage.php
1 <?php
2 /**
3 * User interface for page editing.
4 *
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.
9 *
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.
14 *
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
19 *
20 * @file
21 */
22
23 use MediaWiki\EditPage\TextboxBuilder;
24 use MediaWiki\EditPage\TextConflictHelper;
25 use MediaWiki\Logger\LoggerFactory;
26 use MediaWiki\MediaWikiServices;
27 use Wikimedia\ScopedCallback;
28
29 /**
30 * The edit page/HTML interface (split from Article)
31 * The actual database and text munging is still in Article,
32 * but it should get easier to call those from alternate
33 * interfaces.
34 *
35 * EditPage cares about two distinct titles:
36 * $this->mContextTitle is the page that forms submit to, links point to,
37 * redirects go to, etc. $this->mTitle (as well as $mArticle) is the
38 * page in the database that is actually being edited. These are
39 * usually the same, but they are now allowed to be different.
40 *
41 * Surgeon General's Warning: prolonged exposure to this class is known to cause
42 * headaches, which may be fatal.
43 */
44 class EditPage {
45 /**
46 * Used for Unicode support checks
47 */
48 const UNICODE_CHECK = 'ℳ𝒲β™₯π“Šπ“ƒπ’Ύπ’Έβ„΄π’Ήβ„―';
49
50 /**
51 * Status: Article successfully updated
52 */
53 const AS_SUCCESS_UPDATE = 200;
54
55 /**
56 * Status: Article successfully created
57 */
58 const AS_SUCCESS_NEW_ARTICLE = 201;
59
60 /**
61 * Status: Article update aborted by a hook function
62 */
63 const AS_HOOK_ERROR = 210;
64
65 /**
66 * Status: A hook function returned an error
67 */
68 const AS_HOOK_ERROR_EXPECTED = 212;
69
70 /**
71 * Status: User is blocked from editing this page
72 */
73 const AS_BLOCKED_PAGE_FOR_USER = 215;
74
75 /**
76 * Status: Content too big (> $wgMaxArticleSize)
77 */
78 const AS_CONTENT_TOO_BIG = 216;
79
80 /**
81 * Status: this anonymous user is not allowed to edit this page
82 */
83 const AS_READ_ONLY_PAGE_ANON = 218;
84
85 /**
86 * Status: this logged in user is not allowed to edit this page
87 */
88 const AS_READ_ONLY_PAGE_LOGGED = 219;
89
90 /**
91 * Status: wiki is in readonly mode (wfReadOnly() == true)
92 */
93 const AS_READ_ONLY_PAGE = 220;
94
95 /**
96 * Status: rate limiter for action 'edit' was tripped
97 */
98 const AS_RATE_LIMITED = 221;
99
100 /**
101 * Status: article was deleted while editing and param wpRecreate == false or form
102 * was not posted
103 */
104 const AS_ARTICLE_WAS_DELETED = 222;
105
106 /**
107 * Status: user tried to create this page, but is not allowed to do that
108 * ( Title->userCan('create') == false )
109 */
110 const AS_NO_CREATE_PERMISSION = 223;
111
112 /**
113 * Status: user tried to create a blank page and wpIgnoreBlankArticle == false
114 */
115 const AS_BLANK_ARTICLE = 224;
116
117 /**
118 * Status: (non-resolvable) edit conflict
119 */
120 const AS_CONFLICT_DETECTED = 225;
121
122 /**
123 * Status: no edit summary given and the user has forceeditsummary set and the user is not
124 * editing in his own userspace or talkspace and wpIgnoreBlankSummary == false
125 */
126 const AS_SUMMARY_NEEDED = 226;
127
128 /**
129 * Status: user tried to create a new section without content
130 */
131 const AS_TEXTBOX_EMPTY = 228;
132
133 /**
134 * Status: article is too big (> $wgMaxArticleSize), after merging in the new section
135 */
136 const AS_MAX_ARTICLE_SIZE_EXCEEDED = 229;
137
138 /**
139 * Status: WikiPage::doEdit() was unsuccessful
140 */
141 const AS_END = 231;
142
143 /**
144 * Status: summary contained spam according to one of the regexes in $wgSummarySpamRegex
145 */
146 const AS_SPAM_ERROR = 232;
147
148 /**
149 * Status: anonymous user is not allowed to upload (User::isAllowed('upload') == false)
150 */
151 const AS_IMAGE_REDIRECT_ANON = 233;
152
153 /**
154 * Status: logged in user is not allowed to upload (User::isAllowed('upload') == false)
155 */
156 const AS_IMAGE_REDIRECT_LOGGED = 234;
157
158 /**
159 * Status: user tried to modify the content model, but is not allowed to do that
160 * ( User::isAllowed('editcontentmodel') == false )
161 */
162 const AS_NO_CHANGE_CONTENT_MODEL = 235;
163
164 /**
165 * Status: user tried to create self-redirect (redirect to the same article) and
166 * wpIgnoreSelfRedirect == false
167 */
168 const AS_SELF_REDIRECT = 236;
169
170 /**
171 * Status: an error relating to change tagging. Look at the message key for
172 * more details
173 */
174 const AS_CHANGE_TAG_ERROR = 237;
175
176 /**
177 * Status: can't parse content
178 */
179 const AS_PARSE_ERROR = 240;
180
181 /**
182 * Status: when changing the content model is disallowed due to
183 * $wgContentHandlerUseDB being false
184 */
185 const AS_CANNOT_USE_CUSTOM_MODEL = 241;
186
187 /**
188 * Status: edit rejected because browser doesn't support Unicode.
189 */
190 const AS_UNICODE_NOT_SUPPORTED = 242;
191
192 /**
193 * HTML id and name for the beginning of the edit form.
194 */
195 const EDITFORM_ID = 'editform';
196
197 /**
198 * Prefix of key for cookie used to pass post-edit state.
199 * The revision id edited is added after this
200 */
201 const POST_EDIT_COOKIE_KEY_PREFIX = 'PostEditRevision';
202
203 /**
204 * Duration of PostEdit cookie, in seconds.
205 * The cookie will be removed instantly if the JavaScript runs.
206 *
207 * Otherwise, though, we don't want the cookies to accumulate.
208 * RFC 2109 ( https://www.ietf.org/rfc/rfc2109.txt ) specifies a possible
209 * limit of only 20 cookies per domain. This still applies at least to some
210 * versions of IE without full updates:
211 * https://blogs.msdn.com/b/ieinternals/archive/2009/08/20/wininet-ie-cookie-internals-faq.aspx
212 *
213 * A value of 20 minutes should be enough to take into account slow loads and minor
214 * clock skew while still avoiding cookie accumulation when JavaScript is turned off.
215 */
216 const POST_EDIT_COOKIE_DURATION = 1200;
217
218 /**
219 * @deprecated for public usage since 1.30 use EditPage::getArticle()
220 * @var Article
221 */
222 public $mArticle;
223 /** @var WikiPage */
224 private $page;
225
226 /**
227 * @deprecated for public usage since 1.30 use EditPage::getTitle()
228 * @var Title
229 */
230 public $mTitle;
231
232 /** @var null|Title */
233 private $mContextTitle = null;
234
235 /** @var string */
236 public $action = 'submit';
237
238 /** @var bool Whether an edit conflict needs to be resolved. Detected based on whether
239 * $editRevId is different than the latest revision. When a conflict has successfully
240 * been resolved by a 3-way-merge, this field is set to false.
241 */
242 public $isConflict = false;
243
244 /** @var bool New page or new section */
245 public $isNew = false;
246
247 /** @var bool */
248 public $deletedSinceEdit;
249
250 /** @var string */
251 public $formtype;
252
253 /** @var bool
254 * True the first time the edit form is rendered, false after re-rendering
255 * with diff, save prompts, etc.
256 */
257 public $firsttime;
258
259 /** @var bool|stdClass */
260 public $lastDelete;
261
262 /** @var bool */
263 public $mTokenOk = false;
264
265 /** @var bool */
266 public $mTokenOkExceptSuffix = false;
267
268 /** @var bool */
269 public $mTriedSave = false;
270
271 /** @var bool */
272 public $incompleteForm = false;
273
274 /** @var bool */
275 public $tooBig = false;
276
277 /** @var bool */
278 public $missingComment = false;
279
280 /** @var bool */
281 public $missingSummary = false;
282
283 /** @var bool */
284 public $allowBlankSummary = false;
285
286 /** @var bool */
287 protected $blankArticle = false;
288
289 /** @var bool */
290 protected $allowBlankArticle = false;
291
292 /** @var bool */
293 protected $selfRedirect = false;
294
295 /** @var bool */
296 protected $allowSelfRedirect = false;
297
298 /** @var string */
299 public $autoSumm = '';
300
301 /** @var string */
302 public $hookError = '';
303
304 /** @var ParserOutput */
305 public $mParserOutput;
306
307 /** @var bool Has a summary been preset using GET parameter &summary= ? */
308 public $hasPresetSummary = false;
309
310 /** @var Revision|bool|null A revision object corresponding to $this->editRevId. */
311 public $mBaseRevision = false;
312
313 /** @var bool */
314 public $mShowSummaryField = true;
315
316 # Form values
317
318 /** @var bool */
319 public $save = false;
320
321 /** @var bool */
322 public $preview = false;
323
324 /** @var bool */
325 public $diff = false;
326
327 /** @var bool */
328 public $minoredit = false;
329
330 /** @var bool */
331 public $watchthis = false;
332
333 /** @var bool */
334 public $recreate = false;
335
336 /** @var string
337 * Page content input field.
338 */
339 public $textbox1 = '';
340
341 /** @var string */
342 public $textbox2 = '';
343
344 /** @var string */
345 public $summary = '';
346
347 /** @var bool
348 * If true, hide the summary field.
349 */
350 public $nosummary = false;
351
352 /** @var string
353 * Timestamp of the latest revision of the page when editing was initiated
354 * on the client.
355 */
356 public $edittime = '';
357
358 /** @var int Revision ID of the latest revision of the page when editing
359 * was initiated on the client. This is used to detect and resolve edit
360 * conflicts.
361 *
362 * @note 0 if the page did not exist at that time.
363 * @note When starting an edit from an old revision, this still records the current
364 * revision at the time, not the one the edit is based on.
365 *
366 * @see $oldid
367 * @see getBaseRevision()
368 */
369 private $editRevId = null;
370
371 /** @var string */
372 public $section = '';
373
374 /** @var string */
375 public $sectiontitle = '';
376
377 /** @var string
378 * Timestamp from the first time the edit form was rendered.
379 */
380 public $starttime = '';
381
382 /** @var int Revision ID the edit is based on, or 0 if it's the current revision.
383 * FIXME: This isn't used in conflict resolution--provide a better
384 * justification or merge with parentRevId.
385 * @see $editRevId
386 */
387 public $oldid = 0;
388
389 /** @var int Revision ID the edit is based on, adjusted when an edit conflict is resolved.
390 * @see $editRevId
391 * @see $oldid
392 * @see getparentRevId()
393 */
394 public $parentRevId = 0;
395
396 /** @var string */
397 public $editintro = '';
398
399 /** @var null */
400 public $scrolltop = null;
401
402 /** @var bool */
403 public $bot = true;
404
405 /** @var string */
406 public $contentModel;
407
408 /** @var null|string */
409 public $contentFormat = null;
410
411 /** @var null|array */
412 private $changeTags = null;
413
414 # Placeholders for text injection by hooks (must be HTML)
415 # extensions should take care to _append_ to the present value
416
417 /** @var string Before even the preview */
418 public $editFormPageTop = '';
419 public $editFormTextTop = '';
420 public $editFormTextBeforeContent = '';
421 public $editFormTextAfterWarn = '';
422 public $editFormTextAfterTools = '';
423 public $editFormTextBottom = '';
424 public $editFormTextAfterContent = '';
425 public $previewTextAfterContent = '';
426 public $mPreloadContent = null;
427
428 /* $didSave should be set to true whenever an article was successfully altered. */
429 public $didSave = false;
430 public $undidRev = 0;
431
432 public $suppressIntro = false;
433
434 /** @var bool */
435 protected $edit;
436
437 /** @var bool|int */
438 protected $contentLength = false;
439
440 /**
441 * @var bool Set in ApiEditPage, based on ContentHandler::allowsDirectApiEditing
442 */
443 private $enableApiEditOverride = false;
444
445 /**
446 * @var IContextSource
447 */
448 protected $context;
449
450 /**
451 * @var bool Whether an old revision is edited
452 */
453 private $isOldRev = false;
454
455 /**
456 * @var string|null What the user submitted in the 'wpUnicodeCheck' field
457 */
458 private $unicodeCheck;
459
460 /**
461 * Factory function to create an edit conflict helper
462 *
463 * @var callable
464 */
465 private $editConflictHelperFactory;
466
467 /**
468 * @var TextConflictHelper|null
469 */
470 private $editConflictHelper;
471
472 /**
473 * @param Article $article
474 */
475 public function __construct( Article $article ) {
476 $this->mArticle = $article;
477 $this->page = $article->getPage(); // model object
478 $this->mTitle = $article->getTitle();
479
480 // Make sure the local context is in sync with other member variables.
481 // Particularly make sure everything is using the same WikiPage instance.
482 // This should probably be the case in Article as well, but it's
483 // particularly important for EditPage, to make use of the in-place caching
484 // facility in WikiPage::prepareContentForEdit.
485 $this->context = new DerivativeContext( $article->getContext() );
486 $this->context->setWikiPage( $this->page );
487 $this->context->setTitle( $this->mTitle );
488
489 $this->contentModel = $this->mTitle->getContentModel();
490
491 $handler = ContentHandler::getForModelID( $this->contentModel );
492 $this->contentFormat = $handler->getDefaultFormat();
493 $this->editConflictHelperFactory = [ $this, 'newTextConflictHelper' ];
494 }
495
496 /**
497 * @return Article
498 */
499 public function getArticle() {
500 return $this->mArticle;
501 }
502
503 /**
504 * @since 1.28
505 * @return IContextSource
506 */
507 public function getContext() {
508 return $this->context;
509 }
510
511 /**
512 * @since 1.19
513 * @return Title
514 */
515 public function getTitle() {
516 return $this->mTitle;
517 }
518
519 /**
520 * Set the context Title object
521 *
522 * @param Title|null $title Title object or null
523 */
524 public function setContextTitle( $title ) {
525 $this->mContextTitle = $title;
526 }
527
528 /**
529 * Get the context title object.
530 *
531 * If not set, $wgTitle will be returned, but this is deprecated. This will
532 * throw an exception.
533 *
534 * @return Title
535 */
536 public function getContextTitle() {
537 if ( is_null( $this->mContextTitle ) ) {
538 wfDeprecated( __METHOD__ . ' called with no title set', '1.32' );
539 global $wgTitle;
540 return $wgTitle;
541 } else {
542 return $this->mContextTitle;
543 }
544 }
545
546 /**
547 * Returns if the given content model is editable.
548 *
549 * @param string $modelId The ID of the content model to test. Use CONTENT_MODEL_XXX constants.
550 * @return bool
551 * @throws MWException If $modelId has no known handler
552 */
553 public function isSupportedContentModel( $modelId ) {
554 return $this->enableApiEditOverride === true ||
555 ContentHandler::getForModelID( $modelId )->supportsDirectEditing();
556 }
557
558 /**
559 * Allow editing of content that supports API direct editing, but not general
560 * direct editing. Set to false by default.
561 *
562 * @param bool $enableOverride
563 */
564 public function setApiEditOverride( $enableOverride ) {
565 $this->enableApiEditOverride = $enableOverride;
566 }
567
568 /**
569 * @deprecated since 1.29, call edit directly
570 */
571 public function submit() {
572 wfDeprecated( __METHOD__, '1.29' );
573 $this->edit();
574 }
575
576 /**
577 * This is the function that gets called for "action=edit". It
578 * sets up various member variables, then passes execution to
579 * another function, usually showEditForm()
580 *
581 * The edit form is self-submitting, so that when things like
582 * preview and edit conflicts occur, we get the same form back
583 * with the extra stuff added. Only when the final submission
584 * is made and all is well do we actually save and redirect to
585 * the newly-edited page.
586 */
587 public function edit() {
588 // Allow extensions to modify/prevent this form or submission
589 if ( !Hooks::run( 'AlternateEdit', [ $this ] ) ) {
590 return;
591 }
592
593 wfDebug( __METHOD__ . ": enter\n" );
594
595 $request = $this->context->getRequest();
596 // If they used redlink=1 and the page exists, redirect to the main article
597 if ( $request->getBool( 'redlink' ) && $this->mTitle->exists() ) {
598 $this->context->getOutput()->redirect( $this->mTitle->getFullURL() );
599 return;
600 }
601
602 $this->importFormData( $request );
603 $this->firsttime = false;
604
605 if ( wfReadOnly() && $this->save ) {
606 // Force preview
607 $this->save = false;
608 $this->preview = true;
609 }
610
611 if ( $this->save ) {
612 $this->formtype = 'save';
613 } elseif ( $this->preview ) {
614 $this->formtype = 'preview';
615 } elseif ( $this->diff ) {
616 $this->formtype = 'diff';
617 } else { # First time through
618 $this->firsttime = true;
619 if ( $this->previewOnOpen() ) {
620 $this->formtype = 'preview';
621 } else {
622 $this->formtype = 'initial';
623 }
624 }
625
626 $permErrors = $this->getEditPermissionErrors( $this->save ? 'secure' : 'full' );
627 if ( $permErrors ) {
628 wfDebug( __METHOD__ . ": User can't edit\n" );
629
630 if ( $this->context->getUser()->getBlock() ) {
631 // track block with a cookie if it doesn't exists already
632 $this->context->getUser()->trackBlockWithCookie();
633
634 // Auto-block user's IP if the account was "hard" blocked
635 if ( !wfReadOnly() ) {
636 DeferredUpdates::addCallableUpdate( function () {
637 $this->context->getUser()->spreadAnyEditBlock();
638 } );
639 }
640 }
641 $this->displayPermissionsError( $permErrors );
642
643 return;
644 }
645
646 $revision = $this->mArticle->getRevisionFetched();
647 // Disallow editing revisions with content models different from the current one
648 // Undo edits being an exception in order to allow reverting content model changes.
649 if ( $revision
650 && $revision->getContentModel() !== $this->contentModel
651 ) {
652 $prevRev = null;
653 if ( $this->undidRev ) {
654 $undidRevObj = Revision::newFromId( $this->undidRev );
655 $prevRev = $undidRevObj ? $undidRevObj->getPrevious() : null;
656 }
657 if ( !$this->undidRev
658 || !$prevRev
659 || $prevRev->getContentModel() !== $this->contentModel
660 ) {
661 $this->displayViewSourcePage(
662 $this->getContentObject(),
663 $this->context->msg(
664 'contentmodelediterror',
665 $revision->getContentModel(),
666 $this->contentModel
667 )->plain()
668 );
669 return;
670 }
671 }
672
673 $this->isConflict = false;
674
675 # Show applicable editing introductions
676 if ( $this->formtype == 'initial' || $this->firsttime ) {
677 $this->showIntro();
678 }
679
680 # Attempt submission here. This will check for edit conflicts,
681 # and redundantly check for locked database, blocked IPs, etc.
682 # that edit() already checked just in case someone tries to sneak
683 # in the back door with a hand-edited submission URL.
684
685 if ( $this->formtype == 'save' ) {
686 $resultDetails = null;
687 $status = $this->attemptSave( $resultDetails );
688 if ( !$this->handleStatus( $status, $resultDetails ) ) {
689 return;
690 }
691 }
692
693 # First time through: get contents, set time for conflict
694 # checking, etc.
695 if ( $this->formtype == 'initial' || $this->firsttime ) {
696 if ( $this->initialiseForm() === false ) {
697 $out = $this->context->getOutput();
698 if ( $out->getRedirect() === '' ) { // mcrundo hack redirects, don't override it
699 $this->noSuchSectionPage();
700 }
701 return;
702 }
703
704 if ( !$this->mTitle->getArticleID() ) {
705 Hooks::run( 'EditFormPreloadText', [ &$this->textbox1, &$this->mTitle ] );
706 } else {
707 Hooks::run( 'EditFormInitialText', [ $this ] );
708 }
709
710 }
711
712 $this->showEditForm();
713 }
714
715 /**
716 * @param string $rigor Same format as Title::getUserPermissionErrors()
717 * @return array
718 */
719 protected function getEditPermissionErrors( $rigor = 'secure' ) {
720 $user = $this->context->getUser();
721 $permErrors = $this->mTitle->getUserPermissionsErrors( 'edit', $user, $rigor );
722 # Can this title be created?
723 if ( !$this->mTitle->exists() ) {
724 $permErrors = array_merge(
725 $permErrors,
726 wfArrayDiff2(
727 $this->mTitle->getUserPermissionsErrors( 'create', $user, $rigor ),
728 $permErrors
729 )
730 );
731 }
732 # Ignore some permissions errors when a user is just previewing/viewing diffs
733 $remove = [];
734 foreach ( $permErrors as $error ) {
735 if ( ( $this->preview || $this->diff )
736 && (
737 $error[0] == 'blockedtext' ||
738 $error[0] == 'autoblockedtext' ||
739 $error[0] == 'systemblockedtext'
740 )
741 ) {
742 $remove[] = $error;
743 }
744 }
745 $permErrors = wfArrayDiff2( $permErrors, $remove );
746
747 return $permErrors;
748 }
749
750 /**
751 * Display a permissions error page, like OutputPage::showPermissionsErrorPage(),
752 * but with the following differences:
753 * - If redlink=1, the user will be redirected to the page
754 * - If there is content to display or the error occurs while either saving,
755 * previewing or showing the difference, it will be a
756 * "View source for ..." page displaying the source code after the error message.
757 *
758 * @since 1.19
759 * @param array $permErrors Array of permissions errors, as returned by
760 * Title::getUserPermissionsErrors().
761 * @throws PermissionsError
762 */
763 protected function displayPermissionsError( array $permErrors ) {
764 $out = $this->context->getOutput();
765 if ( $this->context->getRequest()->getBool( 'redlink' ) ) {
766 // The edit page was reached via a red link.
767 // Redirect to the article page and let them click the edit tab if
768 // they really want a permission error.
769 $out->redirect( $this->mTitle->getFullURL() );
770 return;
771 }
772
773 $content = $this->getContentObject();
774
775 # Use the normal message if there's nothing to display
776 if ( $this->firsttime && ( !$content || $content->isEmpty() ) ) {
777 $action = $this->mTitle->exists() ? 'edit' :
778 ( $this->mTitle->isTalkPage() ? 'createtalk' : 'createpage' );
779 throw new PermissionsError( $action, $permErrors );
780 }
781
782 $this->displayViewSourcePage(
783 $content,
784 $out->formatPermissionsErrorMessage( $permErrors, 'edit' )
785 );
786 }
787
788 /**
789 * Display a read-only View Source page
790 * @param Content $content
791 * @param string $errorMessage additional wikitext error message to display
792 */
793 protected function displayViewSourcePage( Content $content, $errorMessage = '' ) {
794 $out = $this->context->getOutput();
795 Hooks::run( 'EditPage::showReadOnlyForm:initial', [ $this, &$out ] );
796
797 $out->setRobotPolicy( 'noindex,nofollow' );
798 $out->setPageTitle( $this->context->msg(
799 'viewsource-title',
800 $this->getContextTitle()->getPrefixedText()
801 ) );
802 $out->addBacklinkSubtitle( $this->getContextTitle() );
803 $out->addHTML( $this->editFormPageTop );
804 $out->addHTML( $this->editFormTextTop );
805
806 if ( $errorMessage !== '' ) {
807 $out->addWikiTextAsInterface( $errorMessage );
808 $out->addHTML( "<hr />\n" );
809 }
810
811 # If the user made changes, preserve them when showing the markup
812 # (This happens when a user is blocked during edit, for instance)
813 if ( !$this->firsttime ) {
814 $text = $this->textbox1;
815 $out->addWikiMsg( 'viewyourtext' );
816 } else {
817 try {
818 $text = $this->toEditText( $content );
819 } catch ( MWException $e ) {
820 # Serialize using the default format if the content model is not supported
821 # (e.g. for an old revision with a different model)
822 $text = $content->serialize();
823 }
824 $out->addWikiMsg( 'viewsourcetext' );
825 }
826
827 $out->addHTML( $this->editFormTextBeforeContent );
828 $this->showTextbox( $text, 'wpTextbox1', [ 'readonly' ] );
829 $out->addHTML( $this->editFormTextAfterContent );
830
831 $out->addHTML( $this->makeTemplatesOnThisPageList( $this->getTemplates() ) );
832
833 $out->addModules( 'mediawiki.action.edit.collapsibleFooter' );
834
835 $out->addHTML( $this->editFormTextBottom );
836 if ( $this->mTitle->exists() ) {
837 $out->returnToMain( null, $this->mTitle );
838 }
839 }
840
841 /**
842 * Should we show a preview when the edit form is first shown?
843 *
844 * @return bool
845 */
846 protected function previewOnOpen() {
847 $config = $this->context->getConfig();
848 $previewOnOpenNamespaces = $config->get( 'PreviewOnOpenNamespaces' );
849 $request = $this->context->getRequest();
850 if ( $config->get( 'RawHtml' ) ) {
851 // If raw HTML is enabled, disable preview on open
852 // since it has to be posted with a token for
853 // security reasons
854 return false;
855 }
856 if ( $request->getVal( 'preview' ) == 'yes' ) {
857 // Explicit override from request
858 return true;
859 } elseif ( $request->getVal( 'preview' ) == 'no' ) {
860 // Explicit override from request
861 return false;
862 } elseif ( $this->section == 'new' ) {
863 // Nothing *to* preview for new sections
864 return false;
865 } elseif ( ( $request->getCheck( 'preload' ) || $this->mTitle->exists() )
866 && $this->context->getUser()->getOption( 'previewonfirst' )
867 ) {
868 // Standard preference behavior
869 return true;
870 } elseif ( !$this->mTitle->exists()
871 && isset( $previewOnOpenNamespaces[$this->mTitle->getNamespace()] )
872 && $previewOnOpenNamespaces[$this->mTitle->getNamespace()]
873 ) {
874 // Categories are special
875 return true;
876 } else {
877 return false;
878 }
879 }
880
881 /**
882 * Checks whether the user entered a skin name in uppercase,
883 * e.g. "User:Example/Monobook.css" instead of "monobook.css"
884 *
885 * @return bool
886 */
887 protected function isWrongCaseUserConfigPage() {
888 if ( $this->mTitle->isUserConfigPage() ) {
889 $name = $this->mTitle->getSkinFromConfigSubpage();
890 $skins = array_merge(
891 array_keys( Skin::getSkinNames() ),
892 [ 'common' ]
893 );
894 return !in_array( $name, $skins )
895 && in_array( strtolower( $name ), $skins );
896 } else {
897 return false;
898 }
899 }
900
901 /**
902 * Returns whether section editing is supported for the current page.
903 * Subclasses may override this to replace the default behavior, which is
904 * to check ContentHandler::supportsSections.
905 *
906 * @return bool True if this edit page supports sections, false otherwise.
907 */
908 protected function isSectionEditSupported() {
909 $contentHandler = ContentHandler::getForTitle( $this->mTitle );
910 return $contentHandler->supportsSections();
911 }
912
913 /**
914 * This function collects the form data and uses it to populate various member variables.
915 * @param WebRequest &$request
916 * @throws ErrorPageError
917 */
918 public function importFormData( &$request ) {
919 # Section edit can come from either the form or a link
920 $this->section = $request->getVal( 'wpSection', $request->getVal( 'section' ) );
921
922 if ( $this->section !== null && $this->section !== '' && !$this->isSectionEditSupported() ) {
923 throw new ErrorPageError( 'sectioneditnotsupported-title', 'sectioneditnotsupported-text' );
924 }
925
926 $this->isNew = !$this->mTitle->exists() || $this->section == 'new';
927
928 if ( $request->wasPosted() ) {
929 # These fields need to be checked for encoding.
930 # Also remove trailing whitespace, but don't remove _initial_
931 # whitespace from the text boxes. This may be significant formatting.
932 $this->textbox1 = rtrim( $request->getText( 'wpTextbox1' ) );
933 if ( !$request->getCheck( 'wpTextbox2' ) ) {
934 // Skip this if wpTextbox2 has input, it indicates that we came
935 // from a conflict page with raw page text, not a custom form
936 // modified by subclasses
937 $textbox1 = $this->importContentFormData( $request );
938 if ( $textbox1 !== null ) {
939 $this->textbox1 = $textbox1;
940 }
941 }
942
943 $this->unicodeCheck = $request->getText( 'wpUnicodeCheck' );
944
945 $this->summary = $request->getText( 'wpSummary' );
946
947 # If the summary consists of a heading, e.g. '==Foobar==', extract the title from the
948 # header syntax, e.g. 'Foobar'. This is mainly an issue when we are using wpSummary for
949 # section titles.
950 $this->summary = preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->summary );
951
952 # Treat sectiontitle the same way as summary.
953 # Note that wpSectionTitle is not yet a part of the actual edit form, as wpSummary is
954 # currently doing double duty as both edit summary and section title. Right now this
955 # is just to allow API edits to work around this limitation, but this should be
956 # incorporated into the actual edit form when EditPage is rewritten (T20654, T28312).
957 $this->sectiontitle = $request->getText( 'wpSectionTitle' );
958 $this->sectiontitle = preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->sectiontitle );
959
960 $this->edittime = $request->getVal( 'wpEdittime' );
961 $this->editRevId = $request->getIntOrNull( 'editRevId' );
962 $this->starttime = $request->getVal( 'wpStarttime' );
963
964 $undidRev = $request->getInt( 'wpUndidRevision' );
965 if ( $undidRev ) {
966 $this->undidRev = $undidRev;
967 }
968
969 $this->scrolltop = $request->getIntOrNull( 'wpScrolltop' );
970
971 if ( $this->textbox1 === '' && !$request->getCheck( 'wpTextbox1' ) ) {
972 // wpTextbox1 field is missing, possibly due to being "too big"
973 // according to some filter rules such as Suhosin's setting for
974 // suhosin.request.max_value_length (d'oh)
975 $this->incompleteForm = true;
976 } else {
977 // If we receive the last parameter of the request, we can fairly
978 // claim the POST request has not been truncated.
979 $this->incompleteForm = !$request->getVal( 'wpUltimateParam' );
980 }
981 if ( $this->incompleteForm ) {
982 # If the form is incomplete, force to preview.
983 wfDebug( __METHOD__ . ": Form data appears to be incomplete\n" );
984 wfDebug( "POST DATA: " . var_export( $request->getPostValues(), true ) . "\n" );
985 $this->preview = true;
986 } else {
987 $this->preview = $request->getCheck( 'wpPreview' );
988 $this->diff = $request->getCheck( 'wpDiff' );
989
990 // Remember whether a save was requested, so we can indicate
991 // if we forced preview due to session failure.
992 $this->mTriedSave = !$this->preview;
993
994 if ( $this->tokenOk( $request ) ) {
995 # Some browsers will not report any submit button
996 # if the user hits enter in the comment box.
997 # The unmarked state will be assumed to be a save,
998 # if the form seems otherwise complete.
999 wfDebug( __METHOD__ . ": Passed token check.\n" );
1000 } elseif ( $this->diff ) {
1001 # Failed token check, but only requested "Show Changes".
1002 wfDebug( __METHOD__ . ": Failed token check; Show Changes requested.\n" );
1003 } else {
1004 # Page might be a hack attempt posted from
1005 # an external site. Preview instead of saving.
1006 wfDebug( __METHOD__ . ": Failed token check; forcing preview\n" );
1007 $this->preview = true;
1008 }
1009 }
1010 $this->save = !$this->preview && !$this->diff;
1011 if ( !preg_match( '/^\d{14}$/', $this->edittime ) ) {
1012 $this->edittime = null;
1013 }
1014
1015 if ( !preg_match( '/^\d{14}$/', $this->starttime ) ) {
1016 $this->starttime = null;
1017 }
1018
1019 $this->recreate = $request->getCheck( 'wpRecreate' );
1020
1021 $this->minoredit = $request->getCheck( 'wpMinoredit' );
1022 $this->watchthis = $request->getCheck( 'wpWatchthis' );
1023
1024 $user = $this->context->getUser();
1025 # Don't force edit summaries when a user is editing their own user or talk page
1026 if ( ( $this->mTitle->mNamespace == NS_USER || $this->mTitle->mNamespace == NS_USER_TALK )
1027 && $this->mTitle->getText() == $user->getName()
1028 ) {
1029 $this->allowBlankSummary = true;
1030 } else {
1031 $this->allowBlankSummary = $request->getBool( 'wpIgnoreBlankSummary' )
1032 || !$user->getOption( 'forceeditsummary' );
1033 }
1034
1035 $this->autoSumm = $request->getText( 'wpAutoSummary' );
1036
1037 $this->allowBlankArticle = $request->getBool( 'wpIgnoreBlankArticle' );
1038 $this->allowSelfRedirect = $request->getBool( 'wpIgnoreSelfRedirect' );
1039
1040 $changeTags = $request->getVal( 'wpChangeTags' );
1041 if ( is_null( $changeTags ) || $changeTags === '' ) {
1042 $this->changeTags = [];
1043 } else {
1044 $this->changeTags = array_filter( array_map( 'trim', explode( ',',
1045 $changeTags ) ) );
1046 }
1047 } else {
1048 # Not a posted form? Start with nothing.
1049 wfDebug( __METHOD__ . ": Not a posted form.\n" );
1050 $this->textbox1 = '';
1051 $this->summary = '';
1052 $this->sectiontitle = '';
1053 $this->edittime = '';
1054 $this->editRevId = null;
1055 $this->starttime = wfTimestampNow();
1056 $this->edit = false;
1057 $this->preview = false;
1058 $this->save = false;
1059 $this->diff = false;
1060 $this->minoredit = false;
1061 // Watch may be overridden by request parameters
1062 $this->watchthis = $request->getBool( 'watchthis', false );
1063 $this->recreate = false;
1064
1065 // When creating a new section, we can preload a section title by passing it as the
1066 // preloadtitle parameter in the URL (T15100)
1067 if ( $this->section == 'new' && $request->getVal( 'preloadtitle' ) ) {
1068 $this->sectiontitle = $request->getVal( 'preloadtitle' );
1069 // Once wpSummary isn't being use for setting section titles, we should delete this.
1070 $this->summary = $request->getVal( 'preloadtitle' );
1071 } elseif ( $this->section != 'new' && $request->getVal( 'summary' ) !== '' ) {
1072 $this->summary = $request->getText( 'summary' );
1073 if ( $this->summary !== '' ) {
1074 $this->hasPresetSummary = true;
1075 }
1076 }
1077
1078 if ( $request->getVal( 'minor' ) ) {
1079 $this->minoredit = true;
1080 }
1081 }
1082
1083 $this->oldid = $request->getInt( 'oldid' );
1084 $this->parentRevId = $request->getInt( 'parentRevId' );
1085
1086 $this->bot = $request->getBool( 'bot', true );
1087 $this->nosummary = $request->getBool( 'nosummary' );
1088
1089 // May be overridden by revision.
1090 $this->contentModel = $request->getText( 'model', $this->contentModel );
1091 // May be overridden by revision.
1092 $this->contentFormat = $request->getText( 'format', $this->contentFormat );
1093
1094 try {
1095 $handler = ContentHandler::getForModelID( $this->contentModel );
1096 } catch ( MWUnknownContentModelException $e ) {
1097 throw new ErrorPageError(
1098 'editpage-invalidcontentmodel-title',
1099 'editpage-invalidcontentmodel-text',
1100 [ wfEscapeWikiText( $this->contentModel ) ]
1101 );
1102 }
1103
1104 if ( !$handler->isSupportedFormat( $this->contentFormat ) ) {
1105 throw new ErrorPageError(
1106 'editpage-notsupportedcontentformat-title',
1107 'editpage-notsupportedcontentformat-text',
1108 [
1109 wfEscapeWikiText( $this->contentFormat ),
1110 wfEscapeWikiText( ContentHandler::getLocalizedName( $this->contentModel ) )
1111 ]
1112 );
1113 }
1114
1115 /**
1116 * @todo Check if the desired model is allowed in this namespace, and if
1117 * a transition from the page's current model to the new model is
1118 * allowed.
1119 */
1120
1121 $this->editintro = $request->getText( 'editintro',
1122 // Custom edit intro for new sections
1123 $this->section === 'new' ? 'MediaWiki:addsection-editintro' : '' );
1124
1125 // Allow extensions to modify form data
1126 Hooks::run( 'EditPage::importFormData', [ $this, $request ] );
1127 }
1128
1129 /**
1130 * Subpage overridable method for extracting the page content data from the
1131 * posted form to be placed in $this->textbox1, if using customized input
1132 * this method should be overridden and return the page text that will be used
1133 * for saving, preview parsing and so on...
1134 *
1135 * @param WebRequest &$request
1136 * @return string|null
1137 */
1138 protected function importContentFormData( &$request ) {
1139 return; // Don't do anything, EditPage already extracted wpTextbox1
1140 }
1141
1142 /**
1143 * Initialise form fields in the object
1144 * Called on the first invocation, e.g. when a user clicks an edit link
1145 * @return bool If the requested section is valid
1146 */
1147 public function initialiseForm() {
1148 $this->edittime = $this->page->getTimestamp();
1149 $this->editRevId = $this->page->getLatest();
1150
1151 $content = $this->getContentObject( false ); # TODO: track content object?!
1152 if ( $content === false ) {
1153 return false;
1154 }
1155 $this->textbox1 = $this->toEditText( $content );
1156
1157 $user = $this->context->getUser();
1158 // activate checkboxes if user wants them to be always active
1159 # Sort out the "watch" checkbox
1160 if ( $user->getOption( 'watchdefault' ) ) {
1161 # Watch all edits
1162 $this->watchthis = true;
1163 } elseif ( $user->getOption( 'watchcreations' ) && !$this->mTitle->exists() ) {
1164 # Watch creations
1165 $this->watchthis = true;
1166 } elseif ( $user->isWatched( $this->mTitle ) ) {
1167 # Already watched
1168 $this->watchthis = true;
1169 }
1170 if ( $user->getOption( 'minordefault' ) && !$this->isNew ) {
1171 $this->minoredit = true;
1172 }
1173 if ( $this->textbox1 === false ) {
1174 return false;
1175 }
1176 return true;
1177 }
1178
1179 /**
1180 * @param Content|null $def_content The default value to return
1181 *
1182 * @return Content|null Content on success, $def_content for invalid sections
1183 *
1184 * @since 1.21
1185 */
1186 protected function getContentObject( $def_content = null ) {
1187 $content = false;
1188
1189 $user = $this->context->getUser();
1190 $request = $this->context->getRequest();
1191 // For message page not locally set, use the i18n message.
1192 // For other non-existent articles, use preload text if any.
1193 if ( !$this->mTitle->exists() || $this->section == 'new' ) {
1194 if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI && $this->section != 'new' ) {
1195 # If this is a system message, get the default text.
1196 $msg = $this->mTitle->getDefaultMessageText();
1197
1198 $content = $this->toEditContent( $msg );
1199 }
1200 if ( $content === false ) {
1201 # If requested, preload some text.
1202 $preload = $request->getVal( 'preload',
1203 // Custom preload text for new sections
1204 $this->section === 'new' ? 'MediaWiki:addsection-preload' : '' );
1205 $params = $request->getArray( 'preloadparams', [] );
1206
1207 $content = $this->getPreloadedContent( $preload, $params );
1208 }
1209 // For existing pages, get text based on "undo" or section parameters.
1210 } elseif ( $this->section != '' ) {
1211 // Get section edit text (returns $def_text for invalid sections)
1212 $orig = $this->getOriginalContent( $user );
1213 $content = $orig ? $orig->getSection( $this->section ) : null;
1214
1215 if ( !$content ) {
1216 $content = $def_content;
1217 }
1218 } else {
1219 $undoafter = $request->getInt( 'undoafter' );
1220 $undo = $request->getInt( 'undo' );
1221
1222 if ( $undo > 0 && $undoafter > 0 ) {
1223 $undorev = Revision::newFromId( $undo );
1224 $oldrev = Revision::newFromId( $undoafter );
1225 $undoMsg = null;
1226
1227 # Sanity check, make sure it's the right page,
1228 # the revisions exist and they were not deleted.
1229 # Otherwise, $content will be left as-is.
1230 if ( !is_null( $undorev ) && !is_null( $oldrev ) &&
1231 !$undorev->isDeleted( Revision::DELETED_TEXT ) &&
1232 !$oldrev->isDeleted( Revision::DELETED_TEXT )
1233 ) {
1234 if ( WikiPage::hasDifferencesOutsideMainSlot( $undorev, $oldrev )
1235 || !$this->isSupportedContentModel( $oldrev->getContentModel() )
1236 ) {
1237 // Hack for undo while EditPage can't handle multi-slot editing
1238 $this->context->getOutput()->redirect( $this->mTitle->getFullURL( [
1239 'action' => 'mcrundo',
1240 'undo' => $undo,
1241 'undoafter' => $undoafter,
1242 ] ) );
1243 return false;
1244 } else {
1245 $content = $this->page->getUndoContent( $undorev, $oldrev );
1246
1247 if ( $content === false ) {
1248 # Warn the user that something went wrong
1249 $undoMsg = 'failure';
1250 }
1251 }
1252
1253 if ( $undoMsg === null ) {
1254 $oldContent = $this->page->getContent( Revision::RAW );
1255 $popts = ParserOptions::newFromUserAndLang(
1256 $user, MediaWikiServices::getInstance()->getContentLanguage() );
1257 $newContent = $content->preSaveTransform( $this->mTitle, $user, $popts );
1258 if ( $newContent->getModel() !== $oldContent->getModel() ) {
1259 // The undo may change content
1260 // model if its reverting the top
1261 // edit. This can result in
1262 // mismatched content model/format.
1263 $this->contentModel = $newContent->getModel();
1264 $this->contentFormat = $oldrev->getContentFormat();
1265 }
1266
1267 if ( $newContent->equals( $oldContent ) ) {
1268 # Tell the user that the undo results in no change,
1269 # i.e. the revisions were already undone.
1270 $undoMsg = 'nochange';
1271 $content = false;
1272 } else {
1273 # Inform the user of our success and set an automatic edit summary
1274 $undoMsg = 'success';
1275
1276 # If we just undid one rev, use an autosummary
1277 $firstrev = $oldrev->getNext();
1278 if ( $firstrev && $firstrev->getId() == $undo ) {
1279 $userText = $undorev->getUserText();
1280 if ( $userText === '' ) {
1281 $undoSummary = $this->context->msg(
1282 'undo-summary-username-hidden',
1283 $undo
1284 )->inContentLanguage()->text();
1285 } else {
1286 $undoSummary = $this->context->msg(
1287 'undo-summary',
1288 $undo,
1289 $userText
1290 )->inContentLanguage()->text();
1291 }
1292 if ( $this->summary === '' ) {
1293 $this->summary = $undoSummary;
1294 } else {
1295 $this->summary = $undoSummary . $this->context->msg( 'colon-separator' )
1296 ->inContentLanguage()->text() . $this->summary;
1297 }
1298 $this->undidRev = $undo;
1299 }
1300 $this->formtype = 'diff';
1301 }
1302 }
1303 } else {
1304 // Failed basic sanity checks.
1305 // Older revisions may have been removed since the link
1306 // was created, or we may simply have got bogus input.
1307 $undoMsg = 'norev';
1308 }
1309
1310 $out = $this->context->getOutput();
1311 // Messages: undo-success, undo-failure, undo-main-slot-only, undo-norev,
1312 // undo-nochange.
1313 $class = ( $undoMsg == 'success' ? '' : 'error ' ) . "mw-undo-{$undoMsg}";
1314 $this->editFormPageTop .= Html::rawElement(
1315 'div', [ 'class' => $class ],
1316 $out->parseAsInterface(
1317 $this->context->msg( 'undo-' . $undoMsg )->plain()
1318 )
1319 );
1320 }
1321
1322 if ( $content === false ) {
1323 // Hack for restoring old revisions while EditPage
1324 // can't handle multi-slot editing.
1325
1326 $curRevision = $this->page->getRevision();
1327 $oldRevision = $this->mArticle->getRevisionFetched();
1328
1329 if ( $curRevision
1330 && $oldRevision
1331 && $curRevision->getId() !== $oldRevision->getId()
1332 && ( WikiPage::hasDifferencesOutsideMainSlot( $oldRevision, $curRevision )
1333 || !$this->isSupportedContentModel( $oldRevision->getContentModel() ) )
1334 ) {
1335 $this->context->getOutput()->redirect(
1336 $this->mTitle->getFullURL(
1337 [
1338 'action' => 'mcrrestore',
1339 'restore' => $oldRevision->getId(),
1340 ]
1341 )
1342 );
1343
1344 return false;
1345 }
1346 }
1347
1348 if ( $content === false ) {
1349 $content = $this->getOriginalContent( $user );
1350 }
1351 }
1352
1353 return $content;
1354 }
1355
1356 /**
1357 * Get the content of the wanted revision, without section extraction.
1358 *
1359 * The result of this function can be used to compare user's input with
1360 * section replaced in its context (using WikiPage::replaceSectionAtRev())
1361 * to the original text of the edit.
1362 *
1363 * This differs from Article::getContent() that when a missing revision is
1364 * encountered the result will be null and not the
1365 * 'missing-revision' message.
1366 *
1367 * @since 1.19
1368 * @param User $user The user to get the revision for
1369 * @return Content|null
1370 */
1371 private function getOriginalContent( User $user ) {
1372 if ( $this->section == 'new' ) {
1373 return $this->getCurrentContent();
1374 }
1375 $revision = $this->mArticle->getRevisionFetched();
1376 if ( $revision === null ) {
1377 $handler = ContentHandler::getForModelID( $this->contentModel );
1378 return $handler->makeEmptyContent();
1379 }
1380 $content = $revision->getContent( Revision::FOR_THIS_USER, $user );
1381 return $content;
1382 }
1383
1384 /**
1385 * Get the edit's parent revision ID
1386 *
1387 * The "parent" revision is the ancestor that should be recorded in this
1388 * page's revision history. It is either the revision ID of the in-memory
1389 * article content, or in the case of a 3-way merge in order to rebase
1390 * across a recoverable edit conflict, the ID of the newer revision to
1391 * which we have rebased this page.
1392 *
1393 * @since 1.27
1394 * @return int Revision ID
1395 */
1396 public function getParentRevId() {
1397 if ( $this->parentRevId ) {
1398 return $this->parentRevId;
1399 } else {
1400 return $this->mArticle->getRevIdFetched();
1401 }
1402 }
1403
1404 /**
1405 * Get the current content of the page. This is basically similar to
1406 * WikiPage::getContent( Revision::RAW ) except that when the page doesn't exist an empty
1407 * content object is returned instead of null.
1408 *
1409 * @since 1.21
1410 * @return Content
1411 */
1412 protected function getCurrentContent() {
1413 $rev = $this->page->getRevision();
1414 $content = $rev ? $rev->getContent( Revision::RAW ) : null;
1415
1416 if ( $content === false || $content === null ) {
1417 $handler = ContentHandler::getForModelID( $this->contentModel );
1418 return $handler->makeEmptyContent();
1419 } elseif ( !$this->undidRev ) {
1420 // Content models should always be the same since we error
1421 // out if they are different before this point (in ->edit()).
1422 // The exception being, during an undo, the current revision might
1423 // differ from the prior revision.
1424 $logger = LoggerFactory::getInstance( 'editpage' );
1425 if ( $this->contentModel !== $rev->getContentModel() ) {
1426 $logger->warning( "Overriding content model from current edit {prev} to {new}", [
1427 'prev' => $this->contentModel,
1428 'new' => $rev->getContentModel(),
1429 'title' => $this->getTitle()->getPrefixedDBkey(),
1430 'method' => __METHOD__
1431 ] );
1432 $this->contentModel = $rev->getContentModel();
1433 }
1434
1435 // Given that the content models should match, the current selected
1436 // format should be supported.
1437 if ( !$content->isSupportedFormat( $this->contentFormat ) ) {
1438 $logger->warning( "Current revision content format unsupported. Overriding {prev} to {new}", [
1439
1440 'prev' => $this->contentFormat,
1441 'new' => $rev->getContentFormat(),
1442 'title' => $this->getTitle()->getPrefixedDBkey(),
1443 'method' => __METHOD__
1444 ] );
1445 $this->contentFormat = $rev->getContentFormat();
1446 }
1447 }
1448 return $content;
1449 }
1450
1451 /**
1452 * Use this method before edit() to preload some content into the edit box
1453 *
1454 * @param Content $content
1455 *
1456 * @since 1.21
1457 */
1458 public function setPreloadedContent( Content $content ) {
1459 $this->mPreloadContent = $content;
1460 }
1461
1462 /**
1463 * Get the contents to be preloaded into the box, either set by
1464 * an earlier setPreloadText() or by loading the given page.
1465 *
1466 * @param string $preload Representing the title to preload from.
1467 * @param array $params Parameters to use (interface-message style) in the preloaded text
1468 *
1469 * @return Content
1470 *
1471 * @since 1.21
1472 */
1473 protected function getPreloadedContent( $preload, $params = [] ) {
1474 if ( !empty( $this->mPreloadContent ) ) {
1475 return $this->mPreloadContent;
1476 }
1477
1478 $handler = ContentHandler::getForModelID( $this->contentModel );
1479
1480 if ( $preload === '' ) {
1481 return $handler->makeEmptyContent();
1482 }
1483
1484 $user = $this->context->getUser();
1485 $title = Title::newFromText( $preload );
1486 # Check for existence to avoid getting MediaWiki:Noarticletext
1487 if ( $title === null || !$title->exists() || !$title->userCan( 'read', $user ) ) {
1488 // TODO: somehow show a warning to the user!
1489 return $handler->makeEmptyContent();
1490 }
1491
1492 $page = WikiPage::factory( $title );
1493 if ( $page->isRedirect() ) {
1494 $title = $page->getRedirectTarget();
1495 # Same as before
1496 if ( $title === null || !$title->exists() || !$title->userCan( 'read', $user ) ) {
1497 // TODO: somehow show a warning to the user!
1498 return $handler->makeEmptyContent();
1499 }
1500 $page = WikiPage::factory( $title );
1501 }
1502
1503 $parserOptions = ParserOptions::newFromUser( $user );
1504 $content = $page->getContent( Revision::RAW );
1505
1506 if ( !$content ) {
1507 // TODO: somehow show a warning to the user!
1508 return $handler->makeEmptyContent();
1509 }
1510
1511 if ( $content->getModel() !== $handler->getModelID() ) {
1512 $converted = $content->convert( $handler->getModelID() );
1513
1514 if ( !$converted ) {
1515 // TODO: somehow show a warning to the user!
1516 wfDebug( "Attempt to preload incompatible content: " .
1517 "can't convert " . $content->getModel() .
1518 " to " . $handler->getModelID() );
1519
1520 return $handler->makeEmptyContent();
1521 }
1522
1523 $content = $converted;
1524 }
1525
1526 return $content->preloadTransform( $title, $parserOptions, $params );
1527 }
1528
1529 /**
1530 * Make sure the form isn't faking a user's credentials.
1531 *
1532 * @param WebRequest &$request
1533 * @return bool
1534 * @private
1535 */
1536 public function tokenOk( &$request ) {
1537 $token = $request->getVal( 'wpEditToken' );
1538 $user = $this->context->getUser();
1539 $this->mTokenOk = $user->matchEditToken( $token );
1540 $this->mTokenOkExceptSuffix = $user->matchEditTokenNoSuffix( $token );
1541 return $this->mTokenOk;
1542 }
1543
1544 /**
1545 * Sets post-edit cookie indicating the user just saved a particular revision.
1546 *
1547 * This uses a temporary cookie for each revision ID so separate saves will never
1548 * interfere with each other.
1549 *
1550 * Article::view deletes the cookie on server-side after the redirect and
1551 * converts the value to the global JavaScript variable wgPostEdit.
1552 *
1553 * If the variable were set on the server, it would be cached, which is unwanted
1554 * since the post-edit state should only apply to the load right after the save.
1555 *
1556 * @param int $statusValue The status value (to check for new article status)
1557 */
1558 protected function setPostEditCookie( $statusValue ) {
1559 $revisionId = $this->page->getLatest();
1560 $postEditKey = self::POST_EDIT_COOKIE_KEY_PREFIX . $revisionId;
1561
1562 $val = 'saved';
1563 if ( $statusValue == self::AS_SUCCESS_NEW_ARTICLE ) {
1564 $val = 'created';
1565 } elseif ( $this->oldid ) {
1566 $val = 'restored';
1567 }
1568
1569 $response = $this->context->getRequest()->response();
1570 $response->setCookie( $postEditKey, $val, time() + self::POST_EDIT_COOKIE_DURATION );
1571 }
1572
1573 /**
1574 * Attempt submission
1575 * @param array|bool &$resultDetails See docs for $result in internalAttemptSave
1576 * @throws UserBlockedError|ReadOnlyError|ThrottledError|PermissionsError
1577 * @return Status The resulting status object.
1578 */
1579 public function attemptSave( &$resultDetails = false ) {
1580 // TODO: MCR: treat $this->minoredit like $this->bot and check isAllowed( 'minoredit' )!
1581 // Also, add $this->autopatrol like $this->bot and check isAllowed( 'autopatrol' )!
1582 // This is needed since PageUpdater no longer checks these rights!
1583
1584 // Allow bots to exempt some edits from bot flagging
1585 $bot = $this->context->getUser()->isAllowed( 'bot' ) && $this->bot;
1586 $status = $this->internalAttemptSave( $resultDetails, $bot );
1587
1588 Hooks::run( 'EditPage::attemptSave:after', [ $this, $status, $resultDetails ] );
1589
1590 return $status;
1591 }
1592
1593 /**
1594 * Log when a page was successfully saved after the edit conflict view
1595 */
1596 private function incrementResolvedConflicts() {
1597 if ( $this->context->getRequest()->getText( 'mode' ) !== 'conflict' ) {
1598 return;
1599 }
1600
1601 $this->getEditConflictHelper()->incrementResolvedStats();
1602 }
1603
1604 /**
1605 * Handle status, such as after attempt save
1606 *
1607 * @param Status $status
1608 * @param array|bool $resultDetails
1609 *
1610 * @throws ErrorPageError
1611 * @return bool False, if output is done, true if rest of the form should be displayed
1612 */
1613 private function handleStatus( Status $status, $resultDetails ) {
1614 /**
1615 * @todo FIXME: once the interface for internalAttemptSave() is made
1616 * nicer, this should use the message in $status
1617 */
1618 if ( $status->value == self::AS_SUCCESS_UPDATE
1619 || $status->value == self::AS_SUCCESS_NEW_ARTICLE
1620 ) {
1621 $this->incrementResolvedConflicts();
1622
1623 $this->didSave = true;
1624 if ( !$resultDetails['nullEdit'] ) {
1625 $this->setPostEditCookie( $status->value );
1626 }
1627 }
1628
1629 $out = $this->context->getOutput();
1630
1631 // "wpExtraQueryRedirect" is a hidden input to modify
1632 // after save URL and is not used by actual edit form
1633 $request = $this->context->getRequest();
1634 $extraQueryRedirect = $request->getVal( 'wpExtraQueryRedirect' );
1635
1636 switch ( $status->value ) {
1637 case self::AS_HOOK_ERROR_EXPECTED:
1638 case self::AS_CONTENT_TOO_BIG:
1639 case self::AS_ARTICLE_WAS_DELETED:
1640 case self::AS_CONFLICT_DETECTED:
1641 case self::AS_SUMMARY_NEEDED:
1642 case self::AS_TEXTBOX_EMPTY:
1643 case self::AS_MAX_ARTICLE_SIZE_EXCEEDED:
1644 case self::AS_END:
1645 case self::AS_BLANK_ARTICLE:
1646 case self::AS_SELF_REDIRECT:
1647 return true;
1648
1649 case self::AS_HOOK_ERROR:
1650 return false;
1651
1652 case self::AS_CANNOT_USE_CUSTOM_MODEL:
1653 case self::AS_PARSE_ERROR:
1654 case self::AS_UNICODE_NOT_SUPPORTED:
1655 $out->wrapWikiTextAsInterface( 'error', $status->getWikiText() );
1656 return true;
1657
1658 case self::AS_SUCCESS_NEW_ARTICLE:
1659 $query = $resultDetails['redirect'] ? 'redirect=no' : '';
1660 if ( $extraQueryRedirect ) {
1661 if ( $query !== '' ) {
1662 $query .= '&';
1663 }
1664 $query .= $extraQueryRedirect;
1665 }
1666 $anchor = $resultDetails['sectionanchor'] ?? '';
1667 $out->redirect( $this->mTitle->getFullURL( $query ) . $anchor );
1668 return false;
1669
1670 case self::AS_SUCCESS_UPDATE:
1671 $extraQuery = '';
1672 $sectionanchor = $resultDetails['sectionanchor'];
1673
1674 // Give extensions a chance to modify URL query on update
1675 Hooks::run(
1676 'ArticleUpdateBeforeRedirect',
1677 [ $this->mArticle, &$sectionanchor, &$extraQuery ]
1678 );
1679
1680 if ( $resultDetails['redirect'] ) {
1681 if ( $extraQuery !== '' ) {
1682 $extraQuery = '&' . $extraQuery;
1683 }
1684 $extraQuery = 'redirect=no' . $extraQuery;
1685 }
1686 if ( $extraQueryRedirect ) {
1687 if ( $extraQuery !== '' ) {
1688 $extraQuery .= '&';
1689 }
1690 $extraQuery .= $extraQueryRedirect;
1691 }
1692
1693 $out->redirect( $this->mTitle->getFullURL( $extraQuery ) . $sectionanchor );
1694 return false;
1695
1696 case self::AS_SPAM_ERROR:
1697 $this->spamPageWithContent( $resultDetails['spam'] );
1698 return false;
1699
1700 case self::AS_BLOCKED_PAGE_FOR_USER:
1701 throw new UserBlockedError( $this->context->getUser()->getBlock() );
1702
1703 case self::AS_IMAGE_REDIRECT_ANON:
1704 case self::AS_IMAGE_REDIRECT_LOGGED:
1705 throw new PermissionsError( 'upload' );
1706
1707 case self::AS_READ_ONLY_PAGE_ANON:
1708 case self::AS_READ_ONLY_PAGE_LOGGED:
1709 throw new PermissionsError( 'edit' );
1710
1711 case self::AS_READ_ONLY_PAGE:
1712 throw new ReadOnlyError;
1713
1714 case self::AS_RATE_LIMITED:
1715 throw new ThrottledError();
1716
1717 case self::AS_NO_CREATE_PERMISSION:
1718 $permission = $this->mTitle->isTalkPage() ? 'createtalk' : 'createpage';
1719 throw new PermissionsError( $permission );
1720
1721 case self::AS_NO_CHANGE_CONTENT_MODEL:
1722 throw new PermissionsError( 'editcontentmodel' );
1723
1724 default:
1725 // We don't recognize $status->value. The only way that can happen
1726 // is if an extension hook aborted from inside ArticleSave.
1727 // Render the status object into $this->hookError
1728 // FIXME this sucks, we should just use the Status object throughout
1729 $this->hookError = '<div class="error">' . "\n" . $status->getWikiText() .
1730 '</div>';
1731 return true;
1732 }
1733 }
1734
1735 /**
1736 * Run hooks that can filter edits just before they get saved.
1737 *
1738 * @param Content $content The Content to filter.
1739 * @param Status $status For reporting the outcome to the caller
1740 * @param User $user The user performing the edit
1741 *
1742 * @return bool
1743 */
1744 protected function runPostMergeFilters( Content $content, Status $status, User $user ) {
1745 // Run old style post-section-merge edit filter
1746 if ( $this->hookError != '' ) {
1747 # ...or the hook could be expecting us to produce an error
1748 $status->fatal( 'hookaborted' );
1749 $status->value = self::AS_HOOK_ERROR_EXPECTED;
1750 return false;
1751 }
1752
1753 // Run new style post-section-merge edit filter
1754 if ( !Hooks::run( 'EditFilterMergedContent',
1755 [ $this->context, $content, $status, $this->summary,
1756 $user, $this->minoredit ] )
1757 ) {
1758 # Error messages etc. could be handled within the hook...
1759 if ( $status->isGood() ) {
1760 $status->fatal( 'hookaborted' );
1761 // Not setting $this->hookError here is a hack to allow the hook
1762 // to cause a return to the edit page without $this->hookError
1763 // being set. This is used by ConfirmEdit to display a captcha
1764 // without any error message cruft.
1765 } else {
1766 $this->hookError = $this->formatStatusErrors( $status );
1767 }
1768 // Use the existing $status->value if the hook set it
1769 if ( !$status->value ) {
1770 $status->value = self::AS_HOOK_ERROR;
1771 }
1772 return false;
1773 } elseif ( !$status->isOK() ) {
1774 # ...or the hook could be expecting us to produce an error
1775 // FIXME this sucks, we should just use the Status object throughout
1776 $this->hookError = $this->formatStatusErrors( $status );
1777 $status->fatal( 'hookaborted' );
1778 $status->value = self::AS_HOOK_ERROR_EXPECTED;
1779 return false;
1780 }
1781
1782 return true;
1783 }
1784
1785 /**
1786 * Wrap status errors in an errorbox for increased visibility
1787 *
1788 * @param Status $status
1789 * @return string Wikitext
1790 */
1791 private function formatStatusErrors( Status $status ) {
1792 $errmsg = $status->getWikiText(
1793 'edit-error-short',
1794 'edit-error-long',
1795 $this->context->getLanguage()
1796 );
1797 return <<<ERROR
1798 <div class="errorbox">
1799 {$errmsg}
1800 </div>
1801 <br clear="all" />
1802 ERROR;
1803 }
1804
1805 /**
1806 * Return the summary to be used for a new section.
1807 *
1808 * @param string $sectionanchor Set to the section anchor text
1809 * @return string
1810 */
1811 private function newSectionSummary( &$sectionanchor = null ) {
1812 if ( $this->sectiontitle !== '' ) {
1813 $sectionanchor = $this->guessSectionName( $this->sectiontitle );
1814 // If no edit summary was specified, create one automatically from the section
1815 // title and have it link to the new section. Otherwise, respect the summary as
1816 // passed.
1817 if ( $this->summary === '' ) {
1818 $cleanSectionTitle = MediaWikiServices::getInstance()->getParser()
1819 ->stripSectionName( $this->sectiontitle );
1820 return $this->context->msg( 'newsectionsummary' )
1821 ->plaintextParams( $cleanSectionTitle )->inContentLanguage()->text();
1822 }
1823 } elseif ( $this->summary !== '' ) {
1824 $sectionanchor = $this->guessSectionName( $this->summary );
1825 # This is a new section, so create a link to the new section
1826 # in the revision summary.
1827 $cleanSummary = MediaWikiServices::getInstance()->getParser()
1828 ->stripSectionName( $this->summary );
1829 return $this->context->msg( 'newsectionsummary' )
1830 ->plaintextParams( $cleanSummary )->inContentLanguage()->text();
1831 }
1832 return $this->summary;
1833 }
1834
1835 /**
1836 * Attempt submission (no UI)
1837 *
1838 * @param array &$result Array to add statuses to, currently with the
1839 * possible keys:
1840 * - spam (string): Spam string from content if any spam is detected by
1841 * matchSpamRegex.
1842 * - sectionanchor (string): Section anchor for a section save.
1843 * - nullEdit (bool): Set if doEditContent is OK. True if null edit,
1844 * false otherwise.
1845 * - redirect (bool): Set if doEditContent is OK. True if resulting
1846 * revision is a redirect.
1847 * @param bool $bot True if edit is being made under the bot right.
1848 *
1849 * @return Status Status object, possibly with a message, but always with
1850 * one of the AS_* constants in $status->value,
1851 *
1852 * @todo FIXME: This interface is TERRIBLE, but hard to get rid of due to
1853 * various error display idiosyncrasies. There are also lots of cases
1854 * where error metadata is set in the object and retrieved later instead
1855 * of being returned, e.g. AS_CONTENT_TOO_BIG and
1856 * AS_BLOCKED_PAGE_FOR_USER. All that stuff needs to be cleaned up some
1857 * time.
1858 */
1859 public function internalAttemptSave( &$result, $bot = false ) {
1860 $status = Status::newGood();
1861 $user = $this->context->getUser();
1862
1863 if ( !Hooks::run( 'EditPage::attemptSave', [ $this ] ) ) {
1864 wfDebug( "Hook 'EditPage::attemptSave' aborted article saving\n" );
1865 $status->fatal( 'hookaborted' );
1866 $status->value = self::AS_HOOK_ERROR;
1867 return $status;
1868 }
1869
1870 if ( $this->unicodeCheck !== self::UNICODE_CHECK ) {
1871 $status->fatal( 'unicode-support-fail' );
1872 $status->value = self::AS_UNICODE_NOT_SUPPORTED;
1873 return $status;
1874 }
1875
1876 $request = $this->context->getRequest();
1877 $spam = $request->getText( 'wpAntispam' );
1878 if ( $spam !== '' ) {
1879 wfDebugLog(
1880 'SimpleAntiSpam',
1881 $user->getName() .
1882 ' editing "' .
1883 $this->mTitle->getPrefixedText() .
1884 '" submitted bogus field "' .
1885 $spam .
1886 '"'
1887 );
1888 $status->fatal( 'spamprotectionmatch', false );
1889 $status->value = self::AS_SPAM_ERROR;
1890 return $status;
1891 }
1892
1893 try {
1894 # Construct Content object
1895 $textbox_content = $this->toEditContent( $this->textbox1 );
1896 } catch ( MWContentSerializationException $ex ) {
1897 $status->fatal(
1898 'content-failed-to-parse',
1899 $this->contentModel,
1900 $this->contentFormat,
1901 $ex->getMessage()
1902 );
1903 $status->value = self::AS_PARSE_ERROR;
1904 return $status;
1905 }
1906
1907 # Check image redirect
1908 if ( $this->mTitle->getNamespace() == NS_FILE &&
1909 $textbox_content->isRedirect() &&
1910 !$user->isAllowed( 'upload' )
1911 ) {
1912 $code = $user->isAnon() ? self::AS_IMAGE_REDIRECT_ANON : self::AS_IMAGE_REDIRECT_LOGGED;
1913 $status->setResult( false, $code );
1914
1915 return $status;
1916 }
1917
1918 # Check for spam
1919 $match = self::matchSummarySpamRegex( $this->summary );
1920 if ( $match === false && $this->section == 'new' ) {
1921 # $wgSpamRegex is enforced on this new heading/summary because, unlike
1922 # regular summaries, it is added to the actual wikitext.
1923 if ( $this->sectiontitle !== '' ) {
1924 # This branch is taken when the API is used with the 'sectiontitle' parameter.
1925 $match = self::matchSpamRegex( $this->sectiontitle );
1926 } else {
1927 # This branch is taken when the "Add Topic" user interface is used, or the API
1928 # is used with the 'summary' parameter.
1929 $match = self::matchSpamRegex( $this->summary );
1930 }
1931 }
1932 if ( $match === false ) {
1933 $match = self::matchSpamRegex( $this->textbox1 );
1934 }
1935 if ( $match !== false ) {
1936 $result['spam'] = $match;
1937 $ip = $request->getIP();
1938 $pdbk = $this->mTitle->getPrefixedDBkey();
1939 $match = str_replace( "\n", '', $match );
1940 wfDebugLog( 'SpamRegex', "$ip spam regex hit [[$pdbk]]: \"$match\"" );
1941 $status->fatal( 'spamprotectionmatch', $match );
1942 $status->value = self::AS_SPAM_ERROR;
1943 return $status;
1944 }
1945 if ( !Hooks::run(
1946 'EditFilter',
1947 [ $this, $this->textbox1, $this->section, &$this->hookError, $this->summary ] )
1948 ) {
1949 # Error messages etc. could be handled within the hook...
1950 $status->fatal( 'hookaborted' );
1951 $status->value = self::AS_HOOK_ERROR;
1952 return $status;
1953 } elseif ( $this->hookError != '' ) {
1954 # ...or the hook could be expecting us to produce an error
1955 $status->fatal( 'hookaborted' );
1956 $status->value = self::AS_HOOK_ERROR_EXPECTED;
1957 return $status;
1958 }
1959
1960 if ( $user->isBlockedFrom( $this->mTitle ) ) {
1961 // Auto-block user's IP if the account was "hard" blocked
1962 if ( !wfReadOnly() ) {
1963 $user->spreadAnyEditBlock();
1964 }
1965 # Check block state against master, thus 'false'.
1966 $status->setResult( false, self::AS_BLOCKED_PAGE_FOR_USER );
1967 return $status;
1968 }
1969
1970 $this->contentLength = strlen( $this->textbox1 );
1971 $config = $this->context->getConfig();
1972 $maxArticleSize = $config->get( 'MaxArticleSize' );
1973 if ( $this->contentLength > $maxArticleSize * 1024 ) {
1974 // Error will be displayed by showEditForm()
1975 $this->tooBig = true;
1976 $status->setResult( false, self::AS_CONTENT_TOO_BIG );
1977 return $status;
1978 }
1979
1980 if ( !$user->isAllowed( 'edit' ) ) {
1981 if ( $user->isAnon() ) {
1982 $status->setResult( false, self::AS_READ_ONLY_PAGE_ANON );
1983 return $status;
1984 } else {
1985 $status->fatal( 'readonlytext' );
1986 $status->value = self::AS_READ_ONLY_PAGE_LOGGED;
1987 return $status;
1988 }
1989 }
1990
1991 $changingContentModel = false;
1992 if ( $this->contentModel !== $this->mTitle->getContentModel() ) {
1993 if ( !$config->get( 'ContentHandlerUseDB' ) ) {
1994 $status->fatal( 'editpage-cannot-use-custom-model' );
1995 $status->value = self::AS_CANNOT_USE_CUSTOM_MODEL;
1996 return $status;
1997 } elseif ( !$user->isAllowed( 'editcontentmodel' ) ) {
1998 $status->setResult( false, self::AS_NO_CHANGE_CONTENT_MODEL );
1999 return $status;
2000 }
2001 // Make sure the user can edit the page under the new content model too
2002 $titleWithNewContentModel = clone $this->mTitle;
2003 $titleWithNewContentModel->setContentModel( $this->contentModel );
2004 if ( !$titleWithNewContentModel->userCan( 'editcontentmodel', $user )
2005 || !$titleWithNewContentModel->userCan( 'edit', $user )
2006 ) {
2007 $status->setResult( false, self::AS_NO_CHANGE_CONTENT_MODEL );
2008 return $status;
2009 }
2010
2011 $changingContentModel = true;
2012 $oldContentModel = $this->mTitle->getContentModel();
2013 }
2014
2015 if ( $this->changeTags ) {
2016 $changeTagsStatus = ChangeTags::canAddTagsAccompanyingChange(
2017 $this->changeTags, $user );
2018 if ( !$changeTagsStatus->isOK() ) {
2019 $changeTagsStatus->value = self::AS_CHANGE_TAG_ERROR;
2020 return $changeTagsStatus;
2021 }
2022 }
2023
2024 if ( wfReadOnly() ) {
2025 $status->fatal( 'readonlytext' );
2026 $status->value = self::AS_READ_ONLY_PAGE;
2027 return $status;
2028 }
2029 if ( $user->pingLimiter() || $user->pingLimiter( 'linkpurge', 0 )
2030 || ( $changingContentModel && $user->pingLimiter( 'editcontentmodel' ) )
2031 ) {
2032 $status->fatal( 'actionthrottledtext' );
2033 $status->value = self::AS_RATE_LIMITED;
2034 return $status;
2035 }
2036
2037 # If the article has been deleted while editing, don't save it without
2038 # confirmation
2039 if ( $this->wasDeletedSinceLastEdit() && !$this->recreate ) {
2040 $status->setResult( false, self::AS_ARTICLE_WAS_DELETED );
2041 return $status;
2042 }
2043
2044 # Load the page data from the master. If anything changes in the meantime,
2045 # we detect it by using page_latest like a token in a 1 try compare-and-swap.
2046 $this->page->loadPageData( 'fromdbmaster' );
2047 $new = !$this->page->exists();
2048
2049 if ( $new ) {
2050 // Late check for create permission, just in case *PARANOIA*
2051 if ( !$this->mTitle->userCan( 'create', $user ) ) {
2052 $status->fatal( 'nocreatetext' );
2053 $status->value = self::AS_NO_CREATE_PERMISSION;
2054 wfDebug( __METHOD__ . ": no create permission\n" );
2055 return $status;
2056 }
2057
2058 // Don't save a new page if it's blank or if it's a MediaWiki:
2059 // message with content equivalent to default (allow empty pages
2060 // in this case to disable messages, see T52124)
2061 $defaultMessageText = $this->mTitle->getDefaultMessageText();
2062 if ( $this->mTitle->getNamespace() === NS_MEDIAWIKI && $defaultMessageText !== false ) {
2063 $defaultText = $defaultMessageText;
2064 } else {
2065 $defaultText = '';
2066 }
2067
2068 if ( !$this->allowBlankArticle && $this->textbox1 === $defaultText ) {
2069 $this->blankArticle = true;
2070 $status->fatal( 'blankarticle' );
2071 $status->setResult( false, self::AS_BLANK_ARTICLE );
2072 return $status;
2073 }
2074
2075 if ( !$this->runPostMergeFilters( $textbox_content, $status, $user ) ) {
2076 return $status;
2077 }
2078
2079 $content = $textbox_content;
2080
2081 $result['sectionanchor'] = '';
2082 if ( $this->section == 'new' ) {
2083 if ( $this->sectiontitle !== '' ) {
2084 // Insert the section title above the content.
2085 $content = $content->addSectionHeader( $this->sectiontitle );
2086 } elseif ( $this->summary !== '' ) {
2087 // Insert the section title above the content.
2088 $content = $content->addSectionHeader( $this->summary );
2089 }
2090 $this->summary = $this->newSectionSummary( $result['sectionanchor'] );
2091 }
2092
2093 $status->value = self::AS_SUCCESS_NEW_ARTICLE;
2094
2095 } else { # not $new
2096
2097 # Article exists. Check for edit conflict.
2098
2099 $this->page->clear(); # Force reload of dates, etc.
2100 $timestamp = $this->page->getTimestamp();
2101 $latest = $this->page->getLatest();
2102
2103 wfDebug( "timestamp: {$timestamp}, edittime: {$this->edittime}\n" );
2104
2105 // An edit conflict is detected if the current revision is different from the
2106 // revision that was current when editing was initiated on the client.
2107 // This is checked based on the timestamp and revision ID.
2108 // TODO: the timestamp based check can probably go away now.
2109 if ( $timestamp != $this->edittime
2110 || ( $this->editRevId !== null && $this->editRevId != $latest )
2111 ) {
2112 $this->isConflict = true;
2113 if ( $this->section == 'new' ) {
2114 if ( $this->page->getUserText() == $user->getName() &&
2115 $this->page->getComment() == $this->newSectionSummary()
2116 ) {
2117 // Probably a duplicate submission of a new comment.
2118 // This can happen when CDN resends a request after
2119 // a timeout but the first one actually went through.
2120 wfDebug( __METHOD__
2121 . ": duplicate new section submission; trigger edit conflict!\n" );
2122 } else {
2123 // New comment; suppress conflict.
2124 $this->isConflict = false;
2125 wfDebug( __METHOD__ . ": conflict suppressed; new section\n" );
2126 }
2127 } elseif ( $this->section == ''
2128 && Revision::userWasLastToEdit(
2129 DB_MASTER, $this->mTitle->getArticleID(),
2130 $user->getId(), $this->edittime
2131 )
2132 ) {
2133 # Suppress edit conflict with self, except for section edits where merging is required.
2134 wfDebug( __METHOD__ . ": Suppressing edit conflict, same user.\n" );
2135 $this->isConflict = false;
2136 }
2137 }
2138
2139 // If sectiontitle is set, use it, otherwise use the summary as the section title.
2140 if ( $this->sectiontitle !== '' ) {
2141 $sectionTitle = $this->sectiontitle;
2142 } else {
2143 $sectionTitle = $this->summary;
2144 }
2145
2146 $content = null;
2147
2148 if ( $this->isConflict ) {
2149 wfDebug( __METHOD__
2150 . ": conflict! getting section '{$this->section}' for time '{$this->edittime}'"
2151 . " (id '{$this->editRevId}') (article time '{$timestamp}')\n" );
2152 // @TODO: replaceSectionAtRev() with base ID (not prior current) for ?oldid=X case
2153 // ...or disable section editing for non-current revisions (not exposed anyway).
2154 if ( $this->editRevId !== null ) {
2155 $content = $this->page->replaceSectionAtRev(
2156 $this->section,
2157 $textbox_content,
2158 $sectionTitle,
2159 $this->editRevId
2160 );
2161 } else {
2162 $content = $this->page->replaceSectionContent(
2163 $this->section,
2164 $textbox_content,
2165 $sectionTitle,
2166 $this->edittime
2167 );
2168 }
2169 } else {
2170 wfDebug( __METHOD__ . ": getting section '{$this->section}'\n" );
2171 $content = $this->page->replaceSectionContent(
2172 $this->section,
2173 $textbox_content,
2174 $sectionTitle
2175 );
2176 }
2177
2178 if ( is_null( $content ) ) {
2179 wfDebug( __METHOD__ . ": activating conflict; section replace failed.\n" );
2180 $this->isConflict = true;
2181 $content = $textbox_content; // do not try to merge here!
2182 } elseif ( $this->isConflict ) {
2183 # Attempt merge
2184 if ( $this->mergeChangesIntoContent( $content ) ) {
2185 // Successful merge! Maybe we should tell the user the good news?
2186 $this->isConflict = false;
2187 wfDebug( __METHOD__ . ": Suppressing edit conflict, successful merge.\n" );
2188 } else {
2189 $this->section = '';
2190 $this->textbox1 = ContentHandler::getContentText( $content );
2191 wfDebug( __METHOD__ . ": Keeping edit conflict, failed merge.\n" );
2192 }
2193 }
2194
2195 if ( $this->isConflict ) {
2196 $status->setResult( false, self::AS_CONFLICT_DETECTED );
2197 return $status;
2198 }
2199
2200 if ( !$this->runPostMergeFilters( $content, $status, $user ) ) {
2201 return $status;
2202 }
2203
2204 if ( $this->section == 'new' ) {
2205 // Handle the user preference to force summaries here
2206 if ( !$this->allowBlankSummary && trim( $this->summary ) == '' ) {
2207 $this->missingSummary = true;
2208 $status->fatal( 'missingsummary' ); // or 'missingcommentheader' if $section == 'new'. Blegh
2209 $status->value = self::AS_SUMMARY_NEEDED;
2210 return $status;
2211 }
2212
2213 // Do not allow the user to post an empty comment
2214 if ( $this->textbox1 == '' ) {
2215 $this->missingComment = true;
2216 $status->fatal( 'missingcommenttext' );
2217 $status->value = self::AS_TEXTBOX_EMPTY;
2218 return $status;
2219 }
2220 } elseif ( !$this->allowBlankSummary
2221 && !$content->equals( $this->getOriginalContent( $user ) )
2222 && !$content->isRedirect()
2223 && md5( $this->summary ) == $this->autoSumm
2224 ) {
2225 $this->missingSummary = true;
2226 $status->fatal( 'missingsummary' );
2227 $status->value = self::AS_SUMMARY_NEEDED;
2228 return $status;
2229 }
2230
2231 # All's well
2232 $sectionanchor = '';
2233 if ( $this->section == 'new' ) {
2234 $this->summary = $this->newSectionSummary( $sectionanchor );
2235 } elseif ( $this->section != '' ) {
2236 # Try to get a section anchor from the section source, redirect
2237 # to edited section if header found.
2238 # XXX: Might be better to integrate this into Article::replaceSectionAtRev
2239 # for duplicate heading checking and maybe parsing.
2240 $hasmatch = preg_match( "/^ *([=]{1,6})(.*?)(\\1) *\\n/i", $this->textbox1, $matches );
2241 # We can't deal with anchors, includes, html etc in the header for now,
2242 # headline would need to be parsed to improve this.
2243 if ( $hasmatch && strlen( $matches[2] ) > 0 ) {
2244 $sectionanchor = $this->guessSectionName( $matches[2] );
2245 }
2246 }
2247 $result['sectionanchor'] = $sectionanchor;
2248
2249 // Save errors may fall down to the edit form, but we've now
2250 // merged the section into full text. Clear the section field
2251 // so that later submission of conflict forms won't try to
2252 // replace that into a duplicated mess.
2253 $this->textbox1 = $this->toEditText( $content );
2254 $this->section = '';
2255
2256 $status->value = self::AS_SUCCESS_UPDATE;
2257 }
2258
2259 if ( !$this->allowSelfRedirect
2260 && $content->isRedirect()
2261 && $content->getRedirectTarget()->equals( $this->getTitle() )
2262 ) {
2263 // If the page already redirects to itself, don't warn.
2264 $currentTarget = $this->getCurrentContent()->getRedirectTarget();
2265 if ( !$currentTarget || !$currentTarget->equals( $this->getTitle() ) ) {
2266 $this->selfRedirect = true;
2267 $status->fatal( 'selfredirect' );
2268 $status->value = self::AS_SELF_REDIRECT;
2269 return $status;
2270 }
2271 }
2272
2273 // Check for length errors again now that the section is merged in
2274 $this->contentLength = strlen( $this->toEditText( $content ) );
2275 if ( $this->contentLength > $maxArticleSize * 1024 ) {
2276 $this->tooBig = true;
2277 $status->setResult( false, self::AS_MAX_ARTICLE_SIZE_EXCEEDED );
2278 return $status;
2279 }
2280
2281 $flags = EDIT_AUTOSUMMARY |
2282 ( $new ? EDIT_NEW : EDIT_UPDATE ) |
2283 ( ( $this->minoredit && !$this->isNew ) ? EDIT_MINOR : 0 ) |
2284 ( $bot ? EDIT_FORCE_BOT : 0 );
2285
2286 $doEditStatus = $this->page->doEditContent(
2287 $content,
2288 $this->summary,
2289 $flags,
2290 false,
2291 $user,
2292 $content->getDefaultFormat(),
2293 $this->changeTags,
2294 $this->undidRev
2295 );
2296
2297 if ( !$doEditStatus->isOK() ) {
2298 // Failure from doEdit()
2299 // Show the edit conflict page for certain recognized errors from doEdit(),
2300 // but don't show it for errors from extension hooks
2301 $errors = $doEditStatus->getErrorsArray();
2302 if ( in_array( $errors[0][0],
2303 [ 'edit-gone-missing', 'edit-conflict', 'edit-already-exists' ] )
2304 ) {
2305 $this->isConflict = true;
2306 // Destroys data doEdit() put in $status->value but who cares
2307 $doEditStatus->value = self::AS_END;
2308 }
2309 return $doEditStatus;
2310 }
2311
2312 $result['nullEdit'] = $doEditStatus->hasMessage( 'edit-no-change' );
2313 if ( $result['nullEdit'] ) {
2314 // We don't know if it was a null edit until now, so increment here
2315 $user->pingLimiter( 'linkpurge' );
2316 }
2317 $result['redirect'] = $content->isRedirect();
2318
2319 $this->updateWatchlist();
2320
2321 // If the content model changed, add a log entry
2322 if ( $changingContentModel ) {
2323 $this->addContentModelChangeLogEntry(
2324 $user,
2325 $new ? false : $oldContentModel,
2326 $this->contentModel,
2327 $this->summary
2328 );
2329 }
2330
2331 return $status;
2332 }
2333
2334 /**
2335 * @param User $user
2336 * @param string|false $oldModel false if the page is being newly created
2337 * @param string $newModel
2338 * @param string $reason
2339 */
2340 protected function addContentModelChangeLogEntry( User $user, $oldModel, $newModel, $reason ) {
2341 $new = $oldModel === false;
2342 $log = new ManualLogEntry( 'contentmodel', $new ? 'new' : 'change' );
2343 $log->setPerformer( $user );
2344 $log->setTarget( $this->mTitle );
2345 $log->setComment( $reason );
2346 $log->setParameters( [
2347 '4::oldmodel' => $oldModel,
2348 '5::newmodel' => $newModel
2349 ] );
2350 $logid = $log->insert();
2351 $log->publish( $logid );
2352 }
2353
2354 /**
2355 * Register the change of watch status
2356 */
2357 protected function updateWatchlist() {
2358 $user = $this->context->getUser();
2359 if ( !$user->isLoggedIn() ) {
2360 return;
2361 }
2362
2363 $title = $this->mTitle;
2364 $watch = $this->watchthis;
2365 // Do this in its own transaction to reduce contention...
2366 DeferredUpdates::addCallableUpdate( function () use ( $user, $title, $watch ) {
2367 if ( $watch == $user->isWatched( $title, User::IGNORE_USER_RIGHTS ) ) {
2368 return; // nothing to change
2369 }
2370 WatchAction::doWatchOrUnwatch( $watch, $title, $user );
2371 } );
2372 }
2373
2374 /**
2375 * Attempts to do 3-way merge of edit content with a base revision
2376 * and current content, in case of edit conflict, in whichever way appropriate
2377 * for the content type.
2378 *
2379 * @since 1.21
2380 *
2381 * @param Content $editContent
2382 *
2383 * @return bool
2384 */
2385 private function mergeChangesIntoContent( &$editContent ) {
2386 $db = wfGetDB( DB_MASTER );
2387
2388 // This is the revision that was current at the time editing was initiated on the client,
2389 // even if the edit was based on an old revision.
2390 $baseRevision = $this->getBaseRevision();
2391 $baseContent = $baseRevision ? $baseRevision->getContent() : null;
2392
2393 if ( is_null( $baseContent ) ) {
2394 return false;
2395 }
2396
2397 // The current state, we want to merge updates into it
2398 $currentRevision = Revision::loadFromTitle( $db, $this->mTitle );
2399 $currentContent = $currentRevision ? $currentRevision->getContent() : null;
2400
2401 if ( is_null( $currentContent ) ) {
2402 return false;
2403 }
2404
2405 $handler = ContentHandler::getForModelID( $baseContent->getModel() );
2406
2407 $result = $handler->merge3( $baseContent, $editContent, $currentContent );
2408
2409 if ( $result ) {
2410 $editContent = $result;
2411 // Update parentRevId to what we just merged.
2412 $this->parentRevId = $currentRevision->getId();
2413 return true;
2414 }
2415
2416 return false;
2417 }
2418
2419 /**
2420 * Returns the revision that was current at the time editing was initiated on the client,
2421 * even if the edit was based on an old revision.
2422 *
2423 * @warning this method is very poorly named. If the user opened the form with ?oldid=X,
2424 * one might think of X as the "base revision", which is NOT what this returns,
2425 * see oldid for that. One might further assume that this corresponds to the $baseRevId
2426 * parameter of WikiPage::doEditContent, which is not the case either.
2427 * getExpectedParentRevision() would perhaps be a better name.
2428 *
2429 * @return Revision|null Current version when editing was initiated on the client
2430 */
2431 public function getBaseRevision() {
2432 if ( !$this->mBaseRevision ) {
2433 $db = wfGetDB( DB_MASTER );
2434 $this->mBaseRevision = $this->editRevId
2435 ? Revision::newFromId( $this->editRevId, Revision::READ_LATEST )
2436 : Revision::loadFromTimestamp( $db, $this->mTitle, $this->edittime );
2437 }
2438 return $this->mBaseRevision;
2439 }
2440
2441 /**
2442 * Check given input text against $wgSpamRegex, and return the text of the first match.
2443 *
2444 * @param string $text
2445 *
2446 * @return string|bool Matching string or false
2447 */
2448 public static function matchSpamRegex( $text ) {
2449 global $wgSpamRegex;
2450 // For back compatibility, $wgSpamRegex may be a single string or an array of regexes.
2451 $regexes = (array)$wgSpamRegex;
2452 return self::matchSpamRegexInternal( $text, $regexes );
2453 }
2454
2455 /**
2456 * Check given input text against $wgSummarySpamRegex, and return the text of the first match.
2457 *
2458 * @param string $text
2459 *
2460 * @return string|bool Matching string or false
2461 */
2462 public static function matchSummarySpamRegex( $text ) {
2463 global $wgSummarySpamRegex;
2464 $regexes = (array)$wgSummarySpamRegex;
2465 return self::matchSpamRegexInternal( $text, $regexes );
2466 }
2467
2468 /**
2469 * @param string $text
2470 * @param array $regexes
2471 * @return bool|string
2472 */
2473 protected static function matchSpamRegexInternal( $text, $regexes ) {
2474 foreach ( $regexes as $regex ) {
2475 $matches = [];
2476 if ( preg_match( $regex, $text, $matches ) ) {
2477 return $matches[0];
2478 }
2479 }
2480 return false;
2481 }
2482
2483 public function setHeaders() {
2484 $out = $this->context->getOutput();
2485
2486 $out->addModules( 'mediawiki.action.edit' );
2487 $out->addModuleStyles( 'mediawiki.action.edit.styles' );
2488 $out->addModuleStyles( 'mediawiki.editfont.styles' );
2489
2490 $user = $this->context->getUser();
2491
2492 if ( $user->getOption( 'uselivepreview' ) ) {
2493 $out->addModules( 'mediawiki.action.edit.preview' );
2494 }
2495
2496 if ( $user->getOption( 'useeditwarning' ) ) {
2497 $out->addModules( 'mediawiki.action.edit.editWarning' );
2498 }
2499
2500 # Enabled article-related sidebar, toplinks, etc.
2501 $out->setArticleRelated( true );
2502
2503 $contextTitle = $this->getContextTitle();
2504 if ( $this->isConflict ) {
2505 $msg = 'editconflict';
2506 } elseif ( $contextTitle->exists() && $this->section != '' ) {
2507 $msg = $this->section == 'new' ? 'editingcomment' : 'editingsection';
2508 } else {
2509 $msg = $contextTitle->exists()
2510 || ( $contextTitle->getNamespace() == NS_MEDIAWIKI
2511 && $contextTitle->getDefaultMessageText() !== false
2512 )
2513 ? 'editing'
2514 : 'creating';
2515 }
2516
2517 # Use the title defined by DISPLAYTITLE magic word when present
2518 # NOTE: getDisplayTitle() returns HTML while getPrefixedText() returns plain text.
2519 # setPageTitle() treats the input as wikitext, which should be safe in either case.
2520 $displayTitle = isset( $this->mParserOutput ) ? $this->mParserOutput->getDisplayTitle() : false;
2521 if ( $displayTitle === false ) {
2522 $displayTitle = $contextTitle->getPrefixedText();
2523 } else {
2524 $out->setDisplayTitle( $displayTitle );
2525 }
2526 $out->setPageTitle( $this->context->msg( $msg, $displayTitle ) );
2527
2528 $config = $this->context->getConfig();
2529
2530 # Transmit the name of the message to JavaScript for live preview
2531 # Keep Resources.php/mediawiki.action.edit.preview in sync with the possible keys
2532 $out->addJsConfigVars( [
2533 'wgEditMessage' => $msg,
2534 'wgAjaxEditStash' => $config->get( 'AjaxEditStash' ),
2535 ] );
2536
2537 // Add whether to use 'save' or 'publish' messages to JavaScript for post-edit, other
2538 // editors, etc.
2539 $out->addJsConfigVars(
2540 'wgEditSubmitButtonLabelPublish',
2541 $config->get( 'EditSubmitButtonLabelPublish' )
2542 );
2543 }
2544
2545 /**
2546 * Show all applicable editing introductions
2547 */
2548 protected function showIntro() {
2549 if ( $this->suppressIntro ) {
2550 return;
2551 }
2552
2553 $out = $this->context->getOutput();
2554 $namespace = $this->mTitle->getNamespace();
2555
2556 if ( $namespace == NS_MEDIAWIKI ) {
2557 # Show a warning if editing an interface message
2558 $out->wrapWikiMsg( "<div class='mw-editinginterface'>\n$1\n</div>", 'editinginterface' );
2559 # If this is a default message (but not css, json, or js),
2560 # show a hint that it is translatable on translatewiki.net
2561 if (
2562 !$this->mTitle->hasContentModel( CONTENT_MODEL_CSS )
2563 && !$this->mTitle->hasContentModel( CONTENT_MODEL_JSON )
2564 && !$this->mTitle->hasContentModel( CONTENT_MODEL_JAVASCRIPT )
2565 ) {
2566 $defaultMessageText = $this->mTitle->getDefaultMessageText();
2567 if ( $defaultMessageText !== false ) {
2568 $out->wrapWikiMsg( "<div class='mw-translateinterface'>\n$1\n</div>",
2569 'translateinterface' );
2570 }
2571 }
2572 } elseif ( $namespace == NS_FILE ) {
2573 # Show a hint to shared repo
2574 $file = wfFindFile( $this->mTitle );
2575 if ( $file && !$file->isLocal() ) {
2576 $descUrl = $file->getDescriptionUrl();
2577 # there must be a description url to show a hint to shared repo
2578 if ( $descUrl ) {
2579 if ( !$this->mTitle->exists() ) {
2580 $out->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-create\">\n$1\n</div>", [
2581 'sharedupload-desc-create', $file->getRepo()->getDisplayName(), $descUrl
2582 ] );
2583 } else {
2584 $out->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-edit\">\n$1\n</div>", [
2585 'sharedupload-desc-edit', $file->getRepo()->getDisplayName(), $descUrl
2586 ] );
2587 }
2588 }
2589 }
2590 }
2591
2592 # Show a warning message when someone creates/edits a user (talk) page but the user does not exist
2593 # Show log extract when the user is currently blocked
2594 if ( $namespace == NS_USER || $namespace == NS_USER_TALK ) {
2595 $username = explode( '/', $this->mTitle->getText(), 2 )[0];
2596 $user = User::newFromName( $username, false /* allow IP users */ );
2597 $ip = User::isIP( $username );
2598 $block = Block::newFromTarget( $user, $user );
2599 if ( !( $user && $user->isLoggedIn() ) && !$ip ) { # User does not exist
2600 $out->wrapWikiMsg( "<div class=\"mw-userpage-userdoesnotexist error\">\n$1\n</div>",
2601 [ 'userpage-userdoesnotexist', wfEscapeWikiText( $username ) ] );
2602 } elseif (
2603 !is_null( $block ) &&
2604 $block->getType() != Block::TYPE_AUTO &&
2605 ( $block->isSitewide() || $user->isBlockedFrom( $this->mTitle ) )
2606 ) {
2607 // Show log extract if the user is sitewide blocked or is partially
2608 // blocked and not allowed to edit their user page or user talk page
2609 LogEventsList::showLogExtract(
2610 $out,
2611 'block',
2612 MediaWikiServices::getInstance()->getNamespaceInfo()->
2613 getCanonicalName( NS_USER ) . ':' . $block->getTarget(),
2614 '',
2615 [
2616 'lim' => 1,
2617 'showIfEmpty' => false,
2618 'msgKey' => [
2619 'blocked-notice-logextract',
2620 $user->getName() # Support GENDER in notice
2621 ]
2622 ]
2623 );
2624 }
2625 }
2626 # Try to add a custom edit intro, or use the standard one if this is not possible.
2627 if ( !$this->showCustomIntro() && !$this->mTitle->exists() ) {
2628 $helpLink = wfExpandUrl( Skin::makeInternalOrExternalUrl(
2629 $this->context->msg( 'helppage' )->inContentLanguage()->text()
2630 ) );
2631 if ( $this->context->getUser()->isLoggedIn() ) {
2632 $out->wrapWikiMsg(
2633 // Suppress the external link icon, consider the help url an internal one
2634 "<div class=\"mw-newarticletext plainlinks\">\n$1\n</div>",
2635 [
2636 'newarticletext',
2637 $helpLink
2638 ]
2639 );
2640 } else {
2641 $out->wrapWikiMsg(
2642 // Suppress the external link icon, consider the help url an internal one
2643 "<div class=\"mw-newarticletextanon plainlinks\">\n$1\n</div>",
2644 [
2645 'newarticletextanon',
2646 $helpLink
2647 ]
2648 );
2649 }
2650 }
2651 # Give a notice if the user is editing a deleted/moved page...
2652 if ( !$this->mTitle->exists() ) {
2653 $dbr = wfGetDB( DB_REPLICA );
2654
2655 LogEventsList::showLogExtract( $out, [ 'delete', 'move' ], $this->mTitle,
2656 '',
2657 [
2658 'lim' => 10,
2659 'conds' => [ 'log_action != ' . $dbr->addQuotes( 'revision' ) ],
2660 'showIfEmpty' => false,
2661 'msgKey' => [ 'recreate-moveddeleted-warn' ]
2662 ]
2663 );
2664 }
2665 }
2666
2667 /**
2668 * Attempt to show a custom editing introduction, if supplied
2669 *
2670 * @return bool
2671 */
2672 protected function showCustomIntro() {
2673 if ( $this->editintro ) {
2674 $title = Title::newFromText( $this->editintro );
2675 if ( $title instanceof Title && $title->exists() && $title->userCan( 'read' ) ) {
2676 // Added using template syntax, to take <noinclude>'s into account.
2677 $this->context->getOutput()->addWikiTextAsContent(
2678 '<div class="mw-editintro">{{:' . $title->getFullText() . '}}</div>',
2679 /*linestart*/true,
2680 $this->mTitle
2681 );
2682 return true;
2683 }
2684 }
2685 return false;
2686 }
2687
2688 /**
2689 * Gets an editable textual representation of $content.
2690 * The textual representation can be turned by into a Content object by the
2691 * toEditContent() method.
2692 *
2693 * If $content is null or false or a string, $content is returned unchanged.
2694 *
2695 * If the given Content object is not of a type that can be edited using
2696 * the text base EditPage, an exception will be raised. Set
2697 * $this->allowNonTextContent to true to allow editing of non-textual
2698 * content.
2699 *
2700 * @param Content|null|bool|string $content
2701 * @return string The editable text form of the content.
2702 *
2703 * @throws MWException If $content is not an instance of TextContent and
2704 * $this->allowNonTextContent is not true.
2705 */
2706 protected function toEditText( $content ) {
2707 if ( $content === null || $content === false || is_string( $content ) ) {
2708 return $content;
2709 }
2710
2711 if ( !$this->isSupportedContentModel( $content->getModel() ) ) {
2712 throw new MWException( 'This content model is not supported: ' . $content->getModel() );
2713 }
2714
2715 return $content->serialize( $this->contentFormat );
2716 }
2717
2718 /**
2719 * Turns the given text into a Content object by unserializing it.
2720 *
2721 * If the resulting Content object is not of a type that can be edited using
2722 * the text base EditPage, an exception will be raised. Set
2723 * $this->allowNonTextContent to true to allow editing of non-textual
2724 * content.
2725 *
2726 * @param string|null|bool $text Text to unserialize
2727 * @return Content|bool|null The content object created from $text. If $text was false
2728 * or null, then false or null will be returned instead.
2729 *
2730 * @throws MWException If unserializing the text results in a Content
2731 * object that is not an instance of TextContent and
2732 * $this->allowNonTextContent is not true.
2733 */
2734 protected function toEditContent( $text ) {
2735 if ( $text === false || $text === null ) {
2736 return $text;
2737 }
2738
2739 $content = ContentHandler::makeContent( $text, $this->getTitle(),
2740 $this->contentModel, $this->contentFormat );
2741
2742 if ( !$this->isSupportedContentModel( $content->getModel() ) ) {
2743 throw new MWException( 'This content model is not supported: ' . $content->getModel() );
2744 }
2745
2746 return $content;
2747 }
2748
2749 /**
2750 * Send the edit form and related headers to OutputPage
2751 * @param callable|null $formCallback That takes an OutputPage parameter; will be called
2752 * during form output near the top, for captchas and the like.
2753 *
2754 * The $formCallback parameter is deprecated since MediaWiki 1.25. Please
2755 * use the EditPage::showEditForm:fields hook instead.
2756 */
2757 public function showEditForm( $formCallback = null ) {
2758 # need to parse the preview early so that we know which templates are used,
2759 # otherwise users with "show preview after edit box" will get a blank list
2760 # we parse this near the beginning so that setHeaders can do the title
2761 # setting work instead of leaving it in getPreviewText
2762 $previewOutput = '';
2763 if ( $this->formtype == 'preview' ) {
2764 $previewOutput = $this->getPreviewText();
2765 }
2766
2767 $out = $this->context->getOutput();
2768
2769 // Avoid PHP 7.1 warning of passing $this by reference
2770 $editPage = $this;
2771 Hooks::run( 'EditPage::showEditForm:initial', [ &$editPage, &$out ] );
2772
2773 $this->setHeaders();
2774
2775 $this->addTalkPageText();
2776 $this->addEditNotices();
2777
2778 if ( !$this->isConflict &&
2779 $this->section != '' &&
2780 !$this->isSectionEditSupported() ) {
2781 // We use $this->section to much before this and getVal('wgSection') directly in other places
2782 // at this point we can't reset $this->section to '' to fallback to non-section editing.
2783 // Someone is welcome to try refactoring though
2784 $out->showErrorPage( 'sectioneditnotsupported-title', 'sectioneditnotsupported-text' );
2785 return;
2786 }
2787
2788 $this->showHeader();
2789
2790 $out->addHTML( $this->editFormPageTop );
2791
2792 $user = $this->context->getUser();
2793 if ( $user->getOption( 'previewontop' ) ) {
2794 $this->displayPreviewArea( $previewOutput, true );
2795 }
2796
2797 $out->addHTML( $this->editFormTextTop );
2798
2799 if ( $this->wasDeletedSinceLastEdit() && $this->formtype !== 'save' ) {
2800 $out->wrapWikiMsg( "<div class='error mw-deleted-while-editing'>\n$1\n</div>",
2801 'deletedwhileediting' );
2802 }
2803
2804 // @todo add EditForm plugin interface and use it here!
2805 // search for textarea1 and textarea2, and allow EditForm to override all uses.
2806 $out->addHTML( Html::openElement(
2807 'form',
2808 [
2809 'class' => 'mw-editform',
2810 'id' => self::EDITFORM_ID,
2811 'name' => self::EDITFORM_ID,
2812 'method' => 'post',
2813 'action' => $this->getActionURL( $this->getContextTitle() ),
2814 'enctype' => 'multipart/form-data'
2815 ]
2816 ) );
2817
2818 if ( is_callable( $formCallback ) ) {
2819 wfWarn( 'The $formCallback parameter to ' . __METHOD__ . 'is deprecated' );
2820 call_user_func_array( $formCallback, [ &$out ] );
2821 }
2822
2823 // Add a check for Unicode support
2824 $out->addHTML( Html::hidden( 'wpUnicodeCheck', self::UNICODE_CHECK ) );
2825
2826 // Add an empty field to trip up spambots
2827 $out->addHTML(
2828 Xml::openElement( 'div', [ 'id' => 'antispam-container', 'style' => 'display: none;' ] )
2829 . Html::rawElement(
2830 'label',
2831 [ 'for' => 'wpAntispam' ],
2832 $this->context->msg( 'simpleantispam-label' )->parse()
2833 )
2834 . Xml::element(
2835 'input',
2836 [
2837 'type' => 'text',
2838 'name' => 'wpAntispam',
2839 'id' => 'wpAntispam',
2840 'value' => ''
2841 ]
2842 )
2843 . Xml::closeElement( 'div' )
2844 );
2845
2846 // Avoid PHP 7.1 warning of passing $this by reference
2847 $editPage = $this;
2848 Hooks::run( 'EditPage::showEditForm:fields', [ &$editPage, &$out ] );
2849
2850 // Put these up at the top to ensure they aren't lost on early form submission
2851 $this->showFormBeforeText();
2852
2853 if ( $this->wasDeletedSinceLastEdit() && $this->formtype == 'save' ) {
2854 $username = $this->lastDelete->user_name;
2855 $comment = CommentStore::getStore()
2856 ->getComment( 'log_comment', $this->lastDelete )->text;
2857
2858 // It is better to not parse the comment at all than to have templates expanded in the middle
2859 // TODO: can the checkLabel be moved outside of the div so that wrapWikiMsg could be used?
2860 $key = $comment === ''
2861 ? 'confirmrecreate-noreason'
2862 : 'confirmrecreate';
2863 $out->addHTML(
2864 '<div class="mw-confirm-recreate">' .
2865 $this->context->msg( $key, $username, "<nowiki>$comment</nowiki>" )->parse() .
2866 Xml::checkLabel( $this->context->msg( 'recreate' )->text(), 'wpRecreate', 'wpRecreate', false,
2867 [ 'title' => Linker::titleAttrib( 'recreate' ), 'tabindex' => 1, 'id' => 'wpRecreate' ]
2868 ) .
2869 '</div>'
2870 );
2871 }
2872
2873 # When the summary is hidden, also hide them on preview/show changes
2874 if ( $this->nosummary ) {
2875 $out->addHTML( Html::hidden( 'nosummary', true ) );
2876 }
2877
2878 # If a blank edit summary was previously provided, and the appropriate
2879 # user preference is active, pass a hidden tag as wpIgnoreBlankSummary. This will stop the
2880 # user being bounced back more than once in the event that a summary
2881 # is not required.
2882 # ####
2883 # For a bit more sophisticated detection of blank summaries, hash the
2884 # automatic one and pass that in the hidden field wpAutoSummary.
2885 if ( $this->missingSummary || ( $this->section == 'new' && $this->nosummary ) ) {
2886 $out->addHTML( Html::hidden( 'wpIgnoreBlankSummary', true ) );
2887 }
2888
2889 if ( $this->undidRev ) {
2890 $out->addHTML( Html::hidden( 'wpUndidRevision', $this->undidRev ) );
2891 }
2892
2893 if ( $this->selfRedirect ) {
2894 $out->addHTML( Html::hidden( 'wpIgnoreSelfRedirect', true ) );
2895 }
2896
2897 if ( $this->hasPresetSummary ) {
2898 // If a summary has been preset using &summary= we don't want to prompt for
2899 // a different summary. Only prompt for a summary if the summary is blanked.
2900 // (T19416)
2901 $this->autoSumm = md5( '' );
2902 }
2903
2904 $autosumm = $this->autoSumm !== '' ? $this->autoSumm : md5( $this->summary );
2905 $out->addHTML( Html::hidden( 'wpAutoSummary', $autosumm ) );
2906
2907 $out->addHTML( Html::hidden( 'oldid', $this->oldid ) );
2908 $out->addHTML( Html::hidden( 'parentRevId', $this->getParentRevId() ) );
2909
2910 $out->addHTML( Html::hidden( 'format', $this->contentFormat ) );
2911 $out->addHTML( Html::hidden( 'model', $this->contentModel ) );
2912
2913 $out->enableOOUI();
2914
2915 if ( $this->section == 'new' ) {
2916 $this->showSummaryInput( true, $this->summary );
2917 $out->addHTML( $this->getSummaryPreview( true, $this->summary ) );
2918 }
2919
2920 $out->addHTML( $this->editFormTextBeforeContent );
2921 if ( $this->isConflict ) {
2922 // In an edit conflict, we turn textbox2 into the user's text,
2923 // and textbox1 into the stored version
2924 $this->textbox2 = $this->textbox1;
2925
2926 $content = $this->getCurrentContent();
2927 $this->textbox1 = $this->toEditText( $content );
2928
2929 $editConflictHelper = $this->getEditConflictHelper();
2930 $editConflictHelper->setTextboxes( $this->textbox2, $this->textbox1 );
2931 $editConflictHelper->setContentModel( $this->contentModel );
2932 $editConflictHelper->setContentFormat( $this->contentFormat );
2933 $out->addHTML( $editConflictHelper->getEditFormHtmlBeforeContent() );
2934 }
2935
2936 if ( !$this->mTitle->isUserConfigPage() ) {
2937 $out->addHTML( self::getEditToolbar( $this->mTitle ) );
2938 }
2939
2940 if ( $this->blankArticle ) {
2941 $out->addHTML( Html::hidden( 'wpIgnoreBlankArticle', true ) );
2942 }
2943
2944 if ( $this->isConflict ) {
2945 // In an edit conflict bypass the overridable content form method
2946 // and fallback to the raw wpTextbox1 since editconflicts can't be
2947 // resolved between page source edits and custom ui edits using the
2948 // custom edit ui.
2949 $conflictTextBoxAttribs = [];
2950 if ( $this->wasDeletedSinceLastEdit() ) {
2951 $conflictTextBoxAttribs['style'] = 'display:none;';
2952 } elseif ( $this->isOldRev ) {
2953 $conflictTextBoxAttribs['class'] = 'mw-textarea-oldrev';
2954 }
2955
2956 $out->addHTML( $editConflictHelper->getEditConflictMainTextBox( $conflictTextBoxAttribs ) );
2957 $out->addHTML( $editConflictHelper->getEditFormHtmlAfterContent() );
2958 } else {
2959 $this->showContentForm();
2960 }
2961
2962 $out->addHTML( $this->editFormTextAfterContent );
2963
2964 $this->showStandardInputs();
2965
2966 $this->showFormAfterText();
2967
2968 $this->showTosSummary();
2969
2970 $this->showEditTools();
2971
2972 $out->addHTML( $this->editFormTextAfterTools . "\n" );
2973
2974 $out->addHTML( $this->makeTemplatesOnThisPageList( $this->getTemplates() ) );
2975
2976 $out->addHTML( Html::rawElement( 'div', [ 'class' => 'hiddencats' ],
2977 Linker::formatHiddenCategories( $this->page->getHiddenCategories() ) ) );
2978
2979 $out->addHTML( Html::rawElement( 'div', [ 'class' => 'limitreport' ],
2980 self::getPreviewLimitReport( $this->mParserOutput ) ) );
2981
2982 $out->addModules( 'mediawiki.action.edit.collapsibleFooter' );
2983
2984 if ( $this->isConflict ) {
2985 try {
2986 $this->showConflict();
2987 } catch ( MWContentSerializationException $ex ) {
2988 // this can't really happen, but be nice if it does.
2989 $msg = $this->context->msg(
2990 'content-failed-to-parse',
2991 $this->contentModel,
2992 $this->contentFormat,
2993 $ex->getMessage()
2994 );
2995 $out->wrapWikiTextAsInterface( 'error', $msg->plain() );
2996 }
2997 }
2998
2999 // Set a hidden field so JS knows what edit form mode we are in
3000 if ( $this->isConflict ) {
3001 $mode = 'conflict';
3002 } elseif ( $this->preview ) {
3003 $mode = 'preview';
3004 } elseif ( $this->diff ) {
3005 $mode = 'diff';
3006 } else {
3007 $mode = 'text';
3008 }
3009 $out->addHTML( Html::hidden( 'mode', $mode, [ 'id' => 'mw-edit-mode' ] ) );
3010
3011 // Marker for detecting truncated form data. This must be the last
3012 // parameter sent in order to be of use, so do not move me.
3013 $out->addHTML( Html::hidden( 'wpUltimateParam', true ) );
3014 $out->addHTML( $this->editFormTextBottom . "\n</form>\n" );
3015
3016 if ( !$user->getOption( 'previewontop' ) ) {
3017 $this->displayPreviewArea( $previewOutput, false );
3018 }
3019 }
3020
3021 /**
3022 * Wrapper around TemplatesOnThisPageFormatter to make
3023 * a "templates on this page" list.
3024 *
3025 * @param Title[] $templates
3026 * @return string HTML
3027 */
3028 public function makeTemplatesOnThisPageList( array $templates ) {
3029 $templateListFormatter = new TemplatesOnThisPageFormatter(
3030 $this->context, MediaWikiServices::getInstance()->getLinkRenderer()
3031 );
3032
3033 // preview if preview, else section if section, else false
3034 $type = false;
3035 if ( $this->preview ) {
3036 $type = 'preview';
3037 } elseif ( $this->section != '' ) {
3038 $type = 'section';
3039 }
3040
3041 return Html::rawElement( 'div', [ 'class' => 'templatesUsed' ],
3042 $templateListFormatter->format( $templates, $type )
3043 );
3044 }
3045
3046 /**
3047 * Extract the section title from current section text, if any.
3048 *
3049 * @param string $text
3050 * @return string|bool String or false
3051 */
3052 public static function extractSectionTitle( $text ) {
3053 preg_match( "/^(=+)(.+)\\1\\s*(\n|$)/i", $text, $matches );
3054 if ( !empty( $matches[2] ) ) {
3055 return MediaWikiServices::getInstance()->getParser()
3056 ->stripSectionName( trim( $matches[2] ) );
3057 } else {
3058 return false;
3059 }
3060 }
3061
3062 protected function showHeader() {
3063 $out = $this->context->getOutput();
3064 $user = $this->context->getUser();
3065 if ( $this->isConflict ) {
3066 $this->addExplainConflictHeader( $out );
3067 $this->editRevId = $this->page->getLatest();
3068 } else {
3069 if ( $this->section != '' && $this->section != 'new' && !$this->summary &&
3070 !$this->preview && !$this->diff
3071 ) {
3072 $sectionTitle = self::extractSectionTitle( $this->textbox1 ); // FIXME: use Content object
3073 if ( $sectionTitle !== false ) {
3074 $this->summary = "/* $sectionTitle */ ";
3075 }
3076 }
3077
3078 $buttonLabel = $this->context->msg( $this->getSubmitButtonLabel() )->text();
3079
3080 if ( $this->missingComment ) {
3081 $out->wrapWikiMsg( "<div id='mw-missingcommenttext'>\n$1\n</div>", 'missingcommenttext' );
3082 }
3083
3084 if ( $this->missingSummary && $this->section != 'new' ) {
3085 $out->wrapWikiMsg(
3086 "<div id='mw-missingsummary'>\n$1\n</div>",
3087 [ 'missingsummary', $buttonLabel ]
3088 );
3089 }
3090
3091 if ( $this->missingSummary && $this->section == 'new' ) {
3092 $out->wrapWikiMsg(
3093 "<div id='mw-missingcommentheader'>\n$1\n</div>",
3094 [ 'missingcommentheader', $buttonLabel ]
3095 );
3096 }
3097
3098 if ( $this->blankArticle ) {
3099 $out->wrapWikiMsg(
3100 "<div id='mw-blankarticle'>\n$1\n</div>",
3101 [ 'blankarticle', $buttonLabel ]
3102 );
3103 }
3104
3105 if ( $this->selfRedirect ) {
3106 $out->wrapWikiMsg(
3107 "<div id='mw-selfredirect'>\n$1\n</div>",
3108 [ 'selfredirect', $buttonLabel ]
3109 );
3110 }
3111
3112 if ( $this->hookError !== '' ) {
3113 $out->addWikiTextAsInterface( $this->hookError );
3114 }
3115
3116 if ( $this->section != 'new' ) {
3117 $revision = $this->mArticle->getRevisionFetched();
3118 if ( $revision ) {
3119 // Let sysop know that this will make private content public if saved
3120
3121 if ( !$revision->userCan( Revision::DELETED_TEXT, $user ) ) {
3122 $out->wrapWikiMsg(
3123 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
3124 'rev-deleted-text-permission'
3125 );
3126 } elseif ( $revision->isDeleted( Revision::DELETED_TEXT ) ) {
3127 $out->wrapWikiMsg(
3128 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
3129 'rev-deleted-text-view'
3130 );
3131 }
3132
3133 if ( !$revision->isCurrent() ) {
3134 $this->mArticle->setOldSubtitle( $revision->getId() );
3135 $out->wrapWikiMsg(
3136 Html::warningBox( "\n$1\n" ),
3137 'editingold'
3138 );
3139 $this->isOldRev = true;
3140 }
3141 } elseif ( $this->mTitle->exists() ) {
3142 // Something went wrong
3143
3144 $out->wrapWikiMsg( "<div class='errorbox'>\n$1\n</div>\n",
3145 [ 'missing-revision', $this->oldid ] );
3146 }
3147 }
3148 }
3149
3150 if ( wfReadOnly() ) {
3151 $out->wrapWikiMsg(
3152 "<div id=\"mw-read-only-warning\">\n$1\n</div>",
3153 [ 'readonlywarning', wfReadOnlyReason() ]
3154 );
3155 } elseif ( $user->isAnon() ) {
3156 if ( $this->formtype != 'preview' ) {
3157 $returntoquery = array_diff_key(
3158 $this->context->getRequest()->getValues(),
3159 [ 'title' => true, 'returnto' => true, 'returntoquery' => true ]
3160 );
3161 $out->wrapWikiMsg(
3162 "<div id='mw-anon-edit-warning' class='warningbox'>\n$1\n</div>",
3163 [ 'anoneditwarning',
3164 // Log-in link
3165 SpecialPage::getTitleFor( 'Userlogin' )->getFullURL( [
3166 'returnto' => $this->getTitle()->getPrefixedDBkey(),
3167 'returntoquery' => wfArrayToCgi( $returntoquery ),
3168 ] ),
3169 // Sign-up link
3170 SpecialPage::getTitleFor( 'CreateAccount' )->getFullURL( [
3171 'returnto' => $this->getTitle()->getPrefixedDBkey(),
3172 'returntoquery' => wfArrayToCgi( $returntoquery ),
3173 ] )
3174 ]
3175 );
3176 } else {
3177 $out->wrapWikiMsg( "<div id=\"mw-anon-preview-warning\" class=\"warningbox\">\n$1</div>",
3178 'anonpreviewwarning'
3179 );
3180 }
3181 } elseif ( $this->mTitle->isUserConfigPage() ) {
3182 # Check the skin exists
3183 if ( $this->isWrongCaseUserConfigPage() ) {
3184 $out->wrapWikiMsg(
3185 "<div class='error' id='mw-userinvalidconfigtitle'>\n$1\n</div>",
3186 [ 'userinvalidconfigtitle', $this->mTitle->getSkinFromConfigSubpage() ]
3187 );
3188 }
3189 if ( $this->getTitle()->isSubpageOf( $user->getUserPage() ) ) {
3190 $isUserCssConfig = $this->mTitle->isUserCssConfigPage();
3191 $isUserJsonConfig = $this->mTitle->isUserJsonConfigPage();
3192 $isUserJsConfig = $this->mTitle->isUserJsConfigPage();
3193
3194 $warning = $isUserCssConfig
3195 ? 'usercssispublic'
3196 : ( $isUserJsonConfig ? 'userjsonispublic' : 'userjsispublic' );
3197
3198 $out->wrapWikiMsg( '<div class="mw-userconfigpublic">$1</div>', $warning );
3199
3200 if ( $this->formtype !== 'preview' ) {
3201 $config = $this->context->getConfig();
3202 if ( $isUserCssConfig && $config->get( 'AllowUserCss' ) ) {
3203 $out->wrapWikiMsg(
3204 "<div id='mw-usercssyoucanpreview'>\n$1\n</div>",
3205 [ 'usercssyoucanpreview' ]
3206 );
3207 } elseif ( $isUserJsonConfig /* No comparable 'AllowUserJson' */ ) {
3208 $out->wrapWikiMsg(
3209 "<div id='mw-userjsonyoucanpreview'>\n$1\n</div>",
3210 [ 'userjsonyoucanpreview' ]
3211 );
3212 } elseif ( $isUserJsConfig && $config->get( 'AllowUserJs' ) ) {
3213 $out->wrapWikiMsg(
3214 "<div id='mw-userjsyoucanpreview'>\n$1\n</div>",
3215 [ 'userjsyoucanpreview' ]
3216 );
3217 }
3218 }
3219 }
3220 }
3221
3222 $this->addPageProtectionWarningHeaders();
3223
3224 $this->addLongPageWarningHeader();
3225
3226 # Add header copyright warning
3227 $this->showHeaderCopyrightWarning();
3228 }
3229
3230 /**
3231 * Helper function for summary input functions, which returns the necessary
3232 * attributes for the input.
3233 *
3234 * @param array|null $inputAttrs Array of attrs to use on the input
3235 * @return array
3236 */
3237 private function getSummaryInputAttributes( array $inputAttrs = null ) {
3238 // HTML maxlength uses "UTF-16 code units", which means that characters outside BMP
3239 // (e.g. emojis) count for two each. This limit is overridden in JS to instead count
3240 // Unicode codepoints.
3241 return ( is_array( $inputAttrs ) ? $inputAttrs : [] ) + [
3242 'id' => 'wpSummary',
3243 'name' => 'wpSummary',
3244 'maxlength' => CommentStore::COMMENT_CHARACTER_LIMIT,
3245 'tabindex' => 1,
3246 'size' => 60,
3247 'spellcheck' => 'true',
3248 ];
3249 }
3250
3251 /**
3252 * Builds a standard summary input with a label.
3253 *
3254 * @param string $summary The value of the summary input
3255 * @param string|null $labelText The html to place inside the label
3256 * @param array|null $inputAttrs Array of attrs to use on the input
3257 *
3258 * @return OOUI\FieldLayout OOUI FieldLayout with Label and Input
3259 */
3260 function getSummaryInputWidget( $summary = "", $labelText = null, $inputAttrs = null ) {
3261 $inputAttrs = OOUI\Element::configFromHtmlAttributes(
3262 $this->getSummaryInputAttributes( $inputAttrs )
3263 );
3264 $inputAttrs += [
3265 'title' => Linker::titleAttrib( 'summary' ),
3266 'accessKey' => Linker::accesskey( 'summary' ),
3267 ];
3268
3269 // For compatibility with old scripts and extensions, we want the legacy 'id' on the `<input>`
3270 $inputAttrs['inputId'] = $inputAttrs['id'];
3271 $inputAttrs['id'] = 'wpSummaryWidget';
3272
3273 return new OOUI\FieldLayout(
3274 new OOUI\TextInputWidget( [
3275 'value' => $summary,
3276 'infusable' => true,
3277 ] + $inputAttrs ),
3278 [
3279 'label' => new OOUI\HtmlSnippet( $labelText ),
3280 'align' => 'top',
3281 'id' => 'wpSummaryLabel',
3282 'classes' => [ $this->missingSummary ? 'mw-summarymissed' : 'mw-summary' ],
3283 ]
3284 );
3285 }
3286
3287 /**
3288 * @param bool $isSubjectPreview True if this is the section subject/title
3289 * up top, or false if this is the comment summary
3290 * down below the textarea
3291 * @param string $summary The text of the summary to display
3292 */
3293 protected function showSummaryInput( $isSubjectPreview, $summary = "" ) {
3294 # Add a class if 'missingsummary' is triggered to allow styling of the summary line
3295 $summaryClass = $this->missingSummary ? 'mw-summarymissed' : 'mw-summary';
3296 if ( $isSubjectPreview ) {
3297 if ( $this->nosummary ) {
3298 return;
3299 }
3300 } elseif ( !$this->mShowSummaryField ) {
3301 return;
3302 }
3303
3304 $labelText = $this->context->msg( $isSubjectPreview ? 'subject' : 'summary' )->parse();
3305 $this->context->getOutput()->addHTML( $this->getSummaryInputWidget(
3306 $summary,
3307 $labelText,
3308 [ 'class' => $summaryClass ]
3309 ) );
3310 }
3311
3312 /**
3313 * @param bool $isSubjectPreview True if this is the section subject/title
3314 * up top, or false if this is the comment summary
3315 * down below the textarea
3316 * @param string $summary The text of the summary to display
3317 * @return string
3318 */
3319 protected function getSummaryPreview( $isSubjectPreview, $summary = "" ) {
3320 // avoid spaces in preview, gets always trimmed on save
3321 $summary = trim( $summary );
3322 if ( !$summary || ( !$this->preview && !$this->diff ) ) {
3323 return "";
3324 }
3325
3326 if ( $isSubjectPreview ) {
3327 $summary = $this->context->msg( 'newsectionsummary' )
3328 ->rawParams( MediaWikiServices::getInstance()->getParser()
3329 ->stripSectionName( $summary ) )
3330 ->inContentLanguage()->text();
3331 }
3332
3333 $message = $isSubjectPreview ? 'subject-preview' : 'summary-preview';
3334
3335 $summary = $this->context->msg( $message )->parse()
3336 . Linker::commentBlock( $summary, $this->mTitle, $isSubjectPreview );
3337 return Xml::tags( 'div', [ 'class' => 'mw-summary-preview' ], $summary );
3338 }
3339
3340 protected function showFormBeforeText() {
3341 $out = $this->context->getOutput();
3342 $out->addHTML( Html::hidden( 'wpSection', $this->section ) );
3343 $out->addHTML( Html::hidden( 'wpStarttime', $this->starttime ) );
3344 $out->addHTML( Html::hidden( 'wpEdittime', $this->edittime ) );
3345 $out->addHTML( Html::hidden( 'editRevId', $this->editRevId ) );
3346 $out->addHTML( Html::hidden( 'wpScrolltop', $this->scrolltop, [ 'id' => 'wpScrolltop' ] ) );
3347 }
3348
3349 protected function showFormAfterText() {
3350 /**
3351 * To make it harder for someone to slip a user a page
3352 * which submits an edit form to the wiki without their
3353 * knowledge, a random token is associated with the login
3354 * session. If it's not passed back with the submission,
3355 * we won't save the page, or render user JavaScript and
3356 * CSS previews.
3357 *
3358 * For anon editors, who may not have a session, we just
3359 * include the constant suffix to prevent editing from
3360 * broken text-mangling proxies.
3361 */
3362 $this->context->getOutput()->addHTML(
3363 "\n" .
3364 Html::hidden( "wpEditToken", $this->context->getUser()->getEditToken() ) .
3365 "\n"
3366 );
3367 }
3368
3369 /**
3370 * Subpage overridable method for printing the form for page content editing
3371 * By default this simply outputs wpTextbox1
3372 * Subclasses can override this to provide a custom UI for editing;
3373 * be it a form, or simply wpTextbox1 with a modified content that will be
3374 * reverse modified when extracted from the post data.
3375 * Note that this is basically the inverse for importContentFormData
3376 */
3377 protected function showContentForm() {
3378 $this->showTextbox1();
3379 }
3380
3381 /**
3382 * Method to output wpTextbox1
3383 * The $textoverride method can be used by subclasses overriding showContentForm
3384 * to pass back to this method.
3385 *
3386 * @param array|null $customAttribs Array of html attributes to use in the textarea
3387 * @param string|null $textoverride Optional text to override $this->textarea1 with
3388 */
3389 protected function showTextbox1( $customAttribs = null, $textoverride = null ) {
3390 if ( $this->wasDeletedSinceLastEdit() && $this->formtype == 'save' ) {
3391 $attribs = [ 'style' => 'display:none;' ];
3392 } else {
3393 $builder = new TextboxBuilder();
3394 $classes = $builder->getTextboxProtectionCSSClasses( $this->getTitle() );
3395
3396 # Is an old revision being edited?
3397 if ( $this->isOldRev ) {
3398 $classes[] = 'mw-textarea-oldrev';
3399 }
3400
3401 $attribs = [ 'tabindex' => 1 ];
3402
3403 if ( is_array( $customAttribs ) ) {
3404 $attribs += $customAttribs;
3405 }
3406
3407 $attribs = $builder->mergeClassesIntoAttributes( $classes, $attribs );
3408 }
3409
3410 $this->showTextbox(
3411 $textoverride ?? $this->textbox1,
3412 'wpTextbox1',
3413 $attribs
3414 );
3415 }
3416
3417 protected function showTextbox2() {
3418 $this->showTextbox( $this->textbox2, 'wpTextbox2', [ 'tabindex' => 6, 'readonly' ] );
3419 }
3420
3421 protected function showTextbox( $text, $name, $customAttribs = [] ) {
3422 $builder = new TextboxBuilder();
3423 $attribs = $builder->buildTextboxAttribs(
3424 $name,
3425 $customAttribs,
3426 $this->context->getUser(),
3427 $this->mTitle
3428 );
3429
3430 $this->context->getOutput()->addHTML(
3431 Html::textarea( $name, $builder->addNewLineAtEnd( $text ), $attribs )
3432 );
3433 }
3434
3435 protected function displayPreviewArea( $previewOutput, $isOnTop = false ) {
3436 $classes = [];
3437 if ( $isOnTop ) {
3438 $classes[] = 'ontop';
3439 }
3440
3441 $attribs = [ 'id' => 'wikiPreview', 'class' => implode( ' ', $classes ) ];
3442
3443 if ( $this->formtype != 'preview' ) {
3444 $attribs['style'] = 'display: none;';
3445 }
3446
3447 $out = $this->context->getOutput();
3448 $out->addHTML( Xml::openElement( 'div', $attribs ) );
3449
3450 if ( $this->formtype == 'preview' ) {
3451 $this->showPreview( $previewOutput );
3452 } else {
3453 // Empty content container for LivePreview
3454 $pageViewLang = $this->mTitle->getPageViewLanguage();
3455 $attribs = [ 'lang' => $pageViewLang->getHtmlCode(), 'dir' => $pageViewLang->getDir(),
3456 'class' => 'mw-content-' . $pageViewLang->getDir() ];
3457 $out->addHTML( Html::rawElement( 'div', $attribs ) );
3458 }
3459
3460 $out->addHTML( '</div>' );
3461
3462 if ( $this->formtype == 'diff' ) {
3463 try {
3464 $this->showDiff();
3465 } catch ( MWContentSerializationException $ex ) {
3466 $msg = $this->context->msg(
3467 'content-failed-to-parse',
3468 $this->contentModel,
3469 $this->contentFormat,
3470 $ex->getMessage()
3471 );
3472 $out->wrapWikiTextAsInterface( 'error', $msg->plain() );
3473 }
3474 }
3475 }
3476
3477 /**
3478 * Append preview output to OutputPage.
3479 * Includes category rendering if this is a category page.
3480 *
3481 * @param string $text The HTML to be output for the preview.
3482 */
3483 protected function showPreview( $text ) {
3484 if ( $this->mArticle instanceof CategoryPage ) {
3485 $this->mArticle->openShowCategory();
3486 }
3487 # This hook seems slightly odd here, but makes things more
3488 # consistent for extensions.
3489 $out = $this->context->getOutput();
3490 Hooks::run( 'OutputPageBeforeHTML', [ &$out, &$text ] );
3491 $out->addHTML( $text );
3492 if ( $this->mArticle instanceof CategoryPage ) {
3493 $this->mArticle->closeShowCategory();
3494 }
3495 }
3496
3497 /**
3498 * Get a diff between the current contents of the edit box and the
3499 * version of the page we're editing from.
3500 *
3501 * If this is a section edit, we'll replace the section as for final
3502 * save and then make a comparison.
3503 */
3504 public function showDiff() {
3505 $oldtitlemsg = 'currentrev';
3506 # if message does not exist, show diff against the preloaded default
3507 if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI && !$this->mTitle->exists() ) {
3508 $oldtext = $this->mTitle->getDefaultMessageText();
3509 if ( $oldtext !== false ) {
3510 $oldtitlemsg = 'defaultmessagetext';
3511 $oldContent = $this->toEditContent( $oldtext );
3512 } else {
3513 $oldContent = null;
3514 }
3515 } else {
3516 $oldContent = $this->getCurrentContent();
3517 }
3518
3519 $textboxContent = $this->toEditContent( $this->textbox1 );
3520 if ( $this->editRevId !== null ) {
3521 $newContent = $this->page->replaceSectionAtRev(
3522 $this->section, $textboxContent, $this->summary, $this->editRevId
3523 );
3524 } else {
3525 $newContent = $this->page->replaceSectionContent(
3526 $this->section, $textboxContent, $this->summary, $this->edittime
3527 );
3528 }
3529
3530 if ( $newContent ) {
3531 Hooks::run( 'EditPageGetDiffContent', [ $this, &$newContent ] );
3532
3533 $user = $this->context->getUser();
3534 $popts = ParserOptions::newFromUserAndLang( $user,
3535 MediaWikiServices::getInstance()->getContentLanguage() );
3536 $newContent = $newContent->preSaveTransform( $this->mTitle, $user, $popts );
3537 }
3538
3539 if ( ( $oldContent && !$oldContent->isEmpty() ) || ( $newContent && !$newContent->isEmpty() ) ) {
3540 $oldtitle = $this->context->msg( $oldtitlemsg )->parse();
3541 $newtitle = $this->context->msg( 'yourtext' )->parse();
3542
3543 if ( !$oldContent ) {
3544 $oldContent = $newContent->getContentHandler()->makeEmptyContent();
3545 }
3546
3547 if ( !$newContent ) {
3548 $newContent = $oldContent->getContentHandler()->makeEmptyContent();
3549 }
3550
3551 $de = $oldContent->getContentHandler()->createDifferenceEngine( $this->context );
3552 $de->setContent( $oldContent, $newContent );
3553
3554 $difftext = $de->getDiff( $oldtitle, $newtitle );
3555 $de->showDiffStyle();
3556 } else {
3557 $difftext = '';
3558 }
3559
3560 $this->context->getOutput()->addHTML( '<div id="wikiDiff">' . $difftext . '</div>' );
3561 }
3562
3563 /**
3564 * Show the header copyright warning.
3565 */
3566 protected function showHeaderCopyrightWarning() {
3567 $msg = 'editpage-head-copy-warn';
3568 if ( !$this->context->msg( $msg )->isDisabled() ) {
3569 $this->context->getOutput()->wrapWikiMsg( "<div class='editpage-head-copywarn'>\n$1\n</div>",
3570 'editpage-head-copy-warn' );
3571 }
3572 }
3573
3574 /**
3575 * Give a chance for site and per-namespace customizations of
3576 * terms of service summary link that might exist separately
3577 * from the copyright notice.
3578 *
3579 * This will display between the save button and the edit tools,
3580 * so should remain short!
3581 */
3582 protected function showTosSummary() {
3583 $msg = 'editpage-tos-summary';
3584 Hooks::run( 'EditPageTosSummary', [ $this->mTitle, &$msg ] );
3585 if ( !$this->context->msg( $msg )->isDisabled() ) {
3586 $out = $this->context->getOutput();
3587 $out->addHTML( '<div class="mw-tos-summary">' );
3588 $out->addWikiMsg( $msg );
3589 $out->addHTML( '</div>' );
3590 }
3591 }
3592
3593 /**
3594 * Inserts optional text shown below edit and upload forms. Can be used to offer special
3595 * characters not present on most keyboards for copying/pasting.
3596 */
3597 protected function showEditTools() {
3598 $this->context->getOutput()->addHTML( '<div class="mw-editTools">' .
3599 $this->context->msg( 'edittools' )->inContentLanguage()->parse() .
3600 '</div>' );
3601 }
3602
3603 /**
3604 * Get the copyright warning
3605 *
3606 * Renamed to getCopyrightWarning(), old name kept around for backwards compatibility
3607 * @return string
3608 */
3609 protected function getCopywarn() {
3610 return self::getCopyrightWarning( $this->mTitle );
3611 }
3612
3613 /**
3614 * Get the copyright warning, by default returns wikitext
3615 *
3616 * @param Title $title
3617 * @param string $format Output format, valid values are any function of a Message object
3618 * @param Language|string|null $langcode Language code or Language object.
3619 * @return string
3620 */
3621 public static function getCopyrightWarning( $title, $format = 'plain', $langcode = null ) {
3622 global $wgRightsText;
3623 if ( $wgRightsText ) {
3624 $copywarnMsg = [ 'copyrightwarning',
3625 '[[' . wfMessage( 'copyrightpage' )->inContentLanguage()->text() . ']]',
3626 $wgRightsText ];
3627 } else {
3628 $copywarnMsg = [ 'copyrightwarning2',
3629 '[[' . wfMessage( 'copyrightpage' )->inContentLanguage()->text() . ']]' ];
3630 }
3631 // Allow for site and per-namespace customization of contribution/copyright notice.
3632 Hooks::run( 'EditPageCopyrightWarning', [ $title, &$copywarnMsg ] );
3633
3634 $msg = wfMessage( ...$copywarnMsg )->title( $title );
3635 if ( $langcode ) {
3636 $msg->inLanguage( $langcode );
3637 }
3638 return "<div id=\"editpage-copywarn\">\n" .
3639 $msg->$format() . "\n</div>";
3640 }
3641
3642 /**
3643 * Get the Limit report for page previews
3644 *
3645 * @since 1.22
3646 * @param ParserOutput|null $output ParserOutput object from the parse
3647 * @return string HTML
3648 */
3649 public static function getPreviewLimitReport( ParserOutput $output = null ) {
3650 global $wgLang;
3651
3652 if ( !$output || !$output->getLimitReportData() ) {
3653 return '';
3654 }
3655
3656 $limitReport = Html::rawElement( 'div', [ 'class' => 'mw-limitReportExplanation' ],
3657 wfMessage( 'limitreport-title' )->parseAsBlock()
3658 );
3659
3660 // Show/hide animation doesn't work correctly on a table, so wrap it in a div.
3661 $limitReport .= Html::openElement( 'div', [ 'class' => 'preview-limit-report-wrapper' ] );
3662
3663 $limitReport .= Html::openElement( 'table', [
3664 'class' => 'preview-limit-report wikitable'
3665 ] ) .
3666 Html::openElement( 'tbody' );
3667
3668 foreach ( $output->getLimitReportData() as $key => $value ) {
3669 if ( Hooks::run( 'ParserLimitReportFormat',
3670 [ $key, &$value, &$limitReport, true, true ]
3671 ) ) {
3672 $keyMsg = wfMessage( $key );
3673 $valueMsg = wfMessage( [ "$key-value-html", "$key-value" ] );
3674 if ( !$valueMsg->exists() ) {
3675 $valueMsg = new RawMessage( '$1' );
3676 }
3677 if ( !$keyMsg->isDisabled() && !$valueMsg->isDisabled() ) {
3678 $limitReport .= Html::openElement( 'tr' ) .
3679 Html::rawElement( 'th', null, $keyMsg->parse() ) .
3680 Html::rawElement( 'td', null,
3681 $wgLang->formatNum( $valueMsg->params( $value )->parse() )
3682 ) .
3683 Html::closeElement( 'tr' );
3684 }
3685 }
3686 }
3687
3688 $limitReport .= Html::closeElement( 'tbody' ) .
3689 Html::closeElement( 'table' ) .
3690 Html::closeElement( 'div' );
3691
3692 return $limitReport;
3693 }
3694
3695 protected function showStandardInputs( &$tabindex = 2 ) {
3696 $out = $this->context->getOutput();
3697 $out->addHTML( "<div class='editOptions'>\n" );
3698
3699 if ( $this->section != 'new' ) {
3700 $this->showSummaryInput( false, $this->summary );
3701 $out->addHTML( $this->getSummaryPreview( false, $this->summary ) );
3702 }
3703
3704 $checkboxes = $this->getCheckboxesWidget(
3705 $tabindex,
3706 [ 'minor' => $this->minoredit, 'watch' => $this->watchthis ]
3707 );
3708 $checkboxesHTML = new OOUI\HorizontalLayout( [ 'items' => $checkboxes ] );
3709
3710 $out->addHTML( "<div class='editCheckboxes'>" . $checkboxesHTML . "</div>\n" );
3711
3712 // Show copyright warning.
3713 $out->addWikiTextAsInterface( $this->getCopywarn() );
3714 $out->addHTML( $this->editFormTextAfterWarn );
3715
3716 $out->addHTML( "<div class='editButtons'>\n" );
3717 $out->addHTML( implode( "\n", $this->getEditButtons( $tabindex ) ) . "\n" );
3718
3719 $cancel = $this->getCancelLink();
3720
3721 $message = $this->context->msg( 'edithelppage' )->inContentLanguage()->text();
3722 $edithelpurl = Skin::makeInternalOrExternalUrl( $message );
3723 $edithelp =
3724 Html::linkButton(
3725 $this->context->msg( 'edithelp' )->text(),
3726 [ 'target' => 'helpwindow', 'href' => $edithelpurl ],
3727 [ 'mw-ui-quiet' ]
3728 ) .
3729 $this->context->msg( 'word-separator' )->escaped() .
3730 $this->context->msg( 'newwindow' )->parse();
3731
3732 $out->addHTML( " <span class='cancelLink'>{$cancel}</span>\n" );
3733 $out->addHTML( " <span class='editHelp'>{$edithelp}</span>\n" );
3734 $out->addHTML( "</div><!-- editButtons -->\n" );
3735
3736 Hooks::run( 'EditPage::showStandardInputs:options', [ $this, $out, &$tabindex ] );
3737
3738 $out->addHTML( "</div><!-- editOptions -->\n" );
3739 }
3740
3741 /**
3742 * Show an edit conflict. textbox1 is already shown in showEditForm().
3743 * If you want to use another entry point to this function, be careful.
3744 */
3745 protected function showConflict() {
3746 $out = $this->context->getOutput();
3747 // Avoid PHP 7.1 warning of passing $this by reference
3748 $editPage = $this;
3749 if ( Hooks::run( 'EditPageBeforeConflictDiff', [ &$editPage, &$out ] ) ) {
3750 $this->incrementConflictStats();
3751
3752 $this->getEditConflictHelper()->showEditFormTextAfterFooters();
3753 }
3754 }
3755
3756 protected function incrementConflictStats() {
3757 $this->getEditConflictHelper()->incrementConflictStats();
3758 }
3759
3760 /**
3761 * @return string
3762 */
3763 public function getCancelLink() {
3764 $cancelParams = [];
3765 if ( !$this->isConflict && $this->oldid > 0 ) {
3766 $cancelParams['oldid'] = $this->oldid;
3767 } elseif ( $this->getContextTitle()->isRedirect() ) {
3768 $cancelParams['redirect'] = 'no';
3769 }
3770
3771 return new OOUI\ButtonWidget( [
3772 'id' => 'mw-editform-cancel',
3773 'href' => $this->getContextTitle()->getLinkURL( $cancelParams ),
3774 'label' => new OOUI\HtmlSnippet( $this->context->msg( 'cancel' )->parse() ),
3775 'framed' => false,
3776 'infusable' => true,
3777 'flags' => 'destructive',
3778 ] );
3779 }
3780
3781 /**
3782 * Returns the URL to use in the form's action attribute.
3783 * This is used by EditPage subclasses when simply customizing the action
3784 * variable in the constructor is not enough. This can be used when the
3785 * EditPage lives inside of a Special page rather than a custom page action.
3786 *
3787 * @param Title $title Title object for which is being edited (where we go to for &action= links)
3788 * @return string
3789 */
3790 protected function getActionURL( Title $title ) {
3791 return $title->getLocalURL( [ 'action' => $this->action ] );
3792 }
3793
3794 /**
3795 * Check if a page was deleted while the user was editing it, before submit.
3796 * Note that we rely on the logging table, which hasn't been always there,
3797 * but that doesn't matter, because this only applies to brand new
3798 * deletes.
3799 * @return bool
3800 */
3801 protected function wasDeletedSinceLastEdit() {
3802 if ( $this->deletedSinceEdit !== null ) {
3803 return $this->deletedSinceEdit;
3804 }
3805
3806 $this->deletedSinceEdit = false;
3807
3808 if ( !$this->mTitle->exists() && $this->mTitle->isDeletedQuick() ) {
3809 $this->lastDelete = $this->getLastDelete();
3810 if ( $this->lastDelete ) {
3811 $deleteTime = wfTimestamp( TS_MW, $this->lastDelete->log_timestamp );
3812 if ( $deleteTime > $this->starttime ) {
3813 $this->deletedSinceEdit = true;
3814 }
3815 }
3816 }
3817
3818 return $this->deletedSinceEdit;
3819 }
3820
3821 /**
3822 * Get the last log record of this page being deleted, if ever. This is
3823 * used to detect whether a delete occurred during editing.
3824 * @return bool|stdClass
3825 */
3826 protected function getLastDelete() {
3827 $dbr = wfGetDB( DB_REPLICA );
3828 $commentQuery = CommentStore::getStore()->getJoin( 'log_comment' );
3829 $actorQuery = ActorMigration::newMigration()->getJoin( 'log_user' );
3830 $data = $dbr->selectRow(
3831 array_merge( [ 'logging' ], $commentQuery['tables'], $actorQuery['tables'], [ 'user' ] ),
3832 [
3833 'log_type',
3834 'log_action',
3835 'log_timestamp',
3836 'log_namespace',
3837 'log_title',
3838 'log_params',
3839 'log_deleted',
3840 'user_name'
3841 ] + $commentQuery['fields'] + $actorQuery['fields'],
3842 [
3843 'log_namespace' => $this->mTitle->getNamespace(),
3844 'log_title' => $this->mTitle->getDBkey(),
3845 'log_type' => 'delete',
3846 'log_action' => 'delete',
3847 ],
3848 __METHOD__,
3849 [ 'LIMIT' => 1, 'ORDER BY' => 'log_timestamp DESC' ],
3850 [
3851 'user' => [ 'JOIN', 'user_id=' . $actorQuery['fields']['log_user'] ],
3852 ] + $commentQuery['joins'] + $actorQuery['joins']
3853 );
3854 // Quick paranoid permission checks...
3855 if ( is_object( $data ) ) {
3856 if ( $data->log_deleted & LogPage::DELETED_USER ) {
3857 $data->user_name = $this->context->msg( 'rev-deleted-user' )->escaped();
3858 }
3859
3860 if ( $data->log_deleted & LogPage::DELETED_COMMENT ) {
3861 $data->log_comment_text = $this->context->msg( 'rev-deleted-comment' )->escaped();
3862 $data->log_comment_data = null;
3863 }
3864 }
3865
3866 return $data;
3867 }
3868
3869 /**
3870 * Get the rendered text for previewing.
3871 * @throws MWException
3872 * @return string
3873 */
3874 public function getPreviewText() {
3875 $out = $this->context->getOutput();
3876 $config = $this->context->getConfig();
3877
3878 if ( $config->get( 'RawHtml' ) && !$this->mTokenOk ) {
3879 // Could be an offsite preview attempt. This is very unsafe if
3880 // HTML is enabled, as it could be an attack.
3881 $parsedNote = '';
3882 if ( $this->textbox1 !== '' ) {
3883 // Do not put big scary notice, if previewing the empty
3884 // string, which happens when you initially edit
3885 // a category page, due to automatic preview-on-open.
3886 $parsedNote = Html::rawElement( 'div', [ 'class' => 'previewnote' ],
3887 $out->parseAsInterface(
3888 $this->context->msg( 'session_fail_preview_html' )->plain()
3889 ) );
3890 }
3891 $this->incrementEditFailureStats( 'session_loss' );
3892 return $parsedNote;
3893 }
3894
3895 $note = '';
3896
3897 try {
3898 $content = $this->toEditContent( $this->textbox1 );
3899
3900 $previewHTML = '';
3901 if ( !Hooks::run(
3902 'AlternateEditPreview',
3903 [ $this, &$content, &$previewHTML, &$this->mParserOutput ] )
3904 ) {
3905 return $previewHTML;
3906 }
3907
3908 # provide a anchor link to the editform
3909 $continueEditing = '<span class="mw-continue-editing">' .
3910 '[[#' . self::EDITFORM_ID . '|' .
3911 $this->context->getLanguage()->getArrow() . ' ' .
3912 $this->context->msg( 'continue-editing' )->text() . ']]</span>';
3913 if ( $this->mTriedSave && !$this->mTokenOk ) {
3914 if ( $this->mTokenOkExceptSuffix ) {
3915 $note = $this->context->msg( 'token_suffix_mismatch' )->plain();
3916 $this->incrementEditFailureStats( 'bad_token' );
3917 } else {
3918 $note = $this->context->msg( 'session_fail_preview' )->plain();
3919 $this->incrementEditFailureStats( 'session_loss' );
3920 }
3921 } elseif ( $this->incompleteForm ) {
3922 $note = $this->context->msg( 'edit_form_incomplete' )->plain();
3923 if ( $this->mTriedSave ) {
3924 $this->incrementEditFailureStats( 'incomplete_form' );
3925 }
3926 } else {
3927 $note = $this->context->msg( 'previewnote' )->plain() . ' ' . $continueEditing;
3928 }
3929
3930 # don't parse non-wikitext pages, show message about preview
3931 if ( $this->mTitle->isUserConfigPage() || $this->mTitle->isSiteConfigPage() ) {
3932 if ( $this->mTitle->isUserConfigPage() ) {
3933 $level = 'user';
3934 } elseif ( $this->mTitle->isSiteConfigPage() ) {
3935 $level = 'site';
3936 } else {
3937 $level = false;
3938 }
3939
3940 if ( $content->getModel() == CONTENT_MODEL_CSS ) {
3941 $format = 'css';
3942 if ( $level === 'user' && !$config->get( 'AllowUserCss' ) ) {
3943 $format = false;
3944 }
3945 } elseif ( $content->getModel() == CONTENT_MODEL_JSON ) {
3946 $format = 'json';
3947 if ( $level === 'user' /* No comparable 'AllowUserJson' */ ) {
3948 $format = false;
3949 }
3950 } elseif ( $content->getModel() == CONTENT_MODEL_JAVASCRIPT ) {
3951 $format = 'js';
3952 if ( $level === 'user' && !$config->get( 'AllowUserJs' ) ) {
3953 $format = false;
3954 }
3955 } else {
3956 $format = false;
3957 }
3958
3959 # Used messages to make sure grep find them:
3960 # Messages: usercsspreview, userjsonpreview, userjspreview,
3961 # sitecsspreview, sitejsonpreview, sitejspreview
3962 if ( $level && $format ) {
3963 $note = "<div id='mw-{$level}{$format}preview'>" .
3964 $this->context->msg( "{$level}{$format}preview" )->plain() .
3965 ' ' . $continueEditing . "</div>";
3966 }
3967 }
3968
3969 # If we're adding a comment, we need to show the
3970 # summary as the headline
3971 if ( $this->section === "new" && $this->summary !== "" ) {
3972 $content = $content->addSectionHeader( $this->summary );
3973 }
3974
3975 $hook_args = [ $this, &$content ];
3976 Hooks::run( 'EditPageGetPreviewContent', $hook_args );
3977
3978 $parserResult = $this->doPreviewParse( $content );
3979 $parserOutput = $parserResult['parserOutput'];
3980 $previewHTML = $parserResult['html'];
3981 $this->mParserOutput = $parserOutput;
3982 $out->addParserOutputMetadata( $parserOutput );
3983 if ( $out->userCanPreview() ) {
3984 $out->addContentOverride( $this->getTitle(), $content );
3985 }
3986
3987 if ( count( $parserOutput->getWarnings() ) ) {
3988 $note .= "\n\n" . implode( "\n\n", $parserOutput->getWarnings() );
3989 }
3990
3991 } catch ( MWContentSerializationException $ex ) {
3992 $m = $this->context->msg(
3993 'content-failed-to-parse',
3994 $this->contentModel,
3995 $this->contentFormat,
3996 $ex->getMessage()
3997 );
3998 $note .= "\n\n" . $m->plain(); # gets parsed down below
3999 $previewHTML = '';
4000 }
4001
4002 if ( $this->isConflict ) {
4003 $conflict = Html::rawElement(
4004 'h2', [ 'id' => 'mw-previewconflict' ],
4005 $this->context->msg( 'previewconflict' )->escaped()
4006 );
4007 } else {
4008 $conflict = '<hr />';
4009 }
4010
4011 $previewhead = Html::rawElement(
4012 'div', [ 'class' => 'previewnote' ],
4013 Html::rawElement(
4014 'h2', [ 'id' => 'mw-previewheader' ],
4015 $this->context->msg( 'preview' )->escaped()
4016 ) .
4017 $out->parseAsInterface( $note ) . $conflict
4018 );
4019
4020 $pageViewLang = $this->mTitle->getPageViewLanguage();
4021 $attribs = [ 'lang' => $pageViewLang->getHtmlCode(), 'dir' => $pageViewLang->getDir(),
4022 'class' => 'mw-content-' . $pageViewLang->getDir() ];
4023 $previewHTML = Html::rawElement( 'div', $attribs, $previewHTML );
4024
4025 return $previewhead . $previewHTML . $this->previewTextAfterContent;
4026 }
4027
4028 private function incrementEditFailureStats( $failureType ) {
4029 $stats = MediaWikiServices::getInstance()->getStatsdDataFactory();
4030 $stats->increment( 'edit.failures.' . $failureType );
4031 }
4032
4033 /**
4034 * Get parser options for a preview
4035 * @return ParserOptions
4036 */
4037 protected function getPreviewParserOptions() {
4038 $parserOptions = $this->page->makeParserOptions( $this->context );
4039 $parserOptions->setIsPreview( true );
4040 $parserOptions->setIsSectionPreview( !is_null( $this->section ) && $this->section !== '' );
4041 $parserOptions->enableLimitReport();
4042
4043 // XXX: we could call $parserOptions->setCurrentRevisionCallback here to force the
4044 // current revision to be null during PST, until setupFakeRevision is called on
4045 // the ParserOptions. Currently, we rely on Parser::getRevisionObject() to ignore
4046 // existing revisions in preview mode.
4047
4048 return $parserOptions;
4049 }
4050
4051 /**
4052 * Parse the page for a preview. Subclasses may override this class, in order
4053 * to parse with different options, or to otherwise modify the preview HTML.
4054 *
4055 * @param Content $content The page content
4056 * @return array with keys:
4057 * - parserOutput: The ParserOutput object
4058 * - html: The HTML to be displayed
4059 */
4060 protected function doPreviewParse( Content $content ) {
4061 $user = $this->context->getUser();
4062 $parserOptions = $this->getPreviewParserOptions();
4063
4064 // NOTE: preSaveTransform doesn't have a fake revision to operate on.
4065 // Parser::getRevisionObject() will return null in preview mode,
4066 // causing the context user to be used for {{subst:REVISIONUSER}}.
4067 // XXX: Alternatively, we could also call setupFakeRevision() a second time:
4068 // once before PST with $content, and then after PST with $pstContent.
4069 $pstContent = $content->preSaveTransform( $this->mTitle, $user, $parserOptions );
4070 $scopedCallback = $parserOptions->setupFakeRevision( $this->mTitle, $pstContent, $user );
4071 $parserOutput = $pstContent->getParserOutput( $this->mTitle, null, $parserOptions );
4072 ScopedCallback::consume( $scopedCallback );
4073 return [
4074 'parserOutput' => $parserOutput,
4075 'html' => $parserOutput->getText( [
4076 'enableSectionEditLinks' => false
4077 ] )
4078 ];
4079 }
4080
4081 /**
4082 * @return array
4083 */
4084 public function getTemplates() {
4085 if ( $this->preview || $this->section != '' ) {
4086 $templates = [];
4087 if ( !isset( $this->mParserOutput ) ) {
4088 return $templates;
4089 }
4090 foreach ( $this->mParserOutput->getTemplates() as $ns => $template ) {
4091 foreach ( array_keys( $template ) as $dbk ) {
4092 $templates[] = Title::makeTitle( $ns, $dbk );
4093 }
4094 }
4095 return $templates;
4096 } else {
4097 return $this->mTitle->getTemplateLinksFrom();
4098 }
4099 }
4100
4101 /**
4102 * Allow extensions to provide a toolbar.
4103 *
4104 * @param Title|null $title Title object for the page being edited (optional)
4105 * @return string|null
4106 */
4107 public static function getEditToolbar( $title = null ) {
4108 $startingToolbar = '<div id="toolbar"></div>';
4109 $toolbar = $startingToolbar;
4110
4111 if ( !Hooks::run( 'EditPageBeforeEditToolbar', [ &$toolbar ] ) ) {
4112 return null;
4113 };
4114 // Don't add a pointless `<div>` to the page unless a hook caller populated it
4115 return ( $toolbar === $startingToolbar ) ? null : $toolbar;
4116 }
4117
4118 /**
4119 * Return an array of checkbox definitions.
4120 *
4121 * Array keys correspond to the `<input>` 'name' attribute to use for each checkbox.
4122 *
4123 * Array values are associative arrays with the following keys:
4124 * - 'label-message' (required): message for label text
4125 * - 'id' (required): 'id' attribute for the `<input>`
4126 * - 'default' (required): default checkedness (true or false)
4127 * - 'title-message' (optional): used to generate 'title' attribute for the `<label>`
4128 * - 'tooltip' (optional): used to generate 'title' and 'accesskey' attributes
4129 * from messages like 'tooltip-foo', 'accesskey-foo'
4130 * - 'label-id' (optional): 'id' attribute for the `<label>`
4131 * - 'legacy-name' (optional): short name for backwards-compatibility
4132 * @param array $checked Array of checkbox name (matching the 'legacy-name') => bool,
4133 * where bool indicates the checked status of the checkbox
4134 * @return array
4135 */
4136 public function getCheckboxesDefinition( $checked ) {
4137 $checkboxes = [];
4138
4139 $user = $this->context->getUser();
4140 // don't show the minor edit checkbox if it's a new page or section
4141 if ( !$this->isNew && $user->isAllowed( 'minoredit' ) ) {
4142 $checkboxes['wpMinoredit'] = [
4143 'id' => 'wpMinoredit',
4144 'label-message' => 'minoredit',
4145 // Uses messages: tooltip-minoredit, accesskey-minoredit
4146 'tooltip' => 'minoredit',
4147 'label-id' => 'mw-editpage-minoredit',
4148 'legacy-name' => 'minor',
4149 'default' => $checked['minor'],
4150 ];
4151 }
4152
4153 if ( $user->isLoggedIn() ) {
4154 $checkboxes['wpWatchthis'] = [
4155 'id' => 'wpWatchthis',
4156 'label-message' => 'watchthis',
4157 // Uses messages: tooltip-watch, accesskey-watch
4158 'tooltip' => 'watch',
4159 'label-id' => 'mw-editpage-watch',
4160 'legacy-name' => 'watch',
4161 'default' => $checked['watch'],
4162 ];
4163 }
4164
4165 $editPage = $this;
4166 Hooks::run( 'EditPageGetCheckboxesDefinition', [ $editPage, &$checkboxes ] );
4167
4168 return $checkboxes;
4169 }
4170
4171 /**
4172 * Returns an array of checkboxes for the edit form, including 'minor' and 'watch' checkboxes and
4173 * any other added by extensions.
4174 *
4175 * @param int &$tabindex Current tabindex
4176 * @param array $checked Array of checkbox => bool, where bool indicates the checked
4177 * status of the checkbox
4178 *
4179 * @return array Associative array of string keys to OOUI\FieldLayout instances
4180 */
4181 public function getCheckboxesWidget( &$tabindex, $checked ) {
4182 $checkboxes = [];
4183 $checkboxesDef = $this->getCheckboxesDefinition( $checked );
4184
4185 foreach ( $checkboxesDef as $name => $options ) {
4186 $legacyName = $options['legacy-name'] ?? $name;
4187
4188 $title = null;
4189 $accesskey = null;
4190 if ( isset( $options['tooltip'] ) ) {
4191 $accesskey = $this->context->msg( "accesskey-{$options['tooltip']}" )->text();
4192 $title = Linker::titleAttrib( $options['tooltip'] );
4193 }
4194 if ( isset( $options['title-message'] ) ) {
4195 $title = $this->context->msg( $options['title-message'] )->text();
4196 }
4197
4198 $checkboxes[ $legacyName ] = new OOUI\FieldLayout(
4199 new OOUI\CheckboxInputWidget( [
4200 'tabIndex' => ++$tabindex,
4201 'accessKey' => $accesskey,
4202 'id' => $options['id'] . 'Widget',
4203 'inputId' => $options['id'],
4204 'name' => $name,
4205 'selected' => $options['default'],
4206 'infusable' => true,
4207 ] ),
4208 [
4209 'align' => 'inline',
4210 'label' => new OOUI\HtmlSnippet( $this->context->msg( $options['label-message'] )->parse() ),
4211 'title' => $title,
4212 'id' => $options['label-id'] ?? null,
4213 ]
4214 );
4215 }
4216
4217 return $checkboxes;
4218 }
4219
4220 /**
4221 * Get the message key of the label for the button to save the page
4222 *
4223 * @since 1.30
4224 * @return string
4225 */
4226 protected function getSubmitButtonLabel() {
4227 $labelAsPublish =
4228 $this->context->getConfig()->get( 'EditSubmitButtonLabelPublish' );
4229
4230 // Can't use $this->isNew as that's also true if we're adding a new section to an extant page
4231 $newPage = !$this->mTitle->exists();
4232
4233 if ( $labelAsPublish ) {
4234 $buttonLabelKey = $newPage ? 'publishpage' : 'publishchanges';
4235 } else {
4236 $buttonLabelKey = $newPage ? 'savearticle' : 'savechanges';
4237 }
4238
4239 return $buttonLabelKey;
4240 }
4241
4242 /**
4243 * Returns an array of html code of the following buttons:
4244 * save, diff and preview
4245 *
4246 * @param int &$tabindex Current tabindex
4247 *
4248 * @return array
4249 */
4250 public function getEditButtons( &$tabindex ) {
4251 $buttons = [];
4252
4253 $labelAsPublish =
4254 $this->context->getConfig()->get( 'EditSubmitButtonLabelPublish' );
4255
4256 $buttonLabel = $this->context->msg( $this->getSubmitButtonLabel() )->text();
4257 $buttonTooltip = $labelAsPublish ? 'publish' : 'save';
4258
4259 $buttons['save'] = new OOUI\ButtonInputWidget( [
4260 'name' => 'wpSave',
4261 'tabIndex' => ++$tabindex,
4262 'id' => 'wpSaveWidget',
4263 'inputId' => 'wpSave',
4264 // Support: IE 6 – Use <input>, otherwise it can't distinguish which button was clicked
4265 'useInputTag' => true,
4266 'flags' => [ 'progressive', 'primary' ],
4267 'label' => $buttonLabel,
4268 'infusable' => true,
4269 'type' => 'submit',
4270 // Messages used: tooltip-save, tooltip-publish
4271 'title' => Linker::titleAttrib( $buttonTooltip ),
4272 // Messages used: accesskey-save, accesskey-publish
4273 'accessKey' => Linker::accesskey( $buttonTooltip ),
4274 ] );
4275
4276 $buttons['preview'] = new OOUI\ButtonInputWidget( [
4277 'name' => 'wpPreview',
4278 'tabIndex' => ++$tabindex,
4279 'id' => 'wpPreviewWidget',
4280 'inputId' => 'wpPreview',
4281 // Support: IE 6 – Use <input>, otherwise it can't distinguish which button was clicked
4282 'useInputTag' => true,
4283 'label' => $this->context->msg( 'showpreview' )->text(),
4284 'infusable' => true,
4285 'type' => 'submit',
4286 // Message used: tooltip-preview
4287 'title' => Linker::titleAttrib( 'preview' ),
4288 // Message used: accesskey-preview
4289 'accessKey' => Linker::accesskey( 'preview' ),
4290 ] );
4291
4292 $buttons['diff'] = new OOUI\ButtonInputWidget( [
4293 'name' => 'wpDiff',
4294 'tabIndex' => ++$tabindex,
4295 'id' => 'wpDiffWidget',
4296 'inputId' => 'wpDiff',
4297 // Support: IE 6 – Use <input>, otherwise it can't distinguish which button was clicked
4298 'useInputTag' => true,
4299 'label' => $this->context->msg( 'showdiff' )->text(),
4300 'infusable' => true,
4301 'type' => 'submit',
4302 // Message used: tooltip-diff
4303 'title' => Linker::titleAttrib( 'diff' ),
4304 // Message used: accesskey-diff
4305 'accessKey' => Linker::accesskey( 'diff' ),
4306 ] );
4307
4308 // Avoid PHP 7.1 warning of passing $this by reference
4309 $editPage = $this;
4310 Hooks::run( 'EditPageBeforeEditButtons', [ &$editPage, &$buttons, &$tabindex ] );
4311
4312 return $buttons;
4313 }
4314
4315 /**
4316 * Creates a basic error page which informs the user that
4317 * they have attempted to edit a nonexistent section.
4318 */
4319 public function noSuchSectionPage() {
4320 $out = $this->context->getOutput();
4321 $out->prepareErrorPage( $this->context->msg( 'nosuchsectiontitle' ) );
4322
4323 $res = $this->context->msg( 'nosuchsectiontext', $this->section )->parseAsBlock();
4324
4325 // Avoid PHP 7.1 warning of passing $this by reference
4326 $editPage = $this;
4327 Hooks::run( 'EditPageNoSuchSection', [ &$editPage, &$res ] );
4328 $out->addHTML( $res );
4329
4330 $out->returnToMain( false, $this->mTitle );
4331 }
4332
4333 /**
4334 * Show "your edit contains spam" page with your diff and text
4335 *
4336 * @param string|array|bool $match Text (or array of texts) which triggered one or more filters
4337 */
4338 public function spamPageWithContent( $match = false ) {
4339 $this->textbox2 = $this->textbox1;
4340
4341 if ( is_array( $match ) ) {
4342 $match = $this->context->getLanguage()->listToText( $match );
4343 }
4344 $out = $this->context->getOutput();
4345 $out->prepareErrorPage( $this->context->msg( 'spamprotectiontitle' ) );
4346
4347 $out->addHTML( '<div id="spamprotected">' );
4348 $out->addWikiMsg( 'spamprotectiontext' );
4349 if ( $match ) {
4350 $out->addWikiMsg( 'spamprotectionmatch', wfEscapeWikiText( $match ) );
4351 }
4352 $out->addHTML( '</div>' );
4353
4354 $out->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
4355 $this->showDiff();
4356
4357 $out->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
4358 $this->showTextbox2();
4359
4360 $out->addReturnTo( $this->getContextTitle(), [ 'action' => 'edit' ] );
4361 }
4362
4363 /**
4364 * Filter an input field through a Unicode de-armoring process if it
4365 * came from an old browser with known broken Unicode editing issues.
4366 *
4367 * @deprecated since 1.30, does nothing
4368 *
4369 * @param WebRequest $request
4370 * @param string $field
4371 * @return string
4372 */
4373 protected function safeUnicodeInput( $request, $field ) {
4374 return rtrim( $request->getText( $field ) );
4375 }
4376
4377 /**
4378 * Filter an output field through a Unicode armoring process if it is
4379 * going to an old browser with known broken Unicode editing issues.
4380 *
4381 * @deprecated since 1.30, does nothing
4382 *
4383 * @param string $text
4384 * @return string
4385 */
4386 protected function safeUnicodeOutput( $text ) {
4387 return $text;
4388 }
4389
4390 /**
4391 * @since 1.29
4392 */
4393 protected function addEditNotices() {
4394 $out = $this->context->getOutput();
4395 $editNotices = $this->mTitle->getEditNotices( $this->oldid );
4396 if ( count( $editNotices ) ) {
4397 $out->addHTML( implode( "\n", $editNotices ) );
4398 } else {
4399 $msg = $this->context->msg( 'editnotice-notext' );
4400 if ( !$msg->isDisabled() ) {
4401 $out->addHTML(
4402 '<div class="mw-editnotice-notext">'
4403 . $msg->parseAsBlock()
4404 . '</div>'
4405 );
4406 }
4407 }
4408 }
4409
4410 /**
4411 * @since 1.29
4412 */
4413 protected function addTalkPageText() {
4414 if ( $this->mTitle->isTalkPage() ) {
4415 $this->context->getOutput()->addWikiMsg( 'talkpagetext' );
4416 }
4417 }
4418
4419 /**
4420 * @since 1.29
4421 */
4422 protected function addLongPageWarningHeader() {
4423 if ( $this->contentLength === false ) {
4424 $this->contentLength = strlen( $this->textbox1 );
4425 }
4426
4427 $out = $this->context->getOutput();
4428 $lang = $this->context->getLanguage();
4429 $maxArticleSize = $this->context->getConfig()->get( 'MaxArticleSize' );
4430 if ( $this->tooBig || $this->contentLength > $maxArticleSize * 1024 ) {
4431 $out->wrapWikiMsg( "<div class='error' id='mw-edit-longpageerror'>\n$1\n</div>",
4432 [
4433 'longpageerror',
4434 $lang->formatNum( round( $this->contentLength / 1024, 3 ) ),
4435 $lang->formatNum( $maxArticleSize )
4436 ]
4437 );
4438 } elseif ( !$this->context->msg( 'longpage-hint' )->isDisabled() ) {
4439 $out->wrapWikiMsg( "<div id='mw-edit-longpage-hint'>\n$1\n</div>",
4440 [
4441 'longpage-hint',
4442 $lang->formatSize( strlen( $this->textbox1 ) ),
4443 strlen( $this->textbox1 )
4444 ]
4445 );
4446 }
4447 }
4448
4449 /**
4450 * @since 1.29
4451 */
4452 protected function addPageProtectionWarningHeaders() {
4453 $out = $this->context->getOutput();
4454 if ( $this->mTitle->isProtected( 'edit' ) &&
4455 MediaWikiServices::getInstance()->getNamespaceInfo()->getRestrictionLevels(
4456 $this->mTitle->getNamespace()
4457 ) !== [ '' ]
4458 ) {
4459 # Is the title semi-protected?
4460 if ( $this->mTitle->isSemiProtected() ) {
4461 $noticeMsg = 'semiprotectedpagewarning';
4462 } else {
4463 # Then it must be protected based on static groups (regular)
4464 $noticeMsg = 'protectedpagewarning';
4465 }
4466 LogEventsList::showLogExtract( $out, 'protect', $this->mTitle, '',
4467 [ 'lim' => 1, 'msgKey' => [ $noticeMsg ] ] );
4468 }
4469 if ( $this->mTitle->isCascadeProtected() ) {
4470 # Is this page under cascading protection from some source pages?
4471 /** @var Title[] $cascadeSources */
4472 list( $cascadeSources, /* $restrictions */ ) = $this->mTitle->getCascadeProtectionSources();
4473 $notice = "<div class='mw-cascadeprotectedwarning'>\n$1\n";
4474 $cascadeSourcesCount = count( $cascadeSources );
4475 if ( $cascadeSourcesCount > 0 ) {
4476 # Explain, and list the titles responsible
4477 foreach ( $cascadeSources as $page ) {
4478 $notice .= '* [[:' . $page->getPrefixedText() . "]]\n";
4479 }
4480 }
4481 $notice .= '</div>';
4482 $out->wrapWikiMsg( $notice, [ 'cascadeprotectedwarning', $cascadeSourcesCount ] );
4483 }
4484 if ( !$this->mTitle->exists() && $this->mTitle->getRestrictions( 'create' ) ) {
4485 LogEventsList::showLogExtract( $out, 'protect', $this->mTitle, '',
4486 [ 'lim' => 1,
4487 'showIfEmpty' => false,
4488 'msgKey' => [ 'titleprotectedwarning' ],
4489 'wrap' => "<div class=\"mw-titleprotectedwarning\">\n$1</div>" ] );
4490 }
4491 }
4492
4493 /**
4494 * @param OutputPage $out
4495 * @since 1.29
4496 */
4497 protected function addExplainConflictHeader( OutputPage $out ) {
4498 $out->addHTML(
4499 $this->getEditConflictHelper()->getExplainHeader()
4500 );
4501 }
4502
4503 /**
4504 * @param string $name
4505 * @param mixed[] $customAttribs
4506 * @param User $user
4507 * @return mixed[]
4508 * @since 1.29
4509 */
4510 protected function buildTextboxAttribs( $name, array $customAttribs, User $user ) {
4511 return ( new TextboxBuilder() )->buildTextboxAttribs(
4512 $name, $customAttribs, $user, $this->mTitle
4513 );
4514 }
4515
4516 /**
4517 * @param string $wikitext
4518 * @return string
4519 * @since 1.29
4520 */
4521 protected function addNewLineAtEnd( $wikitext ) {
4522 return ( new TextboxBuilder() )->addNewLineAtEnd( $wikitext );
4523 }
4524
4525 /**
4526 * Turns section name wikitext into anchors for use in HTTP redirects. Various
4527 * versions of Microsoft browsers misinterpret fragment encoding of Location: headers
4528 * resulting in mojibake in address bar. Redirect them to legacy section IDs,
4529 * if possible. All the other browsers get HTML5 if the wiki is configured for it, to
4530 * spread the new style links more efficiently.
4531 *
4532 * @param string $text
4533 * @return string
4534 */
4535 private function guessSectionName( $text ) {
4536 // Detect Microsoft browsers
4537 $userAgent = $this->context->getRequest()->getHeader( 'User-Agent' );
4538 $parser = MediaWikiServices::getInstance()->getParser();
4539 if ( $userAgent && preg_match( '/MSIE|Edge/', $userAgent ) ) {
4540 // ...and redirect them to legacy encoding, if available
4541 return $parser->guessLegacySectionNameFromWikiText( $text );
4542 }
4543 // Meanwhile, real browsers get real anchors
4544 $name = $parser->guessSectionNameFromWikiText( $text );
4545 // With one little caveat: per T216029, fragments in HTTP redirects need to be urlencoded,
4546 // otherwise Chrome double-escapes the rest of the URL.
4547 return '#' . urlencode( mb_substr( $name, 1 ) );
4548 }
4549
4550 /**
4551 * Set a factory function to create an EditConflictHelper
4552 *
4553 * @param callable $factory Factory function
4554 * @since 1.31
4555 */
4556 public function setEditConflictHelperFactory( callable $factory ) {
4557 $this->editConflictHelperFactory = $factory;
4558 $this->editConflictHelper = null;
4559 }
4560
4561 /**
4562 * @return TextConflictHelper
4563 */
4564 private function getEditConflictHelper() {
4565 if ( !$this->editConflictHelper ) {
4566 $this->editConflictHelper = call_user_func(
4567 $this->editConflictHelperFactory,
4568 $this->getSubmitButtonLabel()
4569 );
4570 }
4571
4572 return $this->editConflictHelper;
4573 }
4574
4575 /**
4576 * @param string $submitButtonLabel
4577 * @return TextConflictHelper
4578 */
4579 private function newTextConflictHelper( $submitButtonLabel ) {
4580 return new TextConflictHelper(
4581 $this->getTitle(),
4582 $this->getContext()->getOutput(),
4583 MediaWikiServices::getInstance()->getStatsdDataFactory(),
4584 $submitButtonLabel
4585 );
4586 }
4587 }