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