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