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