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