Merge "De-duplicate pages in replaceInternal"
[mediawiki.git] / includes / EditPage.php
blob3d57e95895ef486f905f8b0ed5b089bb223c1048
1 <?php
2 /**
3 * User interface for page editing.
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.
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.
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
20 * @file
23 /**
24 * The edit page/HTML interface (split from Article)
25 * The actual database and text munging is still in Article,
26 * but it should get easier to call those from alternate
27 * interfaces.
29 * EditPage cares about two distinct titles:
30 * $this->mContextTitle is the page that forms submit to, links point to,
31 * redirects go to, etc. $this->mTitle (as well as $mArticle) is the
32 * page in the database that is actually being edited. These are
33 * usually the same, but they are now allowed to be different.
35 * Surgeon General's Warning: prolonged exposure to this class is known to cause
36 * headaches, which may be fatal.
38 class EditPage {
39 /**
40 * Status: Article successfully updated
42 const AS_SUCCESS_UPDATE = 200;
44 /**
45 * Status: Article successfully created
47 const AS_SUCCESS_NEW_ARTICLE = 201;
49 /**
50 * Status: Article update aborted by a hook function
52 const AS_HOOK_ERROR = 210;
54 /**
55 * Status: A hook function returned an error
57 const AS_HOOK_ERROR_EXPECTED = 212;
59 /**
60 * Status: User is blocked from editing this page
62 const AS_BLOCKED_PAGE_FOR_USER = 215;
64 /**
65 * Status: Content too big (> $wgMaxArticleSize)
67 const AS_CONTENT_TOO_BIG = 216;
69 /**
70 * Status: User cannot edit? (not used)
72 const AS_USER_CANNOT_EDIT = 217;
74 /**
75 * Status: this anonymous user is not allowed to edit this page
77 const AS_READ_ONLY_PAGE_ANON = 218;
79 /**
80 * Status: this logged in user is not allowed to edit this page
82 const AS_READ_ONLY_PAGE_LOGGED = 219;
84 /**
85 * Status: wiki is in readonly mode (wfReadOnly() == true)
87 const AS_READ_ONLY_PAGE = 220;
89 /**
90 * Status: rate limiter for action 'edit' was tripped
92 const AS_RATE_LIMITED = 221;
94 /**
95 * Status: article was deleted while editing and param wpRecreate == false or form
96 * was not posted
98 const AS_ARTICLE_WAS_DELETED = 222;
101 * Status: user tried to create this page, but is not allowed to do that
102 * ( Title->userCan('create') == false )
104 const AS_NO_CREATE_PERMISSION = 223;
107 * Status: user tried to create a blank page
109 const AS_BLANK_ARTICLE = 224;
112 * Status: (non-resolvable) edit conflict
114 const AS_CONFLICT_DETECTED = 225;
117 * Status: no edit summary given and the user has forceeditsummary set and the user is not
118 * editing in his own userspace or talkspace and wpIgnoreBlankSummary == false
120 const AS_SUMMARY_NEEDED = 226;
123 * Status: user tried to create a new section without content
125 const AS_TEXTBOX_EMPTY = 228;
128 * Status: article is too big (> $wgMaxArticleSize), after merging in the new section
130 const AS_MAX_ARTICLE_SIZE_EXCEEDED = 229;
133 * not used
135 const AS_OK = 230;
138 * Status: WikiPage::doEdit() was unsuccessful
140 const AS_END = 231;
143 * Status: summary contained spam according to one of the regexes in $wgSummarySpamRegex
145 const AS_SPAM_ERROR = 232;
148 * Status: anonymous user is not allowed to upload (User::isAllowed('upload') == false)
150 const AS_IMAGE_REDIRECT_ANON = 233;
153 * Status: logged in user is not allowed to upload (User::isAllowed('upload') == false)
155 const AS_IMAGE_REDIRECT_LOGGED = 234;
158 * Status: can't parse content
160 const AS_PARSE_ERROR = 240;
163 * HTML id and name for the beginning of the edit form.
165 const EDITFORM_ID = 'editform';
168 * Prefix of key for cookie used to pass post-edit state.
169 * The revision id edited is added after this
171 const POST_EDIT_COOKIE_KEY_PREFIX = 'PostEditRevision';
174 * Duration of PostEdit cookie, in seconds.
175 * The cookie will be removed instantly if the JavaScript runs.
177 * Otherwise, though, we don't want the cookies to accumulate.
178 * RFC 2109 ( https://www.ietf.org/rfc/rfc2109.txt ) specifies a possible
179 * limit of only 20 cookies per domain. This still applies at least to some
180 * versions of IE without full updates:
181 * https://blogs.msdn.com/b/ieinternals/archive/2009/08/20/wininet-ie-cookie-internals-faq.aspx
183 * A value of 20 minutes should be enough to take into account slow loads and minor
184 * clock skew while still avoiding cookie accumulation when JavaScript is turned off.
186 const POST_EDIT_COOKIE_DURATION = 1200;
188 /** @var Article */
189 public $mArticle;
191 /** @var Title */
192 public $mTitle;
194 /** @var null|Title */
195 private $mContextTitle = null;
197 /** @var string */
198 protected $action = 'submit';
200 /** @var bool */
201 public $isConflict = false;
203 /** @var bool */
204 public $isCssJsSubpage = false;
206 /** @var bool */
207 public $isCssSubpage = false;
209 /** @var bool */
210 public $isJsSubpage = false;
212 /** @var bool */
213 protected $isWrongCaseCssJsPage = false;
215 /** @var bool New page or new section */
216 protected $isNew = false;
218 /** @var bool */
219 protected $deletedSinceEdit;
221 /** @var string */
222 public $formtype;
224 /** @var bool */
225 public $firsttime;
227 /** @var bool|stdClass */
228 protected $lastDelete;
230 /** @var bool */
231 protected $mTokenOk = false;
233 /** @var bool */
234 protected $mTokenOkExceptSuffix = false;
236 /** @var bool */
237 protected $mTriedSave = false;
239 /** @var bool */
240 protected $incompleteForm = false;
242 /** @var bool */
243 protected $tooBig = false;
245 /** @var bool */
246 protected $kblength = false;
248 /** @var bool */
249 protected $missingComment = false;
251 /** @var bool */
252 protected $missingSummary = false;
254 /** @var bool */
255 protected $allowBlankSummary = false;
257 /** @var string */
258 protected $autoSumm = '';
260 /** @var string */
261 public $hookError = '';
263 /** @var ParserOutput */
264 protected $mParserOutput;
266 /** @var bool Has a summary been preset using GET parameter &summary= ? */
267 protected $hasPresetSummary = false;
269 /** @var bool */
270 protected $mBaseRevision = false;
272 /** @var bool */
273 public $mShowSummaryField = true;
275 # Form values
277 /** @var bool */
278 public $save = false;
280 /** @var bool */
281 public $preview = false;
283 /** @var bool */
284 protected $diff = false;
286 /** @var bool */
287 public $minoredit = false;
289 /** @var bool */
290 protected $watchthis = false;
292 /** @var bool */
293 protected $recreate = false;
295 /** @var string */
296 public $textbox1 = '';
298 /** @var string */
299 public $textbox2 = '';
301 /** @var string */
302 public $summary = '';
304 /** @var bool */
305 protected $nosummary = false;
307 /** @var string */
308 public $edittime = '';
310 /** @var string */
311 public $section = '';
313 /** @var string */
314 public $sectiontitle = '';
316 /** @var string */
317 protected $starttime = '';
319 /** @var int */
320 public $oldid = 0;
322 /** @var string */
323 protected $editintro = '';
325 /** @var null */
326 public $scrolltop = null;
328 /** @var bool */
329 public $bot = true;
331 /** @var null|string */
332 public $contentModel = null;
334 /** @var null|string */
335 public $contentFormat = null;
337 # Placeholders for text injection by hooks (must be HTML)
338 # extensions should take care to _append_ to the present value
340 /** @var string Before even the preview */
341 public $editFormPageTop = '';
342 public $editFormTextTop = '';
343 public $editFormTextBeforeContent = '';
344 public $editFormTextAfterWarn = '';
345 public $editFormTextAfterTools = '';
346 public $editFormTextBottom = '';
347 public $editFormTextAfterContent = '';
348 public $previewTextAfterContent = '';
349 public $mPreloadContent = null;
351 /* $didSave should be set to true whenever an article was successfully altered. */
352 public $didSave = false;
353 public $undidRev = 0;
355 public $suppressIntro = false;
357 /** @var bool Set to true to allow editing of non-text content types. */
358 public $allowNonTextContent = false;
360 /** @var bool */
361 protected $edit;
363 /** @var bool */
364 public $live;
367 * @param Article $article
369 public function __construct( Article $article ) {
370 $this->mArticle = $article;
371 $this->mTitle = $article->getTitle();
373 $this->contentModel = $this->mTitle->getContentModel();
375 $handler = ContentHandler::getForModelID( $this->contentModel );
376 $this->contentFormat = $handler->getDefaultFormat();
380 * @return Article
382 public function getArticle() {
383 return $this->mArticle;
387 * @since 1.19
388 * @return Title
390 public function getTitle() {
391 return $this->mTitle;
395 * Set the context Title object
397 * @param Title|null $title Title object or null
399 public function setContextTitle( $title ) {
400 $this->mContextTitle = $title;
404 * Get the context title object.
405 * If not set, $wgTitle will be returned. This behavior might change in
406 * the future to return $this->mTitle instead.
408 * @return Title
410 public function getContextTitle() {
411 if ( is_null( $this->mContextTitle ) ) {
412 global $wgTitle;
413 return $wgTitle;
414 } else {
415 return $this->mContextTitle;
420 * Returns if the given content model is editable.
422 * @param string $modelId The ID of the content model to test. Use CONTENT_MODEL_XXX constants.
423 * @return bool
424 * @throws MWException if $modelId has no known handler
426 public function isSupportedContentModel( $modelId ) {
427 return $this->allowNonTextContent ||
428 ContentHandler::getForModelID( $modelId ) instanceof TextContentHandler;
431 function submit() {
432 $this->edit();
436 * This is the function that gets called for "action=edit". It
437 * sets up various member variables, then passes execution to
438 * another function, usually showEditForm()
440 * The edit form is self-submitting, so that when things like
441 * preview and edit conflicts occur, we get the same form back
442 * with the extra stuff added. Only when the final submission
443 * is made and all is well do we actually save and redirect to
444 * the newly-edited page.
446 function edit() {
447 global $wgOut, $wgRequest, $wgUser;
448 // Allow extensions to modify/prevent this form or submission
449 if ( !wfRunHooks( 'AlternateEdit', array( $this ) ) ) {
450 return;
453 wfProfileIn( __METHOD__ );
454 wfDebug( __METHOD__ . ": enter\n" );
456 // If they used redlink=1 and the page exists, redirect to the main article
457 if ( $wgRequest->getBool( 'redlink' ) && $this->mTitle->exists() ) {
458 $wgOut->redirect( $this->mTitle->getFullURL() );
459 wfProfileOut( __METHOD__ );
460 return;
463 $this->importFormData( $wgRequest );
464 $this->firsttime = false;
466 if ( $this->live ) {
467 $this->livePreview();
468 wfProfileOut( __METHOD__ );
469 return;
472 if ( wfReadOnly() && $this->save ) {
473 // Force preview
474 $this->save = false;
475 $this->preview = true;
478 if ( $this->save ) {
479 $this->formtype = 'save';
480 } elseif ( $this->preview ) {
481 $this->formtype = 'preview';
482 } elseif ( $this->diff ) {
483 $this->formtype = 'diff';
484 } else { # First time through
485 $this->firsttime = true;
486 if ( $this->previewOnOpen() ) {
487 $this->formtype = 'preview';
488 } else {
489 $this->formtype = 'initial';
493 $permErrors = $this->getEditPermissionErrors();
494 if ( $permErrors ) {
495 wfDebug( __METHOD__ . ": User can't edit\n" );
496 // Auto-block user's IP if the account was "hard" blocked
497 $wgUser->spreadAnyEditBlock();
499 $this->displayPermissionsError( $permErrors );
501 wfProfileOut( __METHOD__ );
502 return;
505 wfProfileIn( __METHOD__ . "-business-end" );
507 $this->isConflict = false;
508 // css / js subpages of user pages get a special treatment
509 $this->isCssJsSubpage = $this->mTitle->isCssJsSubpage();
510 $this->isCssSubpage = $this->mTitle->isCssSubpage();
511 $this->isJsSubpage = $this->mTitle->isJsSubpage();
512 // @todo FIXME: Silly assignment.
513 $this->isWrongCaseCssJsPage = $this->isWrongCaseCssJsPage();
515 # Show applicable editing introductions
516 if ( $this->formtype == 'initial' || $this->firsttime ) {
517 $this->showIntro();
520 # Attempt submission here. This will check for edit conflicts,
521 # and redundantly check for locked database, blocked IPs, etc.
522 # that edit() already checked just in case someone tries to sneak
523 # in the back door with a hand-edited submission URL.
525 if ( 'save' == $this->formtype ) {
526 if ( !$this->attemptSave() ) {
527 wfProfileOut( __METHOD__ . "-business-end" );
528 wfProfileOut( __METHOD__ );
529 return;
533 # First time through: get contents, set time for conflict
534 # checking, etc.
535 if ( 'initial' == $this->formtype || $this->firsttime ) {
536 if ( $this->initialiseForm() === false ) {
537 $this->noSuchSectionPage();
538 wfProfileOut( __METHOD__ . "-business-end" );
539 wfProfileOut( __METHOD__ );
540 return;
543 if ( !$this->mTitle->getArticleID() ) {
544 wfRunHooks( 'EditFormPreloadText', array( &$this->textbox1, &$this->mTitle ) );
545 } else {
546 wfRunHooks( 'EditFormInitialText', array( $this ) );
551 $this->showEditForm();
552 wfProfileOut( __METHOD__ . "-business-end" );
553 wfProfileOut( __METHOD__ );
557 * @return array
559 protected function getEditPermissionErrors() {
560 global $wgUser;
561 $permErrors = $this->mTitle->getUserPermissionsErrors( 'edit', $wgUser );
562 # Can this title be created?
563 if ( !$this->mTitle->exists() ) {
564 $permErrors = array_merge( $permErrors,
565 wfArrayDiff2( $this->mTitle->getUserPermissionsErrors( 'create', $wgUser ), $permErrors ) );
567 # Ignore some permissions errors when a user is just previewing/viewing diffs
568 $remove = array();
569 foreach ( $permErrors as $error ) {
570 if ( ( $this->preview || $this->diff )
571 && ( $error[0] == 'blockedtext' || $error[0] == 'autoblockedtext' )
573 $remove[] = $error;
576 $permErrors = wfArrayDiff2( $permErrors, $remove );
577 return $permErrors;
581 * Display a permissions error page, like OutputPage::showPermissionsErrorPage(),
582 * but with the following differences:
583 * - If redlink=1, the user will be redirected to the page
584 * - If there is content to display or the error occurs while either saving,
585 * previewing or showing the difference, it will be a
586 * "View source for ..." page displaying the source code after the error message.
588 * @since 1.19
589 * @param array $permErrors Array of permissions errors, as returned by
590 * Title::getUserPermissionsErrors().
591 * @throws PermissionsError
593 protected function displayPermissionsError( array $permErrors ) {
594 global $wgRequest, $wgOut;
596 if ( $wgRequest->getBool( 'redlink' ) ) {
597 // The edit page was reached via a red link.
598 // Redirect to the article page and let them click the edit tab if
599 // they really want a permission error.
600 $wgOut->redirect( $this->mTitle->getFullURL() );
601 return;
604 $content = $this->getContentObject();
606 # Use the normal message if there's nothing to display
607 if ( $this->firsttime && ( !$content || $content->isEmpty() ) ) {
608 $action = $this->mTitle->exists() ? 'edit' :
609 ( $this->mTitle->isTalkPage() ? 'createtalk' : 'createpage' );
610 throw new PermissionsError( $action, $permErrors );
613 wfRunHooks( 'EditPage::showReadOnlyForm:initial', array( $this, &$wgOut ) );
615 $wgOut->setRobotPolicy( 'noindex,nofollow' );
616 $wgOut->setPageTitle( wfMessage(
617 'viewsource-title',
618 $this->getContextTitle()->getPrefixedText()
619 ) );
620 $wgOut->addBacklinkSubtitle( $this->getContextTitle() );
621 $wgOut->addWikiText( $wgOut->formatPermissionsErrorMessage( $permErrors, 'edit' ) );
622 $wgOut->addHTML( "<hr />\n" );
624 # If the user made changes, preserve them when showing the markup
625 # (This happens when a user is blocked during edit, for instance)
626 if ( !$this->firsttime ) {
627 $text = $this->textbox1;
628 $wgOut->addWikiMsg( 'viewyourtext' );
629 } else {
630 $text = $this->toEditText( $content );
631 $wgOut->addWikiMsg( 'viewsourcetext' );
634 $this->showTextbox( $text, 'wpTextbox1', array( 'readonly' ) );
636 $wgOut->addHTML( Html::rawElement( 'div', array( 'class' => 'templatesUsed' ),
637 Linker::formatTemplates( $this->getTemplates() ) ) );
639 $wgOut->addModules( 'mediawiki.action.edit.collapsibleFooter' );
641 if ( $this->mTitle->exists() ) {
642 $wgOut->returnToMain( null, $this->mTitle );
647 * Show a read-only error
648 * Parameters are the same as OutputPage:readOnlyPage()
649 * Redirect to the article page if redlink=1
650 * @deprecated since 1.19; use displayPermissionsError() instead
652 function readOnlyPage( $source = null, $protected = false, $reasons = array(), $action = null ) {
653 wfDeprecated( __METHOD__, '1.19' );
655 global $wgRequest, $wgOut;
656 if ( $wgRequest->getBool( 'redlink' ) ) {
657 // The edit page was reached via a red link.
658 // Redirect to the article page and let them click the edit tab if
659 // they really want a permission error.
660 $wgOut->redirect( $this->mTitle->getFullURL() );
661 } else {
662 $wgOut->readOnlyPage( $source, $protected, $reasons, $action );
667 * Should we show a preview when the edit form is first shown?
669 * @return bool
671 protected function previewOnOpen() {
672 global $wgRequest, $wgUser, $wgPreviewOnOpenNamespaces;
673 if ( $wgRequest->getVal( 'preview' ) == 'yes' ) {
674 // Explicit override from request
675 return true;
676 } elseif ( $wgRequest->getVal( 'preview' ) == 'no' ) {
677 // Explicit override from request
678 return false;
679 } elseif ( $this->section == 'new' ) {
680 // Nothing *to* preview for new sections
681 return false;
682 } elseif ( ( $wgRequest->getVal( 'preload' ) !== null || $this->mTitle->exists() )
683 && $wgUser->getOption( 'previewonfirst' )
685 // Standard preference behavior
686 return true;
687 } elseif ( !$this->mTitle->exists()
688 && isset( $wgPreviewOnOpenNamespaces[$this->mTitle->getNamespace()] )
689 && $wgPreviewOnOpenNamespaces[$this->mTitle->getNamespace()]
691 // Categories are special
692 return true;
693 } else {
694 return false;
699 * Checks whether the user entered a skin name in uppercase,
700 * e.g. "User:Example/Monobook.css" instead of "monobook.css"
702 * @return bool
704 protected function isWrongCaseCssJsPage() {
705 if ( $this->mTitle->isCssJsSubpage() ) {
706 $name = $this->mTitle->getSkinFromCssJsSubpage();
707 $skins = array_merge(
708 array_keys( Skin::getSkinNames() ),
709 array( 'common' )
711 return !in_array( $name, $skins )
712 && in_array( strtolower( $name ), $skins );
713 } else {
714 return false;
719 * Returns whether section editing is supported for the current page.
720 * Subclasses may override this to replace the default behavior, which is
721 * to check ContentHandler::supportsSections.
723 * @return bool true if this edit page supports sections, false otherwise.
725 protected function isSectionEditSupported() {
726 $contentHandler = ContentHandler::getForTitle( $this->mTitle );
727 return $contentHandler->supportsSections();
731 * This function collects the form data and uses it to populate various member variables.
732 * @param WebRequest $request
733 * @throws ErrorPageError
735 function importFormData( &$request ) {
736 global $wgContLang, $wgUser;
738 wfProfileIn( __METHOD__ );
740 # Section edit can come from either the form or a link
741 $this->section = $request->getVal( 'wpSection', $request->getVal( 'section' ) );
743 if ( $this->section !== null && $this->section !== '' && !$this->isSectionEditSupported() ) {
744 wfProfileOut( __METHOD__ );
745 throw new ErrorPageError( 'sectioneditnotsupported-title', 'sectioneditnotsupported-text' );
748 $this->isNew = !$this->mTitle->exists() || $this->section == 'new';
750 if ( $request->wasPosted() ) {
751 # These fields need to be checked for encoding.
752 # Also remove trailing whitespace, but don't remove _initial_
753 # whitespace from the text boxes. This may be significant formatting.
754 $this->textbox1 = $this->safeUnicodeInput( $request, 'wpTextbox1' );
755 if ( !$request->getCheck( 'wpTextbox2' ) ) {
756 // Skip this if wpTextbox2 has input, it indicates that we came
757 // from a conflict page with raw page text, not a custom form
758 // modified by subclasses
759 wfProfileIn( get_class( $this ) . "::importContentFormData" );
760 $textbox1 = $this->importContentFormData( $request );
761 if ( $textbox1 !== null ) {
762 $this->textbox1 = $textbox1;
765 wfProfileOut( get_class( $this ) . "::importContentFormData" );
768 # Truncate for whole multibyte characters
769 $this->summary = $wgContLang->truncate( $request->getText( 'wpSummary' ), 255 );
771 # If the summary consists of a heading, e.g. '==Foobar==', extract the title from the
772 # header syntax, e.g. 'Foobar'. This is mainly an issue when we are using wpSummary for
773 # section titles.
774 $this->summary = preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->summary );
776 # Treat sectiontitle the same way as summary.
777 # Note that wpSectionTitle is not yet a part of the actual edit form, as wpSummary is
778 # currently doing double duty as both edit summary and section title. Right now this
779 # is just to allow API edits to work around this limitation, but this should be
780 # incorporated into the actual edit form when EditPage is rewritten (Bugs 18654, 26312).
781 $this->sectiontitle = $wgContLang->truncate( $request->getText( 'wpSectionTitle' ), 255 );
782 $this->sectiontitle = preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->sectiontitle );
784 $this->edittime = $request->getVal( 'wpEdittime' );
785 $this->starttime = $request->getVal( 'wpStarttime' );
787 $undidRev = $request->getInt( 'wpUndidRevision' );
788 if ( $undidRev ) {
789 $this->undidRev = $undidRev;
792 $this->scrolltop = $request->getIntOrNull( 'wpScrolltop' );
794 if ( $this->textbox1 === '' && $request->getVal( 'wpTextbox1' ) === null ) {
795 // wpTextbox1 field is missing, possibly due to being "too big"
796 // according to some filter rules such as Suhosin's setting for
797 // suhosin.request.max_value_length (d'oh)
798 $this->incompleteForm = true;
799 } else {
800 // If we receive the last parameter of the request, we can fairly
801 // claim the POST request has not been truncated.
803 // TODO: softened the check for cutover. Once we determine
804 // that it is safe, we should complete the transition by
805 // removing the "edittime" clause.
806 $this->incompleteForm = ( !$request->getVal( 'wpUltimateParam' ) && is_null( $this->edittime ) );
808 if ( $this->incompleteForm ) {
809 # If the form is incomplete, force to preview.
810 wfDebug( __METHOD__ . ": Form data appears to be incomplete\n" );
811 wfDebug( "POST DATA: " . var_export( $_POST, true ) . "\n" );
812 $this->preview = true;
813 } else {
814 /* Fallback for live preview */
815 $this->preview = $request->getCheck( 'wpPreview' ) || $request->getCheck( 'wpLivePreview' );
816 $this->diff = $request->getCheck( 'wpDiff' );
818 // Remember whether a save was requested, so we can indicate
819 // if we forced preview due to session failure.
820 $this->mTriedSave = !$this->preview;
822 if ( $this->tokenOk( $request ) ) {
823 # Some browsers will not report any submit button
824 # if the user hits enter in the comment box.
825 # The unmarked state will be assumed to be a save,
826 # if the form seems otherwise complete.
827 wfDebug( __METHOD__ . ": Passed token check.\n" );
828 } elseif ( $this->diff ) {
829 # Failed token check, but only requested "Show Changes".
830 wfDebug( __METHOD__ . ": Failed token check; Show Changes requested.\n" );
831 } else {
832 # Page might be a hack attempt posted from
833 # an external site. Preview instead of saving.
834 wfDebug( __METHOD__ . ": Failed token check; forcing preview\n" );
835 $this->preview = true;
838 $this->save = !$this->preview && !$this->diff;
839 if ( !preg_match( '/^\d{14}$/', $this->edittime ) ) {
840 $this->edittime = null;
843 if ( !preg_match( '/^\d{14}$/', $this->starttime ) ) {
844 $this->starttime = null;
847 $this->recreate = $request->getCheck( 'wpRecreate' );
849 $this->minoredit = $request->getCheck( 'wpMinoredit' );
850 $this->watchthis = $request->getCheck( 'wpWatchthis' );
852 # Don't force edit summaries when a user is editing their own user or talk page
853 if ( ( $this->mTitle->mNamespace == NS_USER || $this->mTitle->mNamespace == NS_USER_TALK )
854 && $this->mTitle->getText() == $wgUser->getName()
856 $this->allowBlankSummary = true;
857 } else {
858 $this->allowBlankSummary = $request->getBool( 'wpIgnoreBlankSummary' )
859 || !$wgUser->getOption( 'forceeditsummary' );
862 $this->autoSumm = $request->getText( 'wpAutoSummary' );
863 } else {
864 # Not a posted form? Start with nothing.
865 wfDebug( __METHOD__ . ": Not a posted form.\n" );
866 $this->textbox1 = '';
867 $this->summary = '';
868 $this->sectiontitle = '';
869 $this->edittime = '';
870 $this->starttime = wfTimestampNow();
871 $this->edit = false;
872 $this->preview = false;
873 $this->save = false;
874 $this->diff = false;
875 $this->minoredit = false;
876 // Watch may be overridden by request parameters
877 $this->watchthis = $request->getBool( 'watchthis', false );
878 $this->recreate = false;
880 // When creating a new section, we can preload a section title by passing it as the
881 // preloadtitle parameter in the URL (Bug 13100)
882 if ( $this->section == 'new' && $request->getVal( 'preloadtitle' ) ) {
883 $this->sectiontitle = $request->getVal( 'preloadtitle' );
884 // Once wpSummary isn't being use for setting section titles, we should delete this.
885 $this->summary = $request->getVal( 'preloadtitle' );
886 } elseif ( $this->section != 'new' && $request->getVal( 'summary' ) ) {
887 $this->summary = $request->getText( 'summary' );
888 if ( $this->summary !== '' ) {
889 $this->hasPresetSummary = true;
893 if ( $request->getVal( 'minor' ) ) {
894 $this->minoredit = true;
898 $this->oldid = $request->getInt( 'oldid' );
900 $this->bot = $request->getBool( 'bot', true );
901 $this->nosummary = $request->getBool( 'nosummary' );
903 // May be overridden by revision.
904 $this->contentModel = $request->getText( 'model', $this->contentModel );
905 // May be overridden by revision.
906 $this->contentFormat = $request->getText( 'format', $this->contentFormat );
908 if ( !ContentHandler::getForModelID( $this->contentModel )
909 ->isSupportedFormat( $this->contentFormat )
911 throw new ErrorPageError(
912 'editpage-notsupportedcontentformat-title',
913 'editpage-notsupportedcontentformat-text',
914 array( $this->contentFormat, ContentHandler::getLocalizedName( $this->contentModel ) )
919 * @todo Check if the desired model is allowed in this namespace, and if
920 * a transition from the page's current model to the new model is
921 * allowed.
924 $this->live = $request->getCheck( 'live' );
925 $this->editintro = $request->getText( 'editintro',
926 // Custom edit intro for new sections
927 $this->section === 'new' ? 'MediaWiki:addsection-editintro' : '' );
929 // Allow extensions to modify form data
930 wfRunHooks( 'EditPage::importFormData', array( $this, $request ) );
932 wfProfileOut( __METHOD__ );
936 * Subpage overridable method for extracting the page content data from the
937 * posted form to be placed in $this->textbox1, if using customized input
938 * this method should be overridden and return the page text that will be used
939 * for saving, preview parsing and so on...
941 * @param WebRequest $request
943 protected function importContentFormData( &$request ) {
944 return; // Don't do anything, EditPage already extracted wpTextbox1
948 * Initialise form fields in the object
949 * Called on the first invocation, e.g. when a user clicks an edit link
950 * @return bool If the requested section is valid
952 function initialiseForm() {
953 global $wgUser;
954 $this->edittime = $this->mArticle->getTimestamp();
956 $content = $this->getContentObject( false ); #TODO: track content object?!
957 if ( $content === false ) {
958 return false;
960 $this->textbox1 = $this->toEditText( $content );
962 // activate checkboxes if user wants them to be always active
963 # Sort out the "watch" checkbox
964 if ( $wgUser->getOption( 'watchdefault' ) ) {
965 # Watch all edits
966 $this->watchthis = true;
967 } elseif ( $wgUser->getOption( 'watchcreations' ) && !$this->mTitle->exists() ) {
968 # Watch creations
969 $this->watchthis = true;
970 } elseif ( $wgUser->isWatched( $this->mTitle ) ) {
971 # Already watched
972 $this->watchthis = true;
974 if ( $wgUser->getOption( 'minordefault' ) && !$this->isNew ) {
975 $this->minoredit = true;
977 if ( $this->textbox1 === false ) {
978 return false;
980 return true;
984 * Fetch initial editing page content.
986 * @param string|bool $def_text
987 * @return string|bool string on success, $def_text for invalid sections
988 * @private
989 * @deprecated since 1.21, get WikiPage::getContent() instead.
991 function getContent( $def_text = false ) {
992 ContentHandler::deprecated( __METHOD__, '1.21' );
994 if ( $def_text !== null && $def_text !== false && $def_text !== '' ) {
995 $def_content = $this->toEditContent( $def_text );
996 } else {
997 $def_content = false;
1000 $content = $this->getContentObject( $def_content );
1002 // Note: EditPage should only be used with text based content anyway.
1003 return $this->toEditText( $content );
1007 * @param Content|null $def_content The default value to return
1009 * @return Content|null Content on success, $def_content for invalid sections
1011 * @since 1.21
1013 protected function getContentObject( $def_content = null ) {
1014 global $wgOut, $wgRequest, $wgUser, $wgContLang;
1016 wfProfileIn( __METHOD__ );
1018 $content = false;
1020 // For message page not locally set, use the i18n message.
1021 // For other non-existent articles, use preload text if any.
1022 if ( !$this->mTitle->exists() || $this->section == 'new' ) {
1023 if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI && $this->section != 'new' ) {
1024 # If this is a system message, get the default text.
1025 $msg = $this->mTitle->getDefaultMessageText();
1027 $content = $this->toEditContent( $msg );
1029 if ( $content === false ) {
1030 # If requested, preload some text.
1031 $preload = $wgRequest->getVal( 'preload',
1032 // Custom preload text for new sections
1033 $this->section === 'new' ? 'MediaWiki:addsection-preload' : '' );
1034 $params = $wgRequest->getArray( 'preloadparams', array() );
1036 $content = $this->getPreloadedContent( $preload, $params );
1038 // For existing pages, get text based on "undo" or section parameters.
1039 } else {
1040 if ( $this->section != '' ) {
1041 // Get section edit text (returns $def_text for invalid sections)
1042 $orig = $this->getOriginalContent( $wgUser );
1043 $content = $orig ? $orig->getSection( $this->section ) : null;
1045 if ( !$content ) {
1046 $content = $def_content;
1048 } else {
1049 $undoafter = $wgRequest->getInt( 'undoafter' );
1050 $undo = $wgRequest->getInt( 'undo' );
1052 if ( $undo > 0 && $undoafter > 0 ) {
1054 $undorev = Revision::newFromId( $undo );
1055 $oldrev = Revision::newFromId( $undoafter );
1057 # Sanity check, make sure it's the right page,
1058 # the revisions exist and they were not deleted.
1059 # Otherwise, $content will be left as-is.
1060 if ( !is_null( $undorev ) && !is_null( $oldrev ) &&
1061 !$undorev->isDeleted( Revision::DELETED_TEXT ) &&
1062 !$oldrev->isDeleted( Revision::DELETED_TEXT ) ) {
1064 $content = $this->mArticle->getUndoContent( $undorev, $oldrev );
1066 if ( $content === false ) {
1067 # Warn the user that something went wrong
1068 $undoMsg = 'failure';
1069 } else {
1070 $oldContent = $this->mArticle->getPage()->getContent( Revision::RAW );
1071 $popts = ParserOptions::newFromUserAndLang( $wgUser, $wgContLang );
1072 $newContent = $content->preSaveTransform( $this->mTitle, $wgUser, $popts );
1074 if ( $newContent->equals( $oldContent ) ) {
1075 # Tell the user that the undo results in no change,
1076 # i.e. the revisions were already undone.
1077 $undoMsg = 'nochange';
1078 $content = false;
1079 } else {
1080 # Inform the user of our success and set an automatic edit summary
1081 $undoMsg = 'success';
1083 # If we just undid one rev, use an autosummary
1084 $firstrev = $oldrev->getNext();
1085 if ( $firstrev && $firstrev->getId() == $undo ) {
1086 $userText = $undorev->getUserText();
1087 if ( $userText === '' ) {
1088 $undoSummary = wfMessage(
1089 'undo-summary-username-hidden',
1090 $undo
1091 )->inContentLanguage()->text();
1092 } else {
1093 $undoSummary = wfMessage(
1094 'undo-summary',
1095 $undo,
1096 $userText
1097 )->inContentLanguage()->text();
1099 if ( $this->summary === '' ) {
1100 $this->summary = $undoSummary;
1101 } else {
1102 $this->summary = $undoSummary . wfMessage( 'colon-separator' )
1103 ->inContentLanguage()->text() . $this->summary;
1105 $this->undidRev = $undo;
1107 $this->formtype = 'diff';
1110 } else {
1111 // Failed basic sanity checks.
1112 // Older revisions may have been removed since the link
1113 // was created, or we may simply have got bogus input.
1114 $undoMsg = 'norev';
1117 // Messages: undo-success, undo-failure, undo-norev, undo-nochange
1118 $class = ( $undoMsg == 'success' ? '' : 'error ' ) . "mw-undo-{$undoMsg}";
1119 $this->editFormPageTop .= $wgOut->parse( "<div class=\"{$class}\">" .
1120 wfMessage( 'undo-' . $undoMsg )->plain() . '</div>', true, /* interface */true );
1123 if ( $content === false ) {
1124 $content = $this->getOriginalContent( $wgUser );
1129 wfProfileOut( __METHOD__ );
1130 return $content;
1134 * Get the content of the wanted revision, without section extraction.
1136 * The result of this function can be used to compare user's input with
1137 * section replaced in its context (using WikiPage::replaceSection())
1138 * to the original text of the edit.
1140 * This differs from Article::getContent() that when a missing revision is
1141 * encountered the result will be null and not the
1142 * 'missing-revision' message.
1144 * @since 1.19
1145 * @param User $user The user to get the revision for
1146 * @return Content|null
1148 private function getOriginalContent( User $user ) {
1149 if ( $this->section == 'new' ) {
1150 return $this->getCurrentContent();
1152 $revision = $this->mArticle->getRevisionFetched();
1153 if ( $revision === null ) {
1154 if ( !$this->contentModel ) {
1155 $this->contentModel = $this->getTitle()->getContentModel();
1157 $handler = ContentHandler::getForModelID( $this->contentModel );
1159 return $handler->makeEmptyContent();
1161 $content = $revision->getContent( Revision::FOR_THIS_USER, $user );
1162 return $content;
1166 * Get the current content of the page. This is basically similar to
1167 * WikiPage::getContent( Revision::RAW ) except that when the page doesn't exist an empty
1168 * content object is returned instead of null.
1170 * @since 1.21
1171 * @return Content
1173 protected function getCurrentContent() {
1174 $rev = $this->mArticle->getRevision();
1175 $content = $rev ? $rev->getContent( Revision::RAW ) : null;
1177 if ( $content === false || $content === null ) {
1178 if ( !$this->contentModel ) {
1179 $this->contentModel = $this->getTitle()->getContentModel();
1181 $handler = ContentHandler::getForModelID( $this->contentModel );
1183 return $handler->makeEmptyContent();
1184 } else {
1185 # nasty side-effect, but needed for consistency
1186 $this->contentModel = $rev->getContentModel();
1187 $this->contentFormat = $rev->getContentFormat();
1189 return $content;
1194 * Use this method before edit() to preload some text into the edit box
1196 * @param string $text
1197 * @deprecated since 1.21, use setPreloadedContent() instead.
1199 public function setPreloadedText( $text ) {
1200 ContentHandler::deprecated( __METHOD__, "1.21" );
1202 $content = $this->toEditContent( $text );
1204 $this->setPreloadedContent( $content );
1208 * Use this method before edit() to preload some content into the edit box
1210 * @param Content $content
1212 * @since 1.21
1214 public function setPreloadedContent( Content $content ) {
1215 $this->mPreloadContent = $content;
1219 * Get the contents to be preloaded into the box, either set by
1220 * an earlier setPreloadText() or by loading the given page.
1222 * @param string $preload representing the title to preload from.
1224 * @return string
1226 * @deprecated since 1.21, use getPreloadedContent() instead
1228 protected function getPreloadedText( $preload ) {
1229 ContentHandler::deprecated( __METHOD__, "1.21" );
1231 $content = $this->getPreloadedContent( $preload );
1232 $text = $this->toEditText( $content );
1234 return $text;
1238 * Get the contents to be preloaded into the box, either set by
1239 * an earlier setPreloadText() or by loading the given page.
1241 * @param string $preload Representing the title to preload from.
1242 * @param array $params Parameters to use (interface-message style) in the preloaded text
1244 * @return Content
1246 * @since 1.21
1248 protected function getPreloadedContent( $preload, $params = array() ) {
1249 global $wgUser;
1251 if ( !empty( $this->mPreloadContent ) ) {
1252 return $this->mPreloadContent;
1255 $handler = ContentHandler::getForTitle( $this->getTitle() );
1257 if ( $preload === '' ) {
1258 return $handler->makeEmptyContent();
1261 $title = Title::newFromText( $preload );
1262 # Check for existence to avoid getting MediaWiki:Noarticletext
1263 if ( $title === null || !$title->exists() || !$title->userCan( 'read', $wgUser ) ) {
1264 //TODO: somehow show a warning to the user!
1265 return $handler->makeEmptyContent();
1268 $page = WikiPage::factory( $title );
1269 if ( $page->isRedirect() ) {
1270 $title = $page->getRedirectTarget();
1271 # Same as before
1272 if ( $title === null || !$title->exists() || !$title->userCan( 'read', $wgUser ) ) {
1273 //TODO: somehow show a warning to the user!
1274 return $handler->makeEmptyContent();
1276 $page = WikiPage::factory( $title );
1279 $parserOptions = ParserOptions::newFromUser( $wgUser );
1280 $content = $page->getContent( Revision::RAW );
1282 if ( !$content ) {
1283 //TODO: somehow show a warning to the user!
1284 return $handler->makeEmptyContent();
1287 if ( $content->getModel() !== $handler->getModelID() ) {
1288 $converted = $content->convert( $handler->getModelID() );
1290 if ( !$converted ) {
1291 //TODO: somehow show a warning to the user!
1292 wfDebug( "Attempt to preload incompatible content: "
1293 . "can't convert " . $content->getModel()
1294 . " to " . $handler->getModelID() );
1296 return $handler->makeEmptyContent();
1299 $content = $converted;
1302 return $content->preloadTransform( $title, $parserOptions, $params );
1306 * Make sure the form isn't faking a user's credentials.
1308 * @param WebRequest $request
1309 * @return bool
1310 * @private
1312 function tokenOk( &$request ) {
1313 global $wgUser;
1314 $token = $request->getVal( 'wpEditToken' );
1315 $this->mTokenOk = $wgUser->matchEditToken( $token );
1316 $this->mTokenOkExceptSuffix = $wgUser->matchEditTokenNoSuffix( $token );
1317 return $this->mTokenOk;
1321 * Sets post-edit cookie indicating the user just saved a particular revision.
1323 * This uses a temporary cookie for each revision ID so separate saves will never
1324 * interfere with each other.
1326 * The cookie is deleted in the mediawiki.action.view.postEdit JS module after
1327 * the redirect. It must be clearable by JavaScript code, so it must not be
1328 * marked HttpOnly. The JavaScript code converts the cookie to a wgPostEdit config
1329 * variable.
1331 * If the variable were set on the server, it would be cached, which is unwanted
1332 * since the post-edit state should only apply to the load right after the save.
1334 * @param $statusValue int The status value (to check for new article status)
1336 protected function setPostEditCookie( $statusValue ) {
1337 $revisionId = $this->mArticle->getLatest();
1338 $postEditKey = self::POST_EDIT_COOKIE_KEY_PREFIX . $revisionId;
1340 $val = 'saved';
1341 if ( $statusValue == self::AS_SUCCESS_NEW_ARTICLE ) {
1342 $val = 'created';
1343 } elseif ( $this->oldid ) {
1344 $val = 'restored';
1347 $response = RequestContext::getMain()->getRequest()->response();
1348 $response->setcookie( $postEditKey, $val, time() + self::POST_EDIT_COOKIE_DURATION, array(
1349 'httpOnly' => false,
1350 ) );
1354 * Attempt submission
1355 * @throws UserBlockedError|ReadOnlyError|ThrottledError|PermissionsError
1356 * @return bool false if output is done, true if the rest of the form should be displayed
1358 public function attemptSave() {
1359 global $wgUser;
1361 $resultDetails = false;
1362 # Allow bots to exempt some edits from bot flagging
1363 $bot = $wgUser->isAllowed( 'bot' ) && $this->bot;
1364 $status = $this->internalAttemptSave( $resultDetails, $bot );
1366 return $this->handleStatus( $status, $resultDetails );
1370 * Handle status, such as after attempt save
1372 * @param Status $status
1373 * @param array|bool $resultDetails
1375 * @throws ErrorPageError
1376 * @return bool false, if output is done, true if rest of the form should be displayed
1378 private function handleStatus( Status $status, $resultDetails ) {
1379 global $wgUser, $wgOut;
1382 * @todo FIXME: once the interface for internalAttemptSave() is made
1383 * nicer, this should use the message in $status
1385 if ( $status->value == self::AS_SUCCESS_UPDATE
1386 || $status->value == self::AS_SUCCESS_NEW_ARTICLE
1388 $this->didSave = true;
1389 if ( !$resultDetails['nullEdit'] ) {
1390 $this->setPostEditCookie( $status->value );
1394 switch ( $status->value ) {
1395 case self::AS_HOOK_ERROR_EXPECTED:
1396 case self::AS_CONTENT_TOO_BIG:
1397 case self::AS_ARTICLE_WAS_DELETED:
1398 case self::AS_CONFLICT_DETECTED:
1399 case self::AS_SUMMARY_NEEDED:
1400 case self::AS_TEXTBOX_EMPTY:
1401 case self::AS_MAX_ARTICLE_SIZE_EXCEEDED:
1402 case self::AS_END:
1403 return true;
1405 case self::AS_HOOK_ERROR:
1406 return false;
1408 case self::AS_PARSE_ERROR:
1409 $wgOut->addWikiText( '<div class="error">' . $status->getWikiText() . '</div>' );
1410 return true;
1412 case self::AS_SUCCESS_NEW_ARTICLE:
1413 $query = $resultDetails['redirect'] ? 'redirect=no' : '';
1414 $anchor = isset( $resultDetails['sectionanchor'] ) ? $resultDetails['sectionanchor'] : '';
1415 $wgOut->redirect( $this->mTitle->getFullURL( $query ) . $anchor );
1416 return false;
1418 case self::AS_SUCCESS_UPDATE:
1419 $extraQuery = '';
1420 $sectionanchor = $resultDetails['sectionanchor'];
1422 // Give extensions a chance to modify URL query on update
1423 wfRunHooks(
1424 'ArticleUpdateBeforeRedirect',
1425 array( $this->mArticle, &$sectionanchor, &$extraQuery )
1428 if ( $resultDetails['redirect'] ) {
1429 if ( $extraQuery == '' ) {
1430 $extraQuery = 'redirect=no';
1431 } else {
1432 $extraQuery = 'redirect=no&' . $extraQuery;
1435 $wgOut->redirect( $this->mTitle->getFullURL( $extraQuery ) . $sectionanchor );
1436 return false;
1438 case self::AS_BLANK_ARTICLE:
1439 $wgOut->redirect( $this->getContextTitle()->getFullURL() );
1440 return false;
1442 case self::AS_SPAM_ERROR:
1443 $this->spamPageWithContent( $resultDetails['spam'] );
1444 return false;
1446 case self::AS_BLOCKED_PAGE_FOR_USER:
1447 throw new UserBlockedError( $wgUser->getBlock() );
1449 case self::AS_IMAGE_REDIRECT_ANON:
1450 case self::AS_IMAGE_REDIRECT_LOGGED:
1451 throw new PermissionsError( 'upload' );
1453 case self::AS_READ_ONLY_PAGE_ANON:
1454 case self::AS_READ_ONLY_PAGE_LOGGED:
1455 throw new PermissionsError( 'edit' );
1457 case self::AS_READ_ONLY_PAGE:
1458 throw new ReadOnlyError;
1460 case self::AS_RATE_LIMITED:
1461 throw new ThrottledError();
1463 case self::AS_NO_CREATE_PERMISSION:
1464 $permission = $this->mTitle->isTalkPage() ? 'createtalk' : 'createpage';
1465 throw new PermissionsError( $permission );
1467 default:
1468 // We don't recognize $status->value. The only way that can happen
1469 // is if an extension hook aborted from inside ArticleSave.
1470 // Render the status object into $this->hookError
1471 // FIXME this sucks, we should just use the Status object throughout
1472 $this->hookError = '<div class="error">' . $status->getWikitext() .
1473 '</div>';
1474 return true;
1479 * Run hooks that can filter edits just before they get saved.
1481 * @param Content $content The Content to filter.
1482 * @param Status $status For reporting the outcome to the caller
1483 * @param User $user The user performing the edit
1485 * @return bool
1487 protected function runPostMergeFilters( Content $content, Status $status, User $user ) {
1488 // Run old style post-section-merge edit filter
1489 if ( !ContentHandler::runLegacyHooks( 'EditFilterMerged',
1490 array( $this, $content, &$this->hookError, $this->summary ) ) ) {
1492 # Error messages etc. could be handled within the hook...
1493 $status->fatal( 'hookaborted' );
1494 $status->value = self::AS_HOOK_ERROR;
1495 return false;
1496 } elseif ( $this->hookError != '' ) {
1497 # ...or the hook could be expecting us to produce an error
1498 $status->fatal( 'hookaborted' );
1499 $status->value = self::AS_HOOK_ERROR_EXPECTED;
1500 return false;
1503 // Run new style post-section-merge edit filter
1504 if ( !wfRunHooks( 'EditFilterMergedContent',
1505 array( $this->mArticle->getContext(), $content, $status, $this->summary,
1506 $user, $this->minoredit ) ) ) {
1508 # Error messages etc. could be handled within the hook...
1509 // XXX: $status->value may already be something informative...
1510 $this->hookError = $status->getWikiText();
1511 $status->fatal( 'hookaborted' );
1512 $status->value = self::AS_HOOK_ERROR;
1513 return false;
1514 } elseif ( !$status->isOK() ) {
1515 # ...or the hook could be expecting us to produce an error
1516 // FIXME this sucks, we should just use the Status object throughout
1517 $this->hookError = $status->getWikiText();
1518 $status->fatal( 'hookaborted' );
1519 $status->value = self::AS_HOOK_ERROR_EXPECTED;
1520 return false;
1523 return true;
1527 * Attempt submission (no UI)
1529 * @param array $result Array to add statuses to, currently with the
1530 * possible keys:
1531 * - spam (string): Spam string from content if any spam is detected by
1532 * matchSpamRegex.
1533 * - sectionanchor (string): Section anchor for a section save.
1534 * - nullEdit (boolean): Set if doEditContent is OK. True if null edit,
1535 * false otherwise.
1536 * - redirect (bool): Set if doEditContent is OK. True if resulting
1537 * revision is a redirect.
1538 * @param bool $bot True if edit is being made under the bot right.
1540 * @return Status Status object, possibly with a message, but always with
1541 * one of the AS_* constants in $status->value,
1543 * @todo FIXME: This interface is TERRIBLE, but hard to get rid of due to
1544 * various error display idiosyncrasies. There are also lots of cases
1545 * where error metadata is set in the object and retrieved later instead
1546 * of being returned, e.g. AS_CONTENT_TOO_BIG and
1547 * AS_BLOCKED_PAGE_FOR_USER. All that stuff needs to be cleaned up some
1548 * time.
1550 function internalAttemptSave( &$result, $bot = false ) {
1551 global $wgUser, $wgRequest, $wgParser, $wgMaxArticleSize;
1553 $status = Status::newGood();
1555 wfProfileIn( __METHOD__ );
1556 wfProfileIn( __METHOD__ . '-checks' );
1558 if ( !wfRunHooks( 'EditPage::attemptSave', array( $this ) ) ) {
1559 wfDebug( "Hook 'EditPage::attemptSave' aborted article saving\n" );
1560 $status->fatal( 'hookaborted' );
1561 $status->value = self::AS_HOOK_ERROR;
1562 wfProfileOut( __METHOD__ . '-checks' );
1563 wfProfileOut( __METHOD__ );
1564 return $status;
1567 $spam = $wgRequest->getText( 'wpAntispam' );
1568 if ( $spam !== '' ) {
1569 wfDebugLog(
1570 'SimpleAntiSpam',
1571 $wgUser->getName() .
1572 ' editing "' .
1573 $this->mTitle->getPrefixedText() .
1574 '" submitted bogus field "' .
1575 $spam .
1578 $status->fatal( 'spamprotectionmatch', false );
1579 $status->value = self::AS_SPAM_ERROR;
1580 wfProfileOut( __METHOD__ . '-checks' );
1581 wfProfileOut( __METHOD__ );
1582 return $status;
1585 try {
1586 # Construct Content object
1587 $textbox_content = $this->toEditContent( $this->textbox1 );
1588 } catch ( MWContentSerializationException $ex ) {
1589 $status->fatal(
1590 'content-failed-to-parse',
1591 $this->contentModel,
1592 $this->contentFormat,
1593 $ex->getMessage()
1595 $status->value = self::AS_PARSE_ERROR;
1596 wfProfileOut( __METHOD__ . '-checks' );
1597 wfProfileOut( __METHOD__ );
1598 return $status;
1601 # Check image redirect
1602 if ( $this->mTitle->getNamespace() == NS_FILE &&
1603 $textbox_content->isRedirect() &&
1604 !$wgUser->isAllowed( 'upload' )
1606 $code = $wgUser->isAnon() ? self::AS_IMAGE_REDIRECT_ANON : self::AS_IMAGE_REDIRECT_LOGGED;
1607 $status->setResult( false, $code );
1609 wfProfileOut( __METHOD__ . '-checks' );
1610 wfProfileOut( __METHOD__ );
1612 return $status;
1615 # Check for spam
1616 $match = self::matchSummarySpamRegex( $this->summary );
1617 if ( $match === false && $this->section == 'new' ) {
1618 # $wgSpamRegex is enforced on this new heading/summary because, unlike
1619 # regular summaries, it is added to the actual wikitext.
1620 if ( $this->sectiontitle !== '' ) {
1621 # This branch is taken when the API is used with the 'sectiontitle' parameter.
1622 $match = self::matchSpamRegex( $this->sectiontitle );
1623 } else {
1624 # This branch is taken when the "Add Topic" user interface is used, or the API
1625 # is used with the 'summary' parameter.
1626 $match = self::matchSpamRegex( $this->summary );
1629 if ( $match === false ) {
1630 $match = self::matchSpamRegex( $this->textbox1 );
1632 if ( $match !== false ) {
1633 $result['spam'] = $match;
1634 $ip = $wgRequest->getIP();
1635 $pdbk = $this->mTitle->getPrefixedDBkey();
1636 $match = str_replace( "\n", '', $match );
1637 wfDebugLog( 'SpamRegex', "$ip spam regex hit [[$pdbk]]: \"$match\"" );
1638 $status->fatal( 'spamprotectionmatch', $match );
1639 $status->value = self::AS_SPAM_ERROR;
1640 wfProfileOut( __METHOD__ . '-checks' );
1641 wfProfileOut( __METHOD__ );
1642 return $status;
1644 if ( !wfRunHooks(
1645 'EditFilter',
1646 array( $this, $this->textbox1, $this->section, &$this->hookError, $this->summary ) )
1648 # Error messages etc. could be handled within the hook...
1649 $status->fatal( 'hookaborted' );
1650 $status->value = self::AS_HOOK_ERROR;
1651 wfProfileOut( __METHOD__ . '-checks' );
1652 wfProfileOut( __METHOD__ );
1653 return $status;
1654 } elseif ( $this->hookError != '' ) {
1655 # ...or the hook could be expecting us to produce an error
1656 $status->fatal( 'hookaborted' );
1657 $status->value = self::AS_HOOK_ERROR_EXPECTED;
1658 wfProfileOut( __METHOD__ . '-checks' );
1659 wfProfileOut( __METHOD__ );
1660 return $status;
1663 if ( $wgUser->isBlockedFrom( $this->mTitle, false ) ) {
1664 // Auto-block user's IP if the account was "hard" blocked
1665 $wgUser->spreadAnyEditBlock();
1666 # Check block state against master, thus 'false'.
1667 $status->setResult( false, self::AS_BLOCKED_PAGE_FOR_USER );
1668 wfProfileOut( __METHOD__ . '-checks' );
1669 wfProfileOut( __METHOD__ );
1670 return $status;
1673 $this->kblength = (int)( strlen( $this->textbox1 ) / 1024 );
1674 if ( $this->kblength > $wgMaxArticleSize ) {
1675 // Error will be displayed by showEditForm()
1676 $this->tooBig = true;
1677 $status->setResult( false, self::AS_CONTENT_TOO_BIG );
1678 wfProfileOut( __METHOD__ . '-checks' );
1679 wfProfileOut( __METHOD__ );
1680 return $status;
1683 if ( !$wgUser->isAllowed( 'edit' ) ) {
1684 if ( $wgUser->isAnon() ) {
1685 $status->setResult( false, self::AS_READ_ONLY_PAGE_ANON );
1686 wfProfileOut( __METHOD__ . '-checks' );
1687 wfProfileOut( __METHOD__ );
1688 return $status;
1689 } else {
1690 $status->fatal( 'readonlytext' );
1691 $status->value = self::AS_READ_ONLY_PAGE_LOGGED;
1692 wfProfileOut( __METHOD__ . '-checks' );
1693 wfProfileOut( __METHOD__ );
1694 return $status;
1698 if ( wfReadOnly() ) {
1699 $status->fatal( 'readonlytext' );
1700 $status->value = self::AS_READ_ONLY_PAGE;
1701 wfProfileOut( __METHOD__ . '-checks' );
1702 wfProfileOut( __METHOD__ );
1703 return $status;
1705 if ( $wgUser->pingLimiter() || $wgUser->pingLimiter( 'linkpurge', 0 ) ) {
1706 $status->fatal( 'actionthrottledtext' );
1707 $status->value = self::AS_RATE_LIMITED;
1708 wfProfileOut( __METHOD__ . '-checks' );
1709 wfProfileOut( __METHOD__ );
1710 return $status;
1713 # If the article has been deleted while editing, don't save it without
1714 # confirmation
1715 if ( $this->wasDeletedSinceLastEdit() && !$this->recreate ) {
1716 $status->setResult( false, self::AS_ARTICLE_WAS_DELETED );
1717 wfProfileOut( __METHOD__ . '-checks' );
1718 wfProfileOut( __METHOD__ );
1719 return $status;
1722 wfProfileOut( __METHOD__ . '-checks' );
1724 # Load the page data from the master. If anything changes in the meantime,
1725 # we detect it by using page_latest like a token in a 1 try compare-and-swap.
1726 $this->mArticle->loadPageData( 'fromdbmaster' );
1727 $new = !$this->mArticle->exists();
1729 if ( $new ) {
1730 // Late check for create permission, just in case *PARANOIA*
1731 if ( !$this->mTitle->userCan( 'create', $wgUser ) ) {
1732 $status->fatal( 'nocreatetext' );
1733 $status->value = self::AS_NO_CREATE_PERMISSION;
1734 wfDebug( __METHOD__ . ": no create permission\n" );
1735 wfProfileOut( __METHOD__ );
1736 return $status;
1739 // Don't save a new page if it's blank or if it's a MediaWiki:
1740 // message with content equivalent to default (allow empty pages
1741 // in this case to disable messages, see bug 50124)
1742 $defaultMessageText = $this->mTitle->getDefaultMessageText();
1743 if ( $this->mTitle->getNamespace() === NS_MEDIAWIKI && $defaultMessageText !== false ) {
1744 $defaultText = $defaultMessageText;
1745 } else {
1746 $defaultText = '';
1749 if ( $this->textbox1 === $defaultText ) {
1750 $status->setResult( false, self::AS_BLANK_ARTICLE );
1751 wfProfileOut( __METHOD__ );
1752 return $status;
1755 if ( !$this->runPostMergeFilters( $textbox_content, $status, $wgUser ) ) {
1756 wfProfileOut( __METHOD__ );
1757 return $status;
1760 $content = $textbox_content;
1762 $result['sectionanchor'] = '';
1763 if ( $this->section == 'new' ) {
1764 if ( $this->sectiontitle !== '' ) {
1765 // Insert the section title above the content.
1766 $content = $content->addSectionHeader( $this->sectiontitle );
1768 // Jump to the new section
1769 $result['sectionanchor'] =
1770 $wgParser->guessLegacySectionNameFromWikiText( $this->sectiontitle );
1772 // If no edit summary was specified, create one automatically from the section
1773 // title and have it link to the new section. Otherwise, respect the summary as
1774 // passed.
1775 if ( $this->summary === '' ) {
1776 $cleanSectionTitle = $wgParser->stripSectionName( $this->sectiontitle );
1777 $this->summary = wfMessage( 'newsectionsummary' )
1778 ->rawParams( $cleanSectionTitle )->inContentLanguage()->text();
1780 } elseif ( $this->summary !== '' ) {
1781 // Insert the section title above the content.
1782 $content = $content->addSectionHeader( $this->summary );
1784 // Jump to the new section
1785 $result['sectionanchor'] = $wgParser->guessLegacySectionNameFromWikiText( $this->summary );
1787 // Create a link to the new section from the edit summary.
1788 $cleanSummary = $wgParser->stripSectionName( $this->summary );
1789 $this->summary = wfMessage( 'newsectionsummary' )
1790 ->rawParams( $cleanSummary )->inContentLanguage()->text();
1794 $status->value = self::AS_SUCCESS_NEW_ARTICLE;
1796 } else { # not $new
1798 # Article exists. Check for edit conflict.
1800 $this->mArticle->clear(); # Force reload of dates, etc.
1801 $timestamp = $this->mArticle->getTimestamp();
1803 wfDebug( "timestamp: {$timestamp}, edittime: {$this->edittime}\n" );
1805 if ( $timestamp != $this->edittime ) {
1806 $this->isConflict = true;
1807 if ( $this->section == 'new' ) {
1808 if ( $this->mArticle->getUserText() == $wgUser->getName() &&
1809 $this->mArticle->getComment() == $this->summary ) {
1810 // Probably a duplicate submission of a new comment.
1811 // This can happen when squid resends a request after
1812 // a timeout but the first one actually went through.
1813 wfDebug( __METHOD__
1814 . ": duplicate new section submission; trigger edit conflict!\n" );
1815 } else {
1816 // New comment; suppress conflict.
1817 $this->isConflict = false;
1818 wfDebug( __METHOD__ . ": conflict suppressed; new section\n" );
1820 } elseif ( $this->section == ''
1821 && Revision::userWasLastToEdit(
1822 DB_MASTER, $this->mTitle->getArticleID(),
1823 $wgUser->getId(), $this->edittime
1826 # Suppress edit conflict with self, except for section edits where merging is required.
1827 wfDebug( __METHOD__ . ": Suppressing edit conflict, same user.\n" );
1828 $this->isConflict = false;
1832 // If sectiontitle is set, use it, otherwise use the summary as the section title.
1833 if ( $this->sectiontitle !== '' ) {
1834 $sectionTitle = $this->sectiontitle;
1835 } else {
1836 $sectionTitle = $this->summary;
1839 $content = null;
1841 if ( $this->isConflict ) {
1842 wfDebug( __METHOD__
1843 . ": conflict! getting section '{$this->section}' for time '{$this->edittime}'"
1844 . " (article time '{$timestamp}')\n" );
1846 $content = $this->mArticle->replaceSectionContent(
1847 $this->section,
1848 $textbox_content,
1849 $sectionTitle,
1850 $this->edittime
1852 } else {
1853 wfDebug( __METHOD__ . ": getting section '{$this->section}'\n" );
1854 $content = $this->mArticle->replaceSectionContent(
1855 $this->section,
1856 $textbox_content,
1857 $sectionTitle
1861 if ( is_null( $content ) ) {
1862 wfDebug( __METHOD__ . ": activating conflict; section replace failed.\n" );
1863 $this->isConflict = true;
1864 $content = $textbox_content; // do not try to merge here!
1865 } elseif ( $this->isConflict ) {
1866 # Attempt merge
1867 if ( $this->mergeChangesIntoContent( $content ) ) {
1868 // Successful merge! Maybe we should tell the user the good news?
1869 $this->isConflict = false;
1870 wfDebug( __METHOD__ . ": Suppressing edit conflict, successful merge.\n" );
1871 } else {
1872 $this->section = '';
1873 $this->textbox1 = ContentHandler::getContentText( $content );
1874 wfDebug( __METHOD__ . ": Keeping edit conflict, failed merge.\n" );
1878 if ( $this->isConflict ) {
1879 $status->setResult( false, self::AS_CONFLICT_DETECTED );
1880 wfProfileOut( __METHOD__ );
1881 return $status;
1884 if ( !$this->runPostMergeFilters( $content, $status, $wgUser ) ) {
1885 wfProfileOut( __METHOD__ );
1886 return $status;
1889 if ( $this->section == 'new' ) {
1890 // Handle the user preference to force summaries here
1891 if ( !$this->allowBlankSummary && trim( $this->summary ) == '' ) {
1892 $this->missingSummary = true;
1893 $status->fatal( 'missingsummary' ); // or 'missingcommentheader' if $section == 'new'. Blegh
1894 $status->value = self::AS_SUMMARY_NEEDED;
1895 wfProfileOut( __METHOD__ );
1896 return $status;
1899 // Do not allow the user to post an empty comment
1900 if ( $this->textbox1 == '' ) {
1901 $this->missingComment = true;
1902 $status->fatal( 'missingcommenttext' );
1903 $status->value = self::AS_TEXTBOX_EMPTY;
1904 wfProfileOut( __METHOD__ );
1905 return $status;
1907 } elseif ( !$this->allowBlankSummary
1908 && !$content->equals( $this->getOriginalContent( $wgUser ) )
1909 && !$content->isRedirect()
1910 && md5( $this->summary ) == $this->autoSumm
1912 $this->missingSummary = true;
1913 $status->fatal( 'missingsummary' );
1914 $status->value = self::AS_SUMMARY_NEEDED;
1915 wfProfileOut( __METHOD__ );
1916 return $status;
1919 # All's well
1920 wfProfileIn( __METHOD__ . '-sectionanchor' );
1921 $sectionanchor = '';
1922 if ( $this->section == 'new' ) {
1923 if ( $this->sectiontitle !== '' ) {
1924 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $this->sectiontitle );
1925 // If no edit summary was specified, create one automatically from the section
1926 // title and have it link to the new section. Otherwise, respect the summary as
1927 // passed.
1928 if ( $this->summary === '' ) {
1929 $cleanSectionTitle = $wgParser->stripSectionName( $this->sectiontitle );
1930 $this->summary = wfMessage( 'newsectionsummary' )
1931 ->rawParams( $cleanSectionTitle )->inContentLanguage()->text();
1933 } elseif ( $this->summary !== '' ) {
1934 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $this->summary );
1935 # This is a new section, so create a link to the new section
1936 # in the revision summary.
1937 $cleanSummary = $wgParser->stripSectionName( $this->summary );
1938 $this->summary = wfMessage( 'newsectionsummary' )
1939 ->rawParams( $cleanSummary )->inContentLanguage()->text();
1941 } elseif ( $this->section != '' ) {
1942 # Try to get a section anchor from the section source, redirect
1943 # to edited section if header found.
1944 # XXX: Might be better to integrate this into Article::replaceSection
1945 # for duplicate heading checking and maybe parsing.
1946 $hasmatch = preg_match( "/^ *([=]{1,6})(.*?)(\\1) *\\n/i", $this->textbox1, $matches );
1947 # We can't deal with anchors, includes, html etc in the header for now,
1948 # headline would need to be parsed to improve this.
1949 if ( $hasmatch && strlen( $matches[2] ) > 0 ) {
1950 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $matches[2] );
1953 $result['sectionanchor'] = $sectionanchor;
1954 wfProfileOut( __METHOD__ . '-sectionanchor' );
1956 // Save errors may fall down to the edit form, but we've now
1957 // merged the section into full text. Clear the section field
1958 // so that later submission of conflict forms won't try to
1959 // replace that into a duplicated mess.
1960 $this->textbox1 = $this->toEditText( $content );
1961 $this->section = '';
1963 $status->value = self::AS_SUCCESS_UPDATE;
1966 // Check for length errors again now that the section is merged in
1967 $this->kblength = (int)( strlen( $this->toEditText( $content ) ) / 1024 );
1968 if ( $this->kblength > $wgMaxArticleSize ) {
1969 $this->tooBig = true;
1970 $status->setResult( false, self::AS_MAX_ARTICLE_SIZE_EXCEEDED );
1971 wfProfileOut( __METHOD__ );
1972 return $status;
1975 $flags = EDIT_DEFER_UPDATES | EDIT_AUTOSUMMARY |
1976 ( $new ? EDIT_NEW : EDIT_UPDATE ) |
1977 ( ( $this->minoredit && !$this->isNew ) ? EDIT_MINOR : 0 ) |
1978 ( $bot ? EDIT_FORCE_BOT : 0 );
1980 $doEditStatus = $this->mArticle->doEditContent( $content, $this->summary, $flags,
1981 false, null, $this->contentFormat );
1983 if ( !$doEditStatus->isOK() ) {
1984 // Failure from doEdit()
1985 // Show the edit conflict page for certain recognized errors from doEdit(),
1986 // but don't show it for errors from extension hooks
1987 $errors = $doEditStatus->getErrorsArray();
1988 if ( in_array( $errors[0][0],
1989 array( 'edit-gone-missing', 'edit-conflict', 'edit-already-exists' ) )
1991 $this->isConflict = true;
1992 // Destroys data doEdit() put in $status->value but who cares
1993 $doEditStatus->value = self::AS_END;
1995 wfProfileOut( __METHOD__ );
1996 return $doEditStatus;
1999 $result['nullEdit'] = $doEditStatus->hasMessage( 'edit-no-change' );
2000 if ( $result['nullEdit'] ) {
2001 // We don't know if it was a null edit until now, so increment here
2002 $wgUser->pingLimiter( 'linkpurge' );
2004 $result['redirect'] = $content->isRedirect();
2005 $this->updateWatchlist();
2006 wfProfileOut( __METHOD__ );
2007 return $status;
2011 * Register the change of watch status
2013 protected function updateWatchlist() {
2014 global $wgUser;
2016 if ( $wgUser->isLoggedIn()
2017 && $this->watchthis != $wgUser->isWatched( $this->mTitle, WatchedItem::IGNORE_USER_RIGHTS )
2019 $fname = __METHOD__;
2020 $title = $this->mTitle;
2021 $watch = $this->watchthis;
2023 // Do this in its own transaction to reduce contention...
2024 $dbw = wfGetDB( DB_MASTER );
2025 $dbw->onTransactionIdle( function() use ( $dbw, $title, $watch, $wgUser, $fname ) {
2026 $dbw->begin( $fname );
2027 WatchAction::doWatchOrUnwatch( $watch, $title, $wgUser );
2028 $dbw->commit( $fname );
2029 } );
2034 * Attempts to merge text content with base and current revisions
2036 * @param string $editText
2038 * @return bool
2039 * @deprecated since 1.21, use mergeChangesIntoContent() instead
2041 function mergeChangesInto( &$editText ) {
2042 ContentHandler::deprecated( __METHOD__, "1.21" );
2044 $editContent = $this->toEditContent( $editText );
2046 $ok = $this->mergeChangesIntoContent( $editContent );
2048 if ( $ok ) {
2049 $editText = $this->toEditText( $editContent );
2050 return true;
2052 return false;
2056 * Attempts to do 3-way merge of edit content with a base revision
2057 * and current content, in case of edit conflict, in whichever way appropriate
2058 * for the content type.
2060 * @since 1.21
2062 * @param Content $editContent
2064 * @return bool
2066 private function mergeChangesIntoContent( &$editContent ) {
2067 wfProfileIn( __METHOD__ );
2069 $db = wfGetDB( DB_MASTER );
2071 // This is the revision the editor started from
2072 $baseRevision = $this->getBaseRevision();
2073 $baseContent = $baseRevision ? $baseRevision->getContent() : null;
2075 if ( is_null( $baseContent ) ) {
2076 wfProfileOut( __METHOD__ );
2077 return false;
2080 // The current state, we want to merge updates into it
2081 $currentRevision = Revision::loadFromTitle( $db, $this->mTitle );
2082 $currentContent = $currentRevision ? $currentRevision->getContent() : null;
2084 if ( is_null( $currentContent ) ) {
2085 wfProfileOut( __METHOD__ );
2086 return false;
2089 $handler = ContentHandler::getForModelID( $baseContent->getModel() );
2091 $result = $handler->merge3( $baseContent, $editContent, $currentContent );
2093 if ( $result ) {
2094 $editContent = $result;
2095 wfProfileOut( __METHOD__ );
2096 return true;
2099 wfProfileOut( __METHOD__ );
2100 return false;
2104 * @return Revision
2106 function getBaseRevision() {
2107 if ( !$this->mBaseRevision ) {
2108 $db = wfGetDB( DB_MASTER );
2109 $this->mBaseRevision = Revision::loadFromTimestamp(
2110 $db, $this->mTitle, $this->edittime );
2112 return $this->mBaseRevision;
2116 * Check given input text against $wgSpamRegex, and return the text of the first match.
2118 * @param string $text
2120 * @return string|bool Matching string or false
2122 public static function matchSpamRegex( $text ) {
2123 global $wgSpamRegex;
2124 // For back compatibility, $wgSpamRegex may be a single string or an array of regexes.
2125 $regexes = (array)$wgSpamRegex;
2126 return self::matchSpamRegexInternal( $text, $regexes );
2130 * Check given input text against $wgSummarySpamRegex, and return the text of the first match.
2132 * @param string $text
2134 * @return string|bool Matching string or false
2136 public static function matchSummarySpamRegex( $text ) {
2137 global $wgSummarySpamRegex;
2138 $regexes = (array)$wgSummarySpamRegex;
2139 return self::matchSpamRegexInternal( $text, $regexes );
2143 * @param string $text
2144 * @param array $regexes
2145 * @return bool|string
2147 protected static function matchSpamRegexInternal( $text, $regexes ) {
2148 foreach ( $regexes as $regex ) {
2149 $matches = array();
2150 if ( preg_match( $regex, $text, $matches ) ) {
2151 return $matches[0];
2154 return false;
2157 function setHeaders() {
2158 global $wgOut, $wgUser;
2160 $wgOut->addModules( 'mediawiki.action.edit' );
2161 $wgOut->addModuleStyles( 'mediawiki.action.edit.styles' );
2163 if ( $wgUser->getOption( 'uselivepreview', false ) ) {
2164 $wgOut->addModules( 'mediawiki.action.edit.preview' );
2167 if ( $wgUser->getOption( 'useeditwarning', false ) ) {
2168 $wgOut->addModules( 'mediawiki.action.edit.editWarning' );
2171 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2173 # Enabled article-related sidebar, toplinks, etc.
2174 $wgOut->setArticleRelated( true );
2176 $contextTitle = $this->getContextTitle();
2177 if ( $this->isConflict ) {
2178 $msg = 'editconflict';
2179 } elseif ( $contextTitle->exists() && $this->section != '' ) {
2180 $msg = $this->section == 'new' ? 'editingcomment' : 'editingsection';
2181 } else {
2182 $msg = $contextTitle->exists()
2183 || ( $contextTitle->getNamespace() == NS_MEDIAWIKI
2184 && $contextTitle->getDefaultMessageText() !== false
2186 ? 'editing'
2187 : 'creating';
2190 # Use the title defined by DISPLAYTITLE magic word when present
2191 $displayTitle = isset( $this->mParserOutput ) ? $this->mParserOutput->getDisplayTitle() : false;
2192 if ( $displayTitle === false ) {
2193 $displayTitle = $contextTitle->getPrefixedText();
2195 $wgOut->setPageTitle( wfMessage( $msg, $displayTitle ) );
2199 * Show all applicable editing introductions
2201 protected function showIntro() {
2202 global $wgOut, $wgUser;
2203 if ( $this->suppressIntro ) {
2204 return;
2207 $namespace = $this->mTitle->getNamespace();
2209 if ( $namespace == NS_MEDIAWIKI ) {
2210 # Show a warning if editing an interface message
2211 $wgOut->wrapWikiMsg( "<div class='mw-editinginterface'>\n$1\n</div>", 'editinginterface' );
2212 } elseif ( $namespace == NS_FILE ) {
2213 # Show a hint to shared repo
2214 $file = wfFindFile( $this->mTitle );
2215 if ( $file && !$file->isLocal() ) {
2216 $descUrl = $file->getDescriptionUrl();
2217 # there must be a description url to show a hint to shared repo
2218 if ( $descUrl ) {
2219 if ( !$this->mTitle->exists() ) {
2220 $wgOut->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-create\">\n$1\n</div>", array(
2221 'sharedupload-desc-create', $file->getRepo()->getDisplayName(), $descUrl
2222 ) );
2223 } else {
2224 $wgOut->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-edit\">\n$1\n</div>", array(
2225 'sharedupload-desc-edit', $file->getRepo()->getDisplayName(), $descUrl
2226 ) );
2232 # Show a warning message when someone creates/edits a user (talk) page but the user does not exist
2233 # Show log extract when the user is currently blocked
2234 if ( $namespace == NS_USER || $namespace == NS_USER_TALK ) {
2235 $parts = explode( '/', $this->mTitle->getText(), 2 );
2236 $username = $parts[0];
2237 $user = User::newFromName( $username, false /* allow IP users*/ );
2238 $ip = User::isIP( $username );
2239 $block = Block::newFromTarget( $user, $user );
2240 if ( !( $user && $user->isLoggedIn() ) && !$ip ) { # User does not exist
2241 $wgOut->wrapWikiMsg( "<div class=\"mw-userpage-userdoesnotexist error\">\n$1\n</div>",
2242 array( 'userpage-userdoesnotexist', wfEscapeWikiText( $username ) ) );
2243 } elseif ( !is_null( $block ) && $block->getType() != Block::TYPE_AUTO ) { # Show log extract if the user is currently blocked
2244 LogEventsList::showLogExtract(
2245 $wgOut,
2246 'block',
2247 MWNamespace::getCanonicalName( NS_USER ) . ':' . $block->getTarget(),
2249 array(
2250 'lim' => 1,
2251 'showIfEmpty' => false,
2252 'msgKey' => array(
2253 'blocked-notice-logextract',
2254 $user->getName() # Support GENDER in notice
2260 # Try to add a custom edit intro, or use the standard one if this is not possible.
2261 if ( !$this->showCustomIntro() && !$this->mTitle->exists() ) {
2262 $helpLink = wfExpandUrl( Skin::makeInternalOrExternalUrl(
2263 wfMessage( 'helppage' )->inContentLanguage()->text()
2264 ) );
2265 if ( $wgUser->isLoggedIn() ) {
2266 $wgOut->wrapWikiMsg(
2267 // Suppress the external link icon, consider the help url an internal one
2268 "<div class=\"mw-newarticletext plainlinks\">\n$1\n</div>",
2269 array(
2270 'newarticletext',
2271 $helpLink
2274 } else {
2275 $wgOut->wrapWikiMsg(
2276 // Suppress the external link icon, consider the help url an internal one
2277 "<div class=\"mw-newarticletextanon plainlinks\">\n$1\n</div>",
2278 array(
2279 'newarticletextanon',
2280 $helpLink
2285 # Give a notice if the user is editing a deleted/moved page...
2286 if ( !$this->mTitle->exists() ) {
2287 LogEventsList::showLogExtract( $wgOut, array( 'delete', 'move' ), $this->mTitle,
2289 array(
2290 'lim' => 10,
2291 'conds' => array( "log_action != 'revision'" ),
2292 'showIfEmpty' => false,
2293 'msgKey' => array( 'recreate-moveddeleted-warn' )
2300 * Attempt to show a custom editing introduction, if supplied
2302 * @return bool
2304 protected function showCustomIntro() {
2305 if ( $this->editintro ) {
2306 $title = Title::newFromText( $this->editintro );
2307 if ( $title instanceof Title && $title->exists() && $title->userCan( 'read' ) ) {
2308 global $wgOut;
2309 // Added using template syntax, to take <noinclude>'s into account.
2310 $wgOut->addWikiTextTitleTidy( '<div class="mw-editintro">{{:' . $title->getFullText() . '}}</div>', $this->mTitle );
2311 return true;
2314 return false;
2318 * Gets an editable textual representation of $content.
2319 * The textual representation can be turned by into a Content object by the
2320 * toEditContent() method.
2322 * If $content is null or false or a string, $content is returned unchanged.
2324 * If the given Content object is not of a type that can be edited using
2325 * the text base EditPage, an exception will be raised. Set
2326 * $this->allowNonTextContent to true to allow editing of non-textual
2327 * content.
2329 * @param Content|null|bool|string $content
2330 * @return string The editable text form of the content.
2332 * @throws MWException if $content is not an instance of TextContent and
2333 * $this->allowNonTextContent is not true.
2335 protected function toEditText( $content ) {
2336 if ( $content === null || $content === false ) {
2337 return $content;
2340 if ( is_string( $content ) ) {
2341 return $content;
2344 if ( !$this->isSupportedContentModel( $content->getModel() ) ) {
2345 throw new MWException( 'This content model is not supported: '
2346 . ContentHandler::getLocalizedName( $content->getModel() ) );
2349 return $content->serialize( $this->contentFormat );
2353 * Turns the given text into a Content object by unserializing it.
2355 * If the resulting Content object is not of a type that can be edited using
2356 * the text base EditPage, an exception will be raised. Set
2357 * $this->allowNonTextContent to true to allow editing of non-textual
2358 * content.
2360 * @param string|null|bool $text Text to unserialize
2361 * @return Content The content object created from $text. If $text was false
2362 * or null, false resp. null will be returned instead.
2364 * @throws MWException if unserializing the text results in a Content
2365 * object that is not an instance of TextContent and
2366 * $this->allowNonTextContent is not true.
2368 protected function toEditContent( $text ) {
2369 if ( $text === false || $text === null ) {
2370 return $text;
2373 $content = ContentHandler::makeContent( $text, $this->getTitle(),
2374 $this->contentModel, $this->contentFormat );
2376 if ( !$this->isSupportedContentModel( $content->getModel() ) ) {
2377 throw new MWException( 'This content model is not supported: '
2378 . ContentHandler::getLocalizedName( $content->getModel() ) );
2381 return $content;
2385 * Send the edit form and related headers to $wgOut
2386 * @param callable|null $formCallback That takes an OutputPage parameter; will be called
2387 * during form output near the top, for captchas and the like.
2389 function showEditForm( $formCallback = null ) {
2390 global $wgOut, $wgUser;
2392 wfProfileIn( __METHOD__ );
2394 # need to parse the preview early so that we know which templates are used,
2395 # otherwise users with "show preview after edit box" will get a blank list
2396 # we parse this near the beginning so that setHeaders can do the title
2397 # setting work instead of leaving it in getPreviewText
2398 $previewOutput = '';
2399 if ( $this->formtype == 'preview' ) {
2400 $previewOutput = $this->getPreviewText();
2403 wfRunHooks( 'EditPage::showEditForm:initial', array( &$this, &$wgOut ) );
2405 $this->setHeaders();
2407 if ( $this->showHeader() === false ) {
2408 wfProfileOut( __METHOD__ );
2409 return;
2412 $wgOut->addHTML( $this->editFormPageTop );
2414 if ( $wgUser->getOption( 'previewontop' ) ) {
2415 $this->displayPreviewArea( $previewOutput, true );
2418 $wgOut->addHTML( $this->editFormTextTop );
2420 $showToolbar = true;
2421 if ( $this->wasDeletedSinceLastEdit() ) {
2422 if ( $this->formtype == 'save' ) {
2423 // Hide the toolbar and edit area, user can click preview to get it back
2424 // Add an confirmation checkbox and explanation.
2425 $showToolbar = false;
2426 } else {
2427 $wgOut->wrapWikiMsg( "<div class='error mw-deleted-while-editing'>\n$1\n</div>",
2428 'deletedwhileediting' );
2432 // @todo add EditForm plugin interface and use it here!
2433 // search for textarea1 and textares2, and allow EditForm to override all uses.
2434 $wgOut->addHTML( Html::openElement(
2435 'form',
2436 array(
2437 'id' => self::EDITFORM_ID,
2438 'name' => self::EDITFORM_ID,
2439 'method' => 'post',
2440 'action' => $this->getActionURL( $this->getContextTitle() ),
2441 'enctype' => 'multipart/form-data'
2443 ) );
2445 if ( is_callable( $formCallback ) ) {
2446 call_user_func_array( $formCallback, array( &$wgOut ) );
2449 // Add an empty field to trip up spambots
2450 $wgOut->addHTML(
2451 Xml::openElement( 'div', array( 'id' => 'antispam-container', 'style' => 'display: none;' ) )
2452 . Html::rawElement(
2453 'label',
2454 array( 'for' => 'wpAntiSpam' ),
2455 wfMessage( 'simpleantispam-label' )->parse()
2457 . Xml::element(
2458 'input',
2459 array(
2460 'type' => 'text',
2461 'name' => 'wpAntispam',
2462 'id' => 'wpAntispam',
2463 'value' => ''
2466 . Xml::closeElement( 'div' )
2469 wfRunHooks( 'EditPage::showEditForm:fields', array( &$this, &$wgOut ) );
2471 // Put these up at the top to ensure they aren't lost on early form submission
2472 $this->showFormBeforeText();
2474 if ( $this->wasDeletedSinceLastEdit() && 'save' == $this->formtype ) {
2475 $username = $this->lastDelete->user_name;
2476 $comment = $this->lastDelete->log_comment;
2478 // It is better to not parse the comment at all than to have templates expanded in the middle
2479 // TODO: can the checkLabel be moved outside of the div so that wrapWikiMsg could be used?
2480 $key = $comment === ''
2481 ? 'confirmrecreate-noreason'
2482 : 'confirmrecreate';
2483 $wgOut->addHTML(
2484 '<div class="mw-confirm-recreate">' .
2485 wfMessage( $key, $username, "<nowiki>$comment</nowiki>" )->parse() .
2486 Xml::checkLabel( wfMessage( 'recreate' )->text(), 'wpRecreate', 'wpRecreate', false,
2487 array( 'title' => Linker::titleAttrib( 'recreate' ), 'tabindex' => 1, 'id' => 'wpRecreate' )
2489 '</div>'
2493 # When the summary is hidden, also hide them on preview/show changes
2494 if ( $this->nosummary ) {
2495 $wgOut->addHTML( Html::hidden( 'nosummary', true ) );
2498 # If a blank edit summary was previously provided, and the appropriate
2499 # user preference is active, pass a hidden tag as wpIgnoreBlankSummary. This will stop the
2500 # user being bounced back more than once in the event that a summary
2501 # is not required.
2502 #####
2503 # For a bit more sophisticated detection of blank summaries, hash the
2504 # automatic one and pass that in the hidden field wpAutoSummary.
2505 if ( $this->missingSummary || ( $this->section == 'new' && $this->nosummary ) ) {
2506 $wgOut->addHTML( Html::hidden( 'wpIgnoreBlankSummary', true ) );
2509 if ( $this->undidRev ) {
2510 $wgOut->addHTML( Html::hidden( 'wpUndidRevision', $this->undidRev ) );
2513 if ( $this->hasPresetSummary ) {
2514 // If a summary has been preset using &summary= we don't want to prompt for
2515 // a different summary. Only prompt for a summary if the summary is blanked.
2516 // (Bug 17416)
2517 $this->autoSumm = md5( '' );
2520 $autosumm = $this->autoSumm ? $this->autoSumm : md5( $this->summary );
2521 $wgOut->addHTML( Html::hidden( 'wpAutoSummary', $autosumm ) );
2523 $wgOut->addHTML( Html::hidden( 'oldid', $this->oldid ) );
2525 $wgOut->addHTML( Html::hidden( 'format', $this->contentFormat ) );
2526 $wgOut->addHTML( Html::hidden( 'model', $this->contentModel ) );
2528 if ( $this->section == 'new' ) {
2529 $this->showSummaryInput( true, $this->summary );
2530 $wgOut->addHTML( $this->getSummaryPreview( true, $this->summary ) );
2533 $wgOut->addHTML( $this->editFormTextBeforeContent );
2535 if ( !$this->isCssJsSubpage && $showToolbar && $wgUser->getOption( 'showtoolbar' ) ) {
2536 $wgOut->addHTML( EditPage::getEditToolbar() );
2539 if ( $this->isConflict ) {
2540 // In an edit conflict bypass the overridable content form method
2541 // and fallback to the raw wpTextbox1 since editconflicts can't be
2542 // resolved between page source edits and custom ui edits using the
2543 // custom edit ui.
2544 $this->textbox2 = $this->textbox1;
2546 $content = $this->getCurrentContent();
2547 $this->textbox1 = $this->toEditText( $content );
2549 $this->showTextbox1();
2550 } else {
2551 $this->showContentForm();
2554 $wgOut->addHTML( $this->editFormTextAfterContent );
2556 $this->showStandardInputs();
2558 $this->showFormAfterText();
2560 $this->showTosSummary();
2562 $this->showEditTools();
2564 $wgOut->addHTML( $this->editFormTextAfterTools . "\n" );
2566 $wgOut->addHTML( Html::rawElement( 'div', array( 'class' => 'templatesUsed' ),
2567 Linker::formatTemplates( $this->getTemplates(), $this->preview, $this->section != '' ) ) );
2569 $wgOut->addHTML( Html::rawElement( 'div', array( 'class' => 'hiddencats' ),
2570 Linker::formatHiddenCategories( $this->mArticle->getHiddenCategories() ) ) );
2572 $wgOut->addHTML( Html::rawElement( 'div', array( 'class' => 'limitreport' ),
2573 self::getPreviewLimitReport( $this->mParserOutput ) ) );
2575 $wgOut->addModules( 'mediawiki.action.edit.collapsibleFooter' );
2577 if ( $this->isConflict ) {
2578 try {
2579 $this->showConflict();
2580 } catch ( MWContentSerializationException $ex ) {
2581 // this can't really happen, but be nice if it does.
2582 $msg = wfMessage(
2583 'content-failed-to-parse',
2584 $this->contentModel,
2585 $this->contentFormat,
2586 $ex->getMessage()
2588 $wgOut->addWikiText( '<div class="error">' . $msg->text() . '</div>' );
2592 // Marker for detecting truncated form data. This must be the last
2593 // parameter sent in order to be of use, so do not move me.
2594 $wgOut->addHTML( Html::hidden( 'wpUltimateParam', true ) );
2595 $wgOut->addHTML( $this->editFormTextBottom . "\n</form>\n" );
2597 if ( !$wgUser->getOption( 'previewontop' ) ) {
2598 $this->displayPreviewArea( $previewOutput, false );
2601 wfProfileOut( __METHOD__ );
2605 * Extract the section title from current section text, if any.
2607 * @param string $text
2608 * @return string|bool string or false
2610 public static function extractSectionTitle( $text ) {
2611 preg_match( "/^(=+)(.+)\\1\\s*(\n|$)/i", $text, $matches );
2612 if ( !empty( $matches[2] ) ) {
2613 global $wgParser;
2614 return $wgParser->stripSectionName( trim( $matches[2] ) );
2615 } else {
2616 return false;
2621 * @return bool
2623 protected function showHeader() {
2624 global $wgOut, $wgUser, $wgMaxArticleSize, $wgLang;
2625 global $wgAllowUserCss, $wgAllowUserJs;
2627 if ( $this->mTitle->isTalkPage() ) {
2628 $wgOut->addWikiMsg( 'talkpagetext' );
2631 // Add edit notices
2632 $wgOut->addHTML( implode( "\n", $this->mTitle->getEditNotices( $this->oldid ) ) );
2634 if ( $this->isConflict ) {
2635 $wgOut->wrapWikiMsg( "<div class='mw-explainconflict'>\n$1\n</div>", 'explainconflict' );
2636 $this->edittime = $this->mArticle->getTimestamp();
2637 } else {
2638 if ( $this->section != '' && !$this->isSectionEditSupported() ) {
2639 // We use $this->section to much before this and getVal('wgSection') directly in other places
2640 // at this point we can't reset $this->section to '' to fallback to non-section editing.
2641 // Someone is welcome to try refactoring though
2642 $wgOut->showErrorPage( 'sectioneditnotsupported-title', 'sectioneditnotsupported-text' );
2643 return false;
2646 if ( $this->section != '' && $this->section != 'new' ) {
2647 if ( !$this->summary && !$this->preview && !$this->diff ) {
2648 $sectionTitle = self::extractSectionTitle( $this->textbox1 ); //FIXME: use Content object
2649 if ( $sectionTitle !== false ) {
2650 $this->summary = "/* $sectionTitle */ ";
2655 if ( $this->missingComment ) {
2656 $wgOut->wrapWikiMsg( "<div id='mw-missingcommenttext'>\n$1\n</div>", 'missingcommenttext' );
2659 if ( $this->missingSummary && $this->section != 'new' ) {
2660 $wgOut->wrapWikiMsg( "<div id='mw-missingsummary'>\n$1\n</div>", 'missingsummary' );
2663 if ( $this->missingSummary && $this->section == 'new' ) {
2664 $wgOut->wrapWikiMsg( "<div id='mw-missingcommentheader'>\n$1\n</div>", 'missingcommentheader' );
2667 if ( $this->hookError !== '' ) {
2668 $wgOut->addWikiText( $this->hookError );
2671 if ( !$this->checkUnicodeCompliantBrowser() ) {
2672 $wgOut->addWikiMsg( 'nonunicodebrowser' );
2675 if ( $this->section != 'new' ) {
2676 $revision = $this->mArticle->getRevisionFetched();
2677 if ( $revision ) {
2678 // Let sysop know that this will make private content public if saved
2680 if ( !$revision->userCan( Revision::DELETED_TEXT, $wgUser ) ) {
2681 $wgOut->wrapWikiMsg(
2682 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
2683 'rev-deleted-text-permission'
2685 } elseif ( $revision->isDeleted( Revision::DELETED_TEXT ) ) {
2686 $wgOut->wrapWikiMsg(
2687 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
2688 'rev-deleted-text-view'
2692 if ( !$revision->isCurrent() ) {
2693 $this->mArticle->setOldSubtitle( $revision->getId() );
2694 $wgOut->addWikiMsg( 'editingold' );
2696 } elseif ( $this->mTitle->exists() ) {
2697 // Something went wrong
2699 $wgOut->wrapWikiMsg( "<div class='errorbox'>\n$1\n</div>\n",
2700 array( 'missing-revision', $this->oldid ) );
2705 if ( wfReadOnly() ) {
2706 $wgOut->wrapWikiMsg(
2707 "<div id=\"mw-read-only-warning\">\n$1\n</div>",
2708 array( 'readonlywarning', wfReadOnlyReason() )
2710 } elseif ( $wgUser->isAnon() ) {
2711 if ( $this->formtype != 'preview' ) {
2712 $wgOut->wrapWikiMsg( "<div id=\"mw-anon-edit-warning\">\n$1</div>", 'anoneditwarning' );
2713 } else {
2714 $wgOut->wrapWikiMsg( "<div id=\"mw-anon-preview-warning\">\n$1</div>", 'anonpreviewwarning' );
2716 } else {
2717 if ( $this->isCssJsSubpage ) {
2718 # Check the skin exists
2719 if ( $this->isWrongCaseCssJsPage ) {
2720 $wgOut->wrapWikiMsg(
2721 "<div class='error' id='mw-userinvalidcssjstitle'>\n$1\n</div>",
2722 array( 'userinvalidcssjstitle', $this->mTitle->getSkinFromCssJsSubpage() )
2725 if ( $this->formtype !== 'preview' ) {
2726 if ( $this->isCssSubpage && $wgAllowUserCss ) {
2727 $wgOut->wrapWikiMsg(
2728 "<div id='mw-usercssyoucanpreview'>\n$1\n</div>",
2729 array( 'usercssyoucanpreview' )
2733 if ( $this->isJsSubpage && $wgAllowUserJs ) {
2734 $wgOut->wrapWikiMsg(
2735 "<div id='mw-userjsyoucanpreview'>\n$1\n</div>",
2736 array( 'userjsyoucanpreview' )
2743 if ( $this->mTitle->isProtected( 'edit' ) &&
2744 MWNamespace::getRestrictionLevels( $this->mTitle->getNamespace() ) !== array( '' )
2746 # Is the title semi-protected?
2747 if ( $this->mTitle->isSemiProtected() ) {
2748 $noticeMsg = 'semiprotectedpagewarning';
2749 } else {
2750 # Then it must be protected based on static groups (regular)
2751 $noticeMsg = 'protectedpagewarning';
2753 LogEventsList::showLogExtract( $wgOut, 'protect', $this->mTitle, '',
2754 array( 'lim' => 1, 'msgKey' => array( $noticeMsg ) ) );
2756 if ( $this->mTitle->isCascadeProtected() ) {
2757 # Is this page under cascading protection from some source pages?
2758 list( $cascadeSources, /* $restrictions */ ) = $this->mTitle->getCascadeProtectionSources();
2759 $notice = "<div class='mw-cascadeprotectedwarning'>\n$1\n";
2760 $cascadeSourcesCount = count( $cascadeSources );
2761 if ( $cascadeSourcesCount > 0 ) {
2762 # Explain, and list the titles responsible
2763 foreach ( $cascadeSources as $page ) {
2764 $notice .= '* [[:' . $page->getPrefixedText() . "]]\n";
2767 $notice .= '</div>';
2768 $wgOut->wrapWikiMsg( $notice, array( 'cascadeprotectedwarning', $cascadeSourcesCount ) );
2770 if ( !$this->mTitle->exists() && $this->mTitle->getRestrictions( 'create' ) ) {
2771 LogEventsList::showLogExtract( $wgOut, 'protect', $this->mTitle, '',
2772 array( 'lim' => 1,
2773 'showIfEmpty' => false,
2774 'msgKey' => array( 'titleprotectedwarning' ),
2775 'wrap' => "<div class=\"mw-titleprotectedwarning\">\n$1</div>" ) );
2778 if ( $this->kblength === false ) {
2779 $this->kblength = (int)( strlen( $this->textbox1 ) / 1024 );
2782 if ( $this->tooBig || $this->kblength > $wgMaxArticleSize ) {
2783 $wgOut->wrapWikiMsg( "<div class='error' id='mw-edit-longpageerror'>\n$1\n</div>",
2784 array(
2785 'longpageerror',
2786 $wgLang->formatNum( $this->kblength ),
2787 $wgLang->formatNum( $wgMaxArticleSize )
2790 } else {
2791 if ( !wfMessage( 'longpage-hint' )->isDisabled() ) {
2792 $wgOut->wrapWikiMsg( "<div id='mw-edit-longpage-hint'>\n$1\n</div>",
2793 array(
2794 'longpage-hint',
2795 $wgLang->formatSize( strlen( $this->textbox1 ) ),
2796 strlen( $this->textbox1 )
2801 # Add header copyright warning
2802 $this->showHeaderCopyrightWarning();
2804 return true;
2808 * Standard summary input and label (wgSummary), abstracted so EditPage
2809 * subclasses may reorganize the form.
2810 * Note that you do not need to worry about the label's for=, it will be
2811 * inferred by the id given to the input. You can remove them both by
2812 * passing array( 'id' => false ) to $userInputAttrs.
2814 * @param string $summary The value of the summary input
2815 * @param string $labelText The html to place inside the label
2816 * @param array $inputAttrs Array of attrs to use on the input
2817 * @param array $spanLabelAttrs Array of attrs to use on the span inside the label
2819 * @return array An array in the format array( $label, $input )
2821 function getSummaryInput( $summary = "", $labelText = null,
2822 $inputAttrs = null, $spanLabelAttrs = null
2824 // Note: the maxlength is overridden in JS to 255 and to make it use UTF-8 bytes, not characters.
2825 $inputAttrs = ( is_array( $inputAttrs ) ? $inputAttrs : array() ) + array(
2826 'id' => 'wpSummary',
2827 'maxlength' => '200',
2828 'tabindex' => '1',
2829 'size' => 60,
2830 'spellcheck' => 'true',
2831 ) + Linker::tooltipAndAccesskeyAttribs( 'summary' );
2833 $spanLabelAttrs = ( is_array( $spanLabelAttrs ) ? $spanLabelAttrs : array() ) + array(
2834 'class' => $this->missingSummary ? 'mw-summarymissed' : 'mw-summary',
2835 'id' => "wpSummaryLabel"
2838 $label = null;
2839 if ( $labelText ) {
2840 $label = Xml::tags(
2841 'label',
2842 $inputAttrs['id'] ? array( 'for' => $inputAttrs['id'] ) : null,
2843 $labelText
2845 $label = Xml::tags( 'span', $spanLabelAttrs, $label );
2848 $input = Html::input( 'wpSummary', $summary, 'text', $inputAttrs );
2850 return array( $label, $input );
2854 * @param bool $isSubjectPreview true if this is the section subject/title
2855 * up top, or false if this is the comment summary
2856 * down below the textarea
2857 * @param string $summary The text of the summary to display
2858 * @return string
2860 protected function showSummaryInput( $isSubjectPreview, $summary = "" ) {
2861 global $wgOut, $wgContLang;
2862 # Add a class if 'missingsummary' is triggered to allow styling of the summary line
2863 $summaryClass = $this->missingSummary ? 'mw-summarymissed' : 'mw-summary';
2864 if ( $isSubjectPreview ) {
2865 if ( $this->nosummary ) {
2866 return;
2868 } else {
2869 if ( !$this->mShowSummaryField ) {
2870 return;
2873 $summary = $wgContLang->recodeForEdit( $summary );
2874 $labelText = wfMessage( $isSubjectPreview ? 'subject' : 'summary' )->parse();
2875 list( $label, $input ) = $this->getSummaryInput(
2876 $summary,
2877 $labelText,
2878 array( 'class' => $summaryClass ),
2879 array()
2881 $wgOut->addHTML( "{$label} {$input}" );
2885 * @param bool $isSubjectPreview true if this is the section subject/title
2886 * up top, or false if this is the comment summary
2887 * down below the textarea
2888 * @param string $summary The text of the summary to display
2889 * @return string
2891 protected function getSummaryPreview( $isSubjectPreview, $summary = "" ) {
2892 // avoid spaces in preview, gets always trimmed on save
2893 $summary = trim( $summary );
2894 if ( !$summary || ( !$this->preview && !$this->diff ) ) {
2895 return "";
2898 global $wgParser;
2900 if ( $isSubjectPreview ) {
2901 $summary = wfMessage( 'newsectionsummary' )->rawParams( $wgParser->stripSectionName( $summary ) )
2902 ->inContentLanguage()->text();
2905 $message = $isSubjectPreview ? 'subject-preview' : 'summary-preview';
2907 $summary = wfMessage( $message )->parse()
2908 . Linker::commentBlock( $summary, $this->mTitle, $isSubjectPreview );
2909 return Xml::tags( 'div', array( 'class' => 'mw-summary-preview' ), $summary );
2912 protected function showFormBeforeText() {
2913 global $wgOut;
2914 $section = htmlspecialchars( $this->section );
2915 $wgOut->addHTML( <<<HTML
2916 <input type='hidden' value="{$section}" name="wpSection" />
2917 <input type='hidden' value="{$this->starttime}" name="wpStarttime" />
2918 <input type='hidden' value="{$this->edittime}" name="wpEdittime" />
2919 <input type='hidden' value="{$this->scrolltop}" name="wpScrolltop" id="wpScrolltop" />
2921 HTML
2923 if ( !$this->checkUnicodeCompliantBrowser() ) {
2924 $wgOut->addHTML( Html::hidden( 'safemode', '1' ) );
2928 protected function showFormAfterText() {
2929 global $wgOut, $wgUser;
2931 * To make it harder for someone to slip a user a page
2932 * which submits an edit form to the wiki without their
2933 * knowledge, a random token is associated with the login
2934 * session. If it's not passed back with the submission,
2935 * we won't save the page, or render user JavaScript and
2936 * CSS previews.
2938 * For anon editors, who may not have a session, we just
2939 * include the constant suffix to prevent editing from
2940 * broken text-mangling proxies.
2942 $wgOut->addHTML( "\n" . Html::hidden( "wpEditToken", $wgUser->getEditToken() ) . "\n" );
2946 * Subpage overridable method for printing the form for page content editing
2947 * By default this simply outputs wpTextbox1
2948 * Subclasses can override this to provide a custom UI for editing;
2949 * be it a form, or simply wpTextbox1 with a modified content that will be
2950 * reverse modified when extracted from the post data.
2951 * Note that this is basically the inverse for importContentFormData
2953 protected function showContentForm() {
2954 $this->showTextbox1();
2958 * Method to output wpTextbox1
2959 * The $textoverride method can be used by subclasses overriding showContentForm
2960 * to pass back to this method.
2962 * @param array $customAttribs Array of html attributes to use in the textarea
2963 * @param string $textoverride Optional text to override $this->textarea1 with
2965 protected function showTextbox1( $customAttribs = null, $textoverride = null ) {
2966 if ( $this->wasDeletedSinceLastEdit() && $this->formtype == 'save' ) {
2967 $attribs = array( 'style' => 'display:none;' );
2968 } else {
2969 $classes = array(); // Textarea CSS
2970 if ( $this->mTitle->isProtected( 'edit' ) &&
2971 MWNamespace::getRestrictionLevels( $this->mTitle->getNamespace() ) !== array( '' )
2973 # Is the title semi-protected?
2974 if ( $this->mTitle->isSemiProtected() ) {
2975 $classes[] = 'mw-textarea-sprotected';
2976 } else {
2977 # Then it must be protected based on static groups (regular)
2978 $classes[] = 'mw-textarea-protected';
2980 # Is the title cascade-protected?
2981 if ( $this->mTitle->isCascadeProtected() ) {
2982 $classes[] = 'mw-textarea-cprotected';
2986 $attribs = array( 'tabindex' => 1 );
2988 if ( is_array( $customAttribs ) ) {
2989 $attribs += $customAttribs;
2992 if ( count( $classes ) ) {
2993 if ( isset( $attribs['class'] ) ) {
2994 $classes[] = $attribs['class'];
2996 $attribs['class'] = implode( ' ', $classes );
3000 $this->showTextbox(
3001 $textoverride !== null ? $textoverride : $this->textbox1,
3002 'wpTextbox1',
3003 $attribs
3007 protected function showTextbox2() {
3008 $this->showTextbox( $this->textbox2, 'wpTextbox2', array( 'tabindex' => 6, 'readonly' ) );
3011 protected function showTextbox( $text, $name, $customAttribs = array() ) {
3012 global $wgOut, $wgUser;
3014 $wikitext = $this->safeUnicodeOutput( $text );
3015 if ( strval( $wikitext ) !== '' ) {
3016 // Ensure there's a newline at the end, otherwise adding lines
3017 // is awkward.
3018 // But don't add a newline if the ext is empty, or Firefox in XHTML
3019 // mode will show an extra newline. A bit annoying.
3020 $wikitext .= "\n";
3023 $attribs = $customAttribs + array(
3024 'accesskey' => ',',
3025 'id' => $name,
3026 'cols' => $wgUser->getIntOption( 'cols' ),
3027 'rows' => $wgUser->getIntOption( 'rows' ),
3028 // Avoid PHP notices when appending preferences
3029 // (appending allows customAttribs['style'] to still work).
3030 'style' => ''
3033 $pageLang = $this->mTitle->getPageLanguage();
3034 $attribs['lang'] = $pageLang->getCode();
3035 $attribs['dir'] = $pageLang->getDir();
3037 $wgOut->addHTML( Html::textarea( $name, $wikitext, $attribs ) );
3040 protected function displayPreviewArea( $previewOutput, $isOnTop = false ) {
3041 global $wgOut;
3042 $classes = array();
3043 if ( $isOnTop ) {
3044 $classes[] = 'ontop';
3047 $attribs = array( 'id' => 'wikiPreview', 'class' => implode( ' ', $classes ) );
3049 if ( $this->formtype != 'preview' ) {
3050 $attribs['style'] = 'display: none;';
3053 $wgOut->addHTML( Xml::openElement( 'div', $attribs ) );
3055 if ( $this->formtype == 'preview' ) {
3056 $this->showPreview( $previewOutput );
3059 $wgOut->addHTML( '</div>' );
3061 if ( $this->formtype == 'diff' ) {
3062 try {
3063 $this->showDiff();
3064 } catch ( MWContentSerializationException $ex ) {
3065 $msg = wfMessage(
3066 'content-failed-to-parse',
3067 $this->contentModel,
3068 $this->contentFormat,
3069 $ex->getMessage()
3071 $wgOut->addWikiText( '<div class="error">' . $msg->text() . '</div>' );
3077 * Append preview output to $wgOut.
3078 * Includes category rendering if this is a category page.
3080 * @param string $text The HTML to be output for the preview.
3082 protected function showPreview( $text ) {
3083 global $wgOut;
3084 if ( $this->mTitle->getNamespace() == NS_CATEGORY ) {
3085 $this->mArticle->openShowCategory();
3087 # This hook seems slightly odd here, but makes things more
3088 # consistent for extensions.
3089 wfRunHooks( 'OutputPageBeforeHTML', array( &$wgOut, &$text ) );
3090 $wgOut->addHTML( $text );
3091 if ( $this->mTitle->getNamespace() == NS_CATEGORY ) {
3092 $this->mArticle->closeShowCategory();
3097 * Get a diff between the current contents of the edit box and the
3098 * version of the page we're editing from.
3100 * If this is a section edit, we'll replace the section as for final
3101 * save and then make a comparison.
3103 function showDiff() {
3104 global $wgUser, $wgContLang, $wgOut;
3106 $oldtitlemsg = 'currentrev';
3107 # if message does not exist, show diff against the preloaded default
3108 if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI && !$this->mTitle->exists() ) {
3109 $oldtext = $this->mTitle->getDefaultMessageText();
3110 if ( $oldtext !== false ) {
3111 $oldtitlemsg = 'defaultmessagetext';
3112 $oldContent = $this->toEditContent( $oldtext );
3113 } else {
3114 $oldContent = null;
3116 } else {
3117 $oldContent = $this->getCurrentContent();
3120 $textboxContent = $this->toEditContent( $this->textbox1 );
3122 $newContent = $this->mArticle->replaceSectionContent(
3123 $this->section, $textboxContent,
3124 $this->summary, $this->edittime );
3126 if ( $newContent ) {
3127 ContentHandler::runLegacyHooks( 'EditPageGetDiffText', array( $this, &$newContent ) );
3128 wfRunHooks( 'EditPageGetDiffContent', array( $this, &$newContent ) );
3130 $popts = ParserOptions::newFromUserAndLang( $wgUser, $wgContLang );
3131 $newContent = $newContent->preSaveTransform( $this->mTitle, $wgUser, $popts );
3134 if ( ( $oldContent && !$oldContent->isEmpty() ) || ( $newContent && !$newContent->isEmpty() ) ) {
3135 $oldtitle = wfMessage( $oldtitlemsg )->parse();
3136 $newtitle = wfMessage( 'yourtext' )->parse();
3138 if ( !$oldContent ) {
3139 $oldContent = $newContent->getContentHandler()->makeEmptyContent();
3142 if ( !$newContent ) {
3143 $newContent = $oldContent->getContentHandler()->makeEmptyContent();
3146 $de = $oldContent->getContentHandler()->createDifferenceEngine( $this->mArticle->getContext() );
3147 $de->setContent( $oldContent, $newContent );
3149 $difftext = $de->getDiff( $oldtitle, $newtitle );
3150 $de->showDiffStyle();
3151 } else {
3152 $difftext = '';
3155 $wgOut->addHTML( '<div id="wikiDiff">' . $difftext . '</div>' );
3159 * Show the header copyright warning.
3161 protected function showHeaderCopyrightWarning() {
3162 $msg = 'editpage-head-copy-warn';
3163 if ( !wfMessage( $msg )->isDisabled() ) {
3164 global $wgOut;
3165 $wgOut->wrapWikiMsg( "<div class='editpage-head-copywarn'>\n$1\n</div>",
3166 'editpage-head-copy-warn' );
3171 * Give a chance for site and per-namespace customizations of
3172 * terms of service summary link that might exist separately
3173 * from the copyright notice.
3175 * This will display between the save button and the edit tools,
3176 * so should remain short!
3178 protected function showTosSummary() {
3179 $msg = 'editpage-tos-summary';
3180 wfRunHooks( 'EditPageTosSummary', array( $this->mTitle, &$msg ) );
3181 if ( !wfMessage( $msg )->isDisabled() ) {
3182 global $wgOut;
3183 $wgOut->addHTML( '<div class="mw-tos-summary">' );
3184 $wgOut->addWikiMsg( $msg );
3185 $wgOut->addHTML( '</div>' );
3189 protected function showEditTools() {
3190 global $wgOut;
3191 $wgOut->addHTML( '<div class="mw-editTools">' .
3192 wfMessage( 'edittools' )->inContentLanguage()->parse() .
3193 '</div>' );
3197 * Get the copyright warning
3199 * Renamed to getCopyrightWarning(), old name kept around for backwards compatibility
3201 protected function getCopywarn() {
3202 return self::getCopyrightWarning( $this->mTitle );
3206 * Get the copyright warning, by default returns wikitext
3208 * @param Title $title
3209 * @param string $format Output format, valid values are any function of a Message object
3210 * @return string
3212 public static function getCopyrightWarning( $title, $format = 'plain' ) {
3213 global $wgRightsText;
3214 if ( $wgRightsText ) {
3215 $copywarnMsg = array( 'copyrightwarning',
3216 '[[' . wfMessage( 'copyrightpage' )->inContentLanguage()->text() . ']]',
3217 $wgRightsText );
3218 } else {
3219 $copywarnMsg = array( 'copyrightwarning2',
3220 '[[' . wfMessage( 'copyrightpage' )->inContentLanguage()->text() . ']]' );
3222 // Allow for site and per-namespace customization of contribution/copyright notice.
3223 wfRunHooks( 'EditPageCopyrightWarning', array( $title, &$copywarnMsg ) );
3225 return "<div id=\"editpage-copywarn\">\n" .
3226 call_user_func_array( 'wfMessage', $copywarnMsg )->$format() . "\n</div>";
3230 * Get the Limit report for page previews
3232 * @since 1.22
3233 * @param ParserOutput $output ParserOutput object from the parse
3234 * @return string HTML
3236 public static function getPreviewLimitReport( $output ) {
3237 if ( !$output || !$output->getLimitReportData() ) {
3238 return '';
3241 wfProfileIn( __METHOD__ );
3243 $limitReport = Html::rawElement( 'div', array( 'class' => 'mw-limitReportExplanation' ),
3244 wfMessage( 'limitreport-title' )->parseAsBlock()
3247 // Show/hide animation doesn't work correctly on a table, so wrap it in a div.
3248 $limitReport .= Html::openElement( 'div', array( 'class' => 'preview-limit-report-wrapper' ) );
3250 $limitReport .= Html::openElement( 'table', array(
3251 'class' => 'preview-limit-report wikitable'
3252 ) ) .
3253 Html::openElement( 'tbody' );
3255 foreach ( $output->getLimitReportData() as $key => $value ) {
3256 if ( wfRunHooks( 'ParserLimitReportFormat',
3257 array( $key, &$value, &$limitReport, true, true )
3258 ) ) {
3259 $keyMsg = wfMessage( $key );
3260 $valueMsg = wfMessage( array( "$key-value-html", "$key-value" ) );
3261 if ( !$valueMsg->exists() ) {
3262 $valueMsg = new RawMessage( '$1' );
3264 if ( !$keyMsg->isDisabled() && !$valueMsg->isDisabled() ) {
3265 $limitReport .= Html::openElement( 'tr' ) .
3266 Html::rawElement( 'th', null, $keyMsg->parse() ) .
3267 Html::rawElement( 'td', null, $valueMsg->params( $value )->parse() ) .
3268 Html::closeElement( 'tr' );
3273 $limitReport .= Html::closeElement( 'tbody' ) .
3274 Html::closeElement( 'table' ) .
3275 Html::closeElement( 'div' );
3277 wfProfileOut( __METHOD__ );
3279 return $limitReport;
3282 protected function showStandardInputs( &$tabindex = 2 ) {
3283 global $wgOut;
3284 $wgOut->addHTML( "<div class='editOptions'>\n" );
3286 if ( $this->section != 'new' ) {
3287 $this->showSummaryInput( false, $this->summary );
3288 $wgOut->addHTML( $this->getSummaryPreview( false, $this->summary ) );
3291 $checkboxes = $this->getCheckboxes( $tabindex,
3292 array( 'minor' => $this->minoredit, 'watch' => $this->watchthis ) );
3293 $wgOut->addHTML( "<div class='editCheckboxes'>" . implode( $checkboxes, "\n" ) . "</div>\n" );
3295 // Show copyright warning.
3296 $wgOut->addWikiText( $this->getCopywarn() );
3297 $wgOut->addHTML( $this->editFormTextAfterWarn );
3299 $wgOut->addHTML( "<div class='editButtons'>\n" );
3300 $wgOut->addHTML( implode( $this->getEditButtons( $tabindex ), "\n" ) . "\n" );
3302 $cancel = $this->getCancelLink();
3303 if ( $cancel !== '' ) {
3304 $cancel .= Html::element( 'span',
3305 array( 'class' => 'mw-editButtons-pipe-separator' ),
3306 wfMessage( 'pipe-separator' )->text() );
3309 $message = wfMessage( 'edithelppage' )->inContentLanguage()->text();
3310 $edithelpurl = Skin::makeInternalOrExternalUrl( $message );
3311 $edithelp = '<a target="helpwindow" href="' . $edithelpurl . '">' .
3312 wfMessage( 'edithelp' )->escaped() . '</a> ' .
3313 wfMessage( 'newwindow' )->parse();
3315 $wgOut->addHTML( " <span class='cancelLink'>{$cancel}</span>\n" );
3316 $wgOut->addHTML( " <span class='editHelp'>{$edithelp}</span>\n" );
3317 $wgOut->addHTML( "</div><!-- editButtons -->\n" );
3319 wfRunHooks( 'EditPage::showStandardInputs:options', array( $this, $wgOut, &$tabindex ) );
3321 $wgOut->addHTML( "</div><!-- editOptions -->\n" );
3325 * Show an edit conflict. textbox1 is already shown in showEditForm().
3326 * If you want to use another entry point to this function, be careful.
3328 protected function showConflict() {
3329 global $wgOut;
3331 if ( wfRunHooks( 'EditPageBeforeConflictDiff', array( &$this, &$wgOut ) ) ) {
3332 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
3334 $content1 = $this->toEditContent( $this->textbox1 );
3335 $content2 = $this->toEditContent( $this->textbox2 );
3337 $handler = ContentHandler::getForModelID( $this->contentModel );
3338 $de = $handler->createDifferenceEngine( $this->mArticle->getContext() );
3339 $de->setContent( $content2, $content1 );
3340 $de->showDiff(
3341 wfMessage( 'yourtext' )->parse(),
3342 wfMessage( 'storedversion' )->text()
3345 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
3346 $this->showTextbox2();
3351 * @return string
3353 public function getCancelLink() {
3354 $cancelParams = array();
3355 if ( !$this->isConflict && $this->oldid > 0 ) {
3356 $cancelParams['oldid'] = $this->oldid;
3359 return Linker::linkKnown(
3360 $this->getContextTitle(),
3361 wfMessage( 'cancel' )->parse(),
3362 array( 'id' => 'mw-editform-cancel' ),
3363 $cancelParams
3368 * Returns the URL to use in the form's action attribute.
3369 * This is used by EditPage subclasses when simply customizing the action
3370 * variable in the constructor is not enough. This can be used when the
3371 * EditPage lives inside of a Special page rather than a custom page action.
3373 * @param Title $title Title object for which is being edited (where we go to for &action= links)
3374 * @return string
3376 protected function getActionURL( Title $title ) {
3377 return $title->getLocalURL( array( 'action' => $this->action ) );
3381 * Check if a page was deleted while the user was editing it, before submit.
3382 * Note that we rely on the logging table, which hasn't been always there,
3383 * but that doesn't matter, because this only applies to brand new
3384 * deletes.
3385 * @return bool
3387 protected function wasDeletedSinceLastEdit() {
3388 if ( $this->deletedSinceEdit !== null ) {
3389 return $this->deletedSinceEdit;
3392 $this->deletedSinceEdit = false;
3394 if ( $this->mTitle->isDeletedQuick() ) {
3395 $this->lastDelete = $this->getLastDelete();
3396 if ( $this->lastDelete ) {
3397 $deleteTime = wfTimestamp( TS_MW, $this->lastDelete->log_timestamp );
3398 if ( $deleteTime > $this->starttime ) {
3399 $this->deletedSinceEdit = true;
3404 return $this->deletedSinceEdit;
3408 * @return bool|stdClass
3410 protected function getLastDelete() {
3411 $dbr = wfGetDB( DB_SLAVE );
3412 $data = $dbr->selectRow(
3413 array( 'logging', 'user' ),
3414 array(
3415 'log_type',
3416 'log_action',
3417 'log_timestamp',
3418 'log_user',
3419 'log_namespace',
3420 'log_title',
3421 'log_comment',
3422 'log_params',
3423 'log_deleted',
3424 'user_name'
3425 ), array(
3426 'log_namespace' => $this->mTitle->getNamespace(),
3427 'log_title' => $this->mTitle->getDBkey(),
3428 'log_type' => 'delete',
3429 'log_action' => 'delete',
3430 'user_id=log_user'
3432 __METHOD__,
3433 array( 'LIMIT' => 1, 'ORDER BY' => 'log_timestamp DESC' )
3435 // Quick paranoid permission checks...
3436 if ( is_object( $data ) ) {
3437 if ( $data->log_deleted & LogPage::DELETED_USER ) {
3438 $data->user_name = wfMessage( 'rev-deleted-user' )->escaped();
3441 if ( $data->log_deleted & LogPage::DELETED_COMMENT ) {
3442 $data->log_comment = wfMessage( 'rev-deleted-comment' )->escaped();
3446 return $data;
3450 * Get the rendered text for previewing.
3451 * @throws MWException
3452 * @return string
3454 function getPreviewText() {
3455 global $wgOut, $wgUser, $wgRawHtml, $wgLang;
3456 global $wgAllowUserCss, $wgAllowUserJs;
3458 wfProfileIn( __METHOD__ );
3460 if ( $wgRawHtml && !$this->mTokenOk ) {
3461 // Could be an offsite preview attempt. This is very unsafe if
3462 // HTML is enabled, as it could be an attack.
3463 $parsedNote = '';
3464 if ( $this->textbox1 !== '' ) {
3465 // Do not put big scary notice, if previewing the empty
3466 // string, which happens when you initially edit
3467 // a category page, due to automatic preview-on-open.
3468 $parsedNote = $wgOut->parse( "<div class='previewnote'>" .
3469 wfMessage( 'session_fail_preview_html' )->text() . "</div>", true, /* interface */true );
3471 wfProfileOut( __METHOD__ );
3472 return $parsedNote;
3475 $note = '';
3477 try {
3478 $content = $this->toEditContent( $this->textbox1 );
3480 $previewHTML = '';
3481 if ( !wfRunHooks(
3482 'AlternateEditPreview',
3483 array( $this, &$content, &$previewHTML, &$this->mParserOutput ) )
3485 wfProfileOut( __METHOD__ );
3486 return $previewHTML;
3489 # provide a anchor link to the editform
3490 $continueEditing = '<span class="mw-continue-editing">' .
3491 '[[#' . self::EDITFORM_ID . '|' . $wgLang->getArrow() . ' ' .
3492 wfMessage( 'continue-editing' )->text() . ']]</span>';
3493 if ( $this->mTriedSave && !$this->mTokenOk ) {
3494 if ( $this->mTokenOkExceptSuffix ) {
3495 $note = wfMessage( 'token_suffix_mismatch' )->plain();
3496 } else {
3497 $note = wfMessage( 'session_fail_preview' )->plain();
3499 } elseif ( $this->incompleteForm ) {
3500 $note = wfMessage( 'edit_form_incomplete' )->plain();
3501 } else {
3502 $note = wfMessage( 'previewnote' )->plain() . ' ' . $continueEditing;
3505 $parserOptions = $this->mArticle->makeParserOptions( $this->mArticle->getContext() );
3506 $parserOptions->setEditSection( false );
3507 $parserOptions->setIsPreview( true );
3508 $parserOptions->setIsSectionPreview( !is_null( $this->section ) && $this->section !== '' );
3510 # don't parse non-wikitext pages, show message about preview
3511 if ( $this->mTitle->isCssJsSubpage() || $this->mTitle->isCssOrJsPage() ) {
3512 if ( $this->mTitle->isCssJsSubpage() ) {
3513 $level = 'user';
3514 } elseif ( $this->mTitle->isCssOrJsPage() ) {
3515 $level = 'site';
3516 } else {
3517 $level = false;
3520 if ( $content->getModel() == CONTENT_MODEL_CSS ) {
3521 $format = 'css';
3522 if ( $level === 'user' && !$wgAllowUserCss ) {
3523 $format = false;
3525 } elseif ( $content->getModel() == CONTENT_MODEL_JAVASCRIPT ) {
3526 $format = 'js';
3527 if ( $level === 'user' && !$wgAllowUserJs ) {
3528 $format = false;
3530 } else {
3531 $format = false;
3534 # Used messages to make sure grep find them:
3535 # Messages: usercsspreview, userjspreview, sitecsspreview, sitejspreview
3536 if ( $level && $format ) {
3537 $note = "<div id='mw-{$level}{$format}preview'>" .
3538 wfMessage( "{$level}{$format}preview" )->text() .
3539 ' ' . $continueEditing . "</div>";
3543 # If we're adding a comment, we need to show the
3544 # summary as the headline
3545 if ( $this->section === "new" && $this->summary !== "" ) {
3546 $content = $content->addSectionHeader( $this->summary );
3549 $hook_args = array( $this, &$content );
3550 ContentHandler::runLegacyHooks( 'EditPageGetPreviewText', $hook_args );
3551 wfRunHooks( 'EditPageGetPreviewContent', $hook_args );
3553 $parserOptions->enableLimitReport();
3555 # For CSS/JS pages, we should have called the ShowRawCssJs hook here.
3556 # But it's now deprecated, so never mind
3558 $content = $content->preSaveTransform( $this->mTitle, $wgUser, $parserOptions );
3559 $parserOutput = $content->getParserOutput(
3560 $this->getArticle()->getTitle(),
3561 null,
3562 $parserOptions
3565 $previewHTML = $parserOutput->getText();
3566 $this->mParserOutput = $parserOutput;
3567 $wgOut->addParserOutputMetadata( $parserOutput );
3569 if ( count( $parserOutput->getWarnings() ) ) {
3570 $note .= "\n\n" . implode( "\n\n", $parserOutput->getWarnings() );
3572 } catch ( MWContentSerializationException $ex ) {
3573 $m = wfMessage(
3574 'content-failed-to-parse',
3575 $this->contentModel,
3576 $this->contentFormat,
3577 $ex->getMessage()
3579 $note .= "\n\n" . $m->parse();
3580 $previewHTML = '';
3583 if ( $this->isConflict ) {
3584 $conflict = '<h2 id="mw-previewconflict">'
3585 . wfMessage( 'previewconflict' )->escaped() . "</h2>\n";
3586 } else {
3587 $conflict = '<hr />';
3590 $previewhead = "<div class='previewnote'>\n" .
3591 '<h2 id="mw-previewheader">' . wfMessage( 'preview' )->escaped() . "</h2>" .
3592 $wgOut->parse( $note, true, /* interface */true ) . $conflict . "</div>\n";
3594 $pageViewLang = $this->mTitle->getPageViewLanguage();
3595 $attribs = array( 'lang' => $pageViewLang->getHtmlCode(), 'dir' => $pageViewLang->getDir(),
3596 'class' => 'mw-content-' . $pageViewLang->getDir() );
3597 $previewHTML = Html::rawElement( 'div', $attribs, $previewHTML );
3599 wfProfileOut( __METHOD__ );
3600 return $previewhead . $previewHTML . $this->previewTextAfterContent;
3604 * @return array
3606 function getTemplates() {
3607 if ( $this->preview || $this->section != '' ) {
3608 $templates = array();
3609 if ( !isset( $this->mParserOutput ) ) {
3610 return $templates;
3612 foreach ( $this->mParserOutput->getTemplates() as $ns => $template ) {
3613 foreach ( array_keys( $template ) as $dbk ) {
3614 $templates[] = Title::makeTitle( $ns, $dbk );
3617 return $templates;
3618 } else {
3619 return $this->mTitle->getTemplateLinksFrom();
3624 * Shows a bulletin board style toolbar for common editing functions.
3625 * It can be disabled in the user preferences.
3626 * The necessary JavaScript code can be found in skins/common/edit.js.
3628 * @return string
3630 static function getEditToolbar() {
3631 global $wgStylePath, $wgContLang, $wgLang, $wgOut;
3632 global $wgEnableUploads, $wgForeignFileRepos;
3634 $imagesAvailable = $wgEnableUploads || count( $wgForeignFileRepos );
3637 * $toolarray is an array of arrays each of which includes the
3638 * filename of the button image (without path), the opening
3639 * tag, the closing tag, optionally a sample text that is
3640 * inserted between the two when no selection is highlighted
3641 * and. The tip text is shown when the user moves the mouse
3642 * over the button.
3644 * Also here: accesskeys (key), which are not used yet until
3645 * someone can figure out a way to make them work in
3646 * IE. However, we should make sure these keys are not defined
3647 * on the edit page.
3649 $toolarray = array(
3650 array(
3651 'image' => $wgLang->getImageFile( 'button-bold' ),
3652 'id' => 'mw-editbutton-bold',
3653 'open' => '\'\'\'',
3654 'close' => '\'\'\'',
3655 'sample' => wfMessage( 'bold_sample' )->text(),
3656 'tip' => wfMessage( 'bold_tip' )->text(),
3657 'key' => 'B'
3659 array(
3660 'image' => $wgLang->getImageFile( 'button-italic' ),
3661 'id' => 'mw-editbutton-italic',
3662 'open' => '\'\'',
3663 'close' => '\'\'',
3664 'sample' => wfMessage( 'italic_sample' )->text(),
3665 'tip' => wfMessage( 'italic_tip' )->text(),
3666 'key' => 'I'
3668 array(
3669 'image' => $wgLang->getImageFile( 'button-link' ),
3670 'id' => 'mw-editbutton-link',
3671 'open' => '[[',
3672 'close' => ']]',
3673 'sample' => wfMessage( 'link_sample' )->text(),
3674 'tip' => wfMessage( 'link_tip' )->text(),
3675 'key' => 'L'
3677 array(
3678 'image' => $wgLang->getImageFile( 'button-extlink' ),
3679 'id' => 'mw-editbutton-extlink',
3680 'open' => '[',
3681 'close' => ']',
3682 'sample' => wfMessage( 'extlink_sample' )->text(),
3683 'tip' => wfMessage( 'extlink_tip' )->text(),
3684 'key' => 'X'
3686 array(
3687 'image' => $wgLang->getImageFile( 'button-headline' ),
3688 'id' => 'mw-editbutton-headline',
3689 'open' => "\n== ",
3690 'close' => " ==\n",
3691 'sample' => wfMessage( 'headline_sample' )->text(),
3692 'tip' => wfMessage( 'headline_tip' )->text(),
3693 'key' => 'H'
3695 $imagesAvailable ? array(
3696 'image' => $wgLang->getImageFile( 'button-image' ),
3697 'id' => 'mw-editbutton-image',
3698 'open' => '[[' . $wgContLang->getNsText( NS_FILE ) . ':',
3699 'close' => ']]',
3700 'sample' => wfMessage( 'image_sample' )->text(),
3701 'tip' => wfMessage( 'image_tip' )->text(),
3702 'key' => 'D',
3703 ) : false,
3704 $imagesAvailable ? array(
3705 'image' => $wgLang->getImageFile( 'button-media' ),
3706 'id' => 'mw-editbutton-media',
3707 'open' => '[[' . $wgContLang->getNsText( NS_MEDIA ) . ':',
3708 'close' => ']]',
3709 'sample' => wfMessage( 'media_sample' )->text(),
3710 'tip' => wfMessage( 'media_tip' )->text(),
3711 'key' => 'M'
3712 ) : false,
3713 array(
3714 'image' => $wgLang->getImageFile( 'button-nowiki' ),
3715 'id' => 'mw-editbutton-nowiki',
3716 'open' => "<nowiki>",
3717 'close' => "</nowiki>",
3718 'sample' => wfMessage( 'nowiki_sample' )->text(),
3719 'tip' => wfMessage( 'nowiki_tip' )->text(),
3720 'key' => 'N'
3722 array(
3723 'image' => $wgLang->getImageFile( 'button-sig' ),
3724 'id' => 'mw-editbutton-signature',
3725 'open' => '--~~~~',
3726 'close' => '',
3727 'sample' => '',
3728 'tip' => wfMessage( 'sig_tip' )->text(),
3729 'key' => 'Y'
3731 array(
3732 'image' => $wgLang->getImageFile( 'button-hr' ),
3733 'id' => 'mw-editbutton-hr',
3734 'open' => "\n----\n",
3735 'close' => '',
3736 'sample' => '',
3737 'tip' => wfMessage( 'hr_tip' )->text(),
3738 'key' => 'R'
3742 $script = 'mw.loader.using("mediawiki.action.edit", function() {';
3743 foreach ( $toolarray as $tool ) {
3744 if ( !$tool ) {
3745 continue;
3748 $params = array(
3749 $wgStylePath . '/common/images/' . $tool['image'],
3750 // Note that we use the tip both for the ALT tag and the TITLE tag of the image.
3751 // Older browsers show a "speedtip" type message only for ALT.
3752 // Ideally these should be different, realistically they
3753 // probably don't need to be.
3754 $tool['tip'],
3755 $tool['open'],
3756 $tool['close'],
3757 $tool['sample'],
3758 $tool['id'],
3761 $script .= Xml::encodeJsCall( 'mw.toolbar.addButton', $params );
3764 // This used to be called on DOMReady from mediawiki.action.edit, which
3765 // ended up causing race conditions with the setup code above.
3766 $script .= "\n" .
3767 "// Create button bar\n" .
3768 "$(function() { mw.toolbar.init(); } );\n";
3770 $script .= '});';
3771 $wgOut->addScript( Html::inlineScript( ResourceLoader::makeLoaderConditionalScript( $script ) ) );
3773 $toolbar = '<div id="toolbar"></div>';
3775 wfRunHooks( 'EditPageBeforeEditToolbar', array( &$toolbar ) );
3777 return $toolbar;
3781 * Returns an array of html code of the following checkboxes:
3782 * minor and watch
3784 * @param int $tabindex Current tabindex
3785 * @param array $checked Array of checkbox => bool, where bool indicates the checked
3786 * status of the checkbox
3788 * @return array
3790 public function getCheckboxes( &$tabindex, $checked ) {
3791 global $wgUser;
3793 $checkboxes = array();
3795 // don't show the minor edit checkbox if it's a new page or section
3796 if ( !$this->isNew ) {
3797 $checkboxes['minor'] = '';
3798 $minorLabel = wfMessage( 'minoredit' )->parse();
3799 if ( $wgUser->isAllowed( 'minoredit' ) ) {
3800 $attribs = array(
3801 'tabindex' => ++$tabindex,
3802 'accesskey' => wfMessage( 'accesskey-minoredit' )->text(),
3803 'id' => 'wpMinoredit',
3805 $checkboxes['minor'] =
3806 Xml::check( 'wpMinoredit', $checked['minor'], $attribs ) .
3807 "&#160;<label for='wpMinoredit' id='mw-editpage-minoredit'" .
3808 Xml::expandAttributes( array( 'title' => Linker::titleAttrib( 'minoredit', 'withaccess' ) ) ) .
3809 ">{$minorLabel}</label>";
3813 $watchLabel = wfMessage( 'watchthis' )->parse();
3814 $checkboxes['watch'] = '';
3815 if ( $wgUser->isLoggedIn() ) {
3816 $attribs = array(
3817 'tabindex' => ++$tabindex,
3818 'accesskey' => wfMessage( 'accesskey-watch' )->text(),
3819 'id' => 'wpWatchthis',
3821 $checkboxes['watch'] =
3822 Xml::check( 'wpWatchthis', $checked['watch'], $attribs ) .
3823 "&#160;<label for='wpWatchthis' id='mw-editpage-watch'" .
3824 Xml::expandAttributes( array( 'title' => Linker::titleAttrib( 'watch', 'withaccess' ) ) ) .
3825 ">{$watchLabel}</label>";
3827 wfRunHooks( 'EditPageBeforeEditChecks', array( &$this, &$checkboxes, &$tabindex ) );
3828 return $checkboxes;
3832 * Returns an array of html code of the following buttons:
3833 * save, diff, preview and live
3835 * @param int $tabindex Current tabindex
3837 * @return array
3839 public function getEditButtons( &$tabindex ) {
3840 $buttons = array();
3842 $attribs = array(
3843 'id' => 'wpSave',
3844 'name' => 'wpSave',
3845 'type' => 'submit',
3846 'tabindex' => ++$tabindex,
3847 'value' => wfMessage( 'savearticle' )->text(),
3848 ) + Linker::tooltipAndAccesskeyAttribs( 'save' );
3849 $buttons['save'] = Xml::element( 'input', $attribs, '' );
3851 ++$tabindex; // use the same for preview and live preview
3852 $attribs = array(
3853 'id' => 'wpPreview',
3854 'name' => 'wpPreview',
3855 'type' => 'submit',
3856 'tabindex' => $tabindex,
3857 'value' => wfMessage( 'showpreview' )->text(),
3858 ) + Linker::tooltipAndAccesskeyAttribs( 'preview' );
3859 $buttons['preview'] = Xml::element( 'input', $attribs, '' );
3860 $buttons['live'] = '';
3862 $attribs = array(
3863 'id' => 'wpDiff',
3864 'name' => 'wpDiff',
3865 'type' => 'submit',
3866 'tabindex' => ++$tabindex,
3867 'value' => wfMessage( 'showdiff' )->text(),
3868 ) + Linker::tooltipAndAccesskeyAttribs( 'diff' );
3869 $buttons['diff'] = Xml::element( 'input', $attribs, '' );
3871 wfRunHooks( 'EditPageBeforeEditButtons', array( &$this, &$buttons, &$tabindex ) );
3872 return $buttons;
3876 * Output preview text only. This can be sucked into the edit page
3877 * via JavaScript, and saves the server time rendering the skin as
3878 * well as theoretically being more robust on the client (doesn't
3879 * disturb the edit box's undo history, won't eat your text on
3880 * failure, etc).
3882 * @todo This doesn't include category or interlanguage links.
3883 * Would need to enhance it a bit, "<s>maybe wrap them in XML
3884 * or something...</s>" that might also require more skin
3885 * initialization, so check whether that's a problem.
3887 function livePreview() {
3888 global $wgOut;
3889 $wgOut->disable();
3890 header( 'Content-type: text/xml; charset=utf-8' );
3891 header( 'Cache-control: no-cache' );
3893 $previewText = $this->getPreviewText();
3894 #$categories = $skin->getCategoryLinks();
3896 $s =
3897 '<?xml version="1.0" encoding="UTF-8" ?>' . "\n" .
3898 Xml::tags( 'livepreview', null,
3899 Xml::element( 'preview', null, $previewText )
3900 #. Xml::element( 'category', null, $categories )
3902 echo $s;
3906 * Call the stock "user is blocked" page
3908 * @deprecated since 1.19; throw an exception directly instead
3910 function blockedPage() {
3911 wfDeprecated( __METHOD__, '1.19' );
3912 global $wgUser;
3914 throw new UserBlockedError( $wgUser->getBlock() );
3918 * Produce the stock "please login to edit pages" page
3920 * @deprecated since 1.19; throw an exception directly instead
3922 function userNotLoggedInPage() {
3923 wfDeprecated( __METHOD__, '1.19' );
3924 throw new PermissionsError( 'edit' );
3928 * Show an error page saying to the user that he has insufficient permissions
3929 * to create a new page
3931 * @deprecated since 1.19; throw an exception directly instead
3933 function noCreatePermission() {
3934 wfDeprecated( __METHOD__, '1.19' );
3935 $permission = $this->mTitle->isTalkPage() ? 'createtalk' : 'createpage';
3936 throw new PermissionsError( $permission );
3940 * Creates a basic error page which informs the user that
3941 * they have attempted to edit a nonexistent section.
3943 function noSuchSectionPage() {
3944 global $wgOut;
3946 $wgOut->prepareErrorPage( wfMessage( 'nosuchsectiontitle' ) );
3948 $res = wfMessage( 'nosuchsectiontext', $this->section )->parseAsBlock();
3949 wfRunHooks( 'EditPageNoSuchSection', array( &$this, &$res ) );
3950 $wgOut->addHTML( $res );
3952 $wgOut->returnToMain( false, $this->mTitle );
3956 * Show "your edit contains spam" page with your diff and text
3958 * @param string|array|bool $match Text (or array of texts) which triggered one or more filters
3960 public function spamPageWithContent( $match = false ) {
3961 global $wgOut, $wgLang;
3962 $this->textbox2 = $this->textbox1;
3964 if ( is_array( $match ) ) {
3965 $match = $wgLang->listToText( $match );
3967 $wgOut->prepareErrorPage( wfMessage( 'spamprotectiontitle' ) );
3969 $wgOut->addHTML( '<div id="spamprotected">' );
3970 $wgOut->addWikiMsg( 'spamprotectiontext' );
3971 if ( $match ) {
3972 $wgOut->addWikiMsg( 'spamprotectionmatch', wfEscapeWikiText( $match ) );
3974 $wgOut->addHTML( '</div>' );
3976 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
3977 $this->showDiff();
3979 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
3980 $this->showTextbox2();
3982 $wgOut->addReturnTo( $this->getContextTitle(), array( 'action' => 'edit' ) );
3986 * Check if the browser is on a blacklist of user-agents known to
3987 * mangle UTF-8 data on form submission. Returns true if Unicode
3988 * should make it through, false if it's known to be a problem.
3989 * @return bool
3991 private function checkUnicodeCompliantBrowser() {
3992 global $wgBrowserBlackList, $wgRequest;
3994 $currentbrowser = $wgRequest->getHeader( 'User-Agent' );
3995 if ( $currentbrowser === false ) {
3996 // No User-Agent header sent? Trust it by default...
3997 return true;
4000 foreach ( $wgBrowserBlackList as $browser ) {
4001 if ( preg_match( $browser, $currentbrowser ) ) {
4002 return false;
4005 return true;
4009 * Filter an input field through a Unicode de-armoring process if it
4010 * came from an old browser with known broken Unicode editing issues.
4012 * @param WebRequest $request
4013 * @param string $field
4014 * @return string
4016 protected function safeUnicodeInput( $request, $field ) {
4017 $text = rtrim( $request->getText( $field ) );
4018 return $request->getBool( 'safemode' )
4019 ? $this->unmakeSafe( $text )
4020 : $text;
4024 * Filter an output field through a Unicode armoring process if it is
4025 * going to an old browser with known broken Unicode editing issues.
4027 * @param string $text
4028 * @return string
4030 protected function safeUnicodeOutput( $text ) {
4031 global $wgContLang;
4032 $codedText = $wgContLang->recodeForEdit( $text );
4033 return $this->checkUnicodeCompliantBrowser()
4034 ? $codedText
4035 : $this->makeSafe( $codedText );
4039 * A number of web browsers are known to corrupt non-ASCII characters
4040 * in a UTF-8 text editing environment. To protect against this,
4041 * detected browsers will be served an armored version of the text,
4042 * with non-ASCII chars converted to numeric HTML character references.
4044 * Preexisting such character references will have a 0 added to them
4045 * to ensure that round-trips do not alter the original data.
4047 * @param string $invalue
4048 * @return string
4050 private function makeSafe( $invalue ) {
4051 // Armor existing references for reversibility.
4052 $invalue = strtr( $invalue, array( "&#x" => "&#x0" ) );
4054 $bytesleft = 0;
4055 $result = "";
4056 $working = 0;
4057 $valueLength = strlen( $invalue );
4058 for ( $i = 0; $i < $valueLength; $i++ ) {
4059 $bytevalue = ord( $invalue[$i] );
4060 if ( $bytevalue <= 0x7F ) { // 0xxx xxxx
4061 $result .= chr( $bytevalue );
4062 $bytesleft = 0;
4063 } elseif ( $bytevalue <= 0xBF ) { // 10xx xxxx
4064 $working = $working << 6;
4065 $working += ( $bytevalue & 0x3F );
4066 $bytesleft--;
4067 if ( $bytesleft <= 0 ) {
4068 $result .= "&#x" . strtoupper( dechex( $working ) ) . ";";
4070 } elseif ( $bytevalue <= 0xDF ) { // 110x xxxx
4071 $working = $bytevalue & 0x1F;
4072 $bytesleft = 1;
4073 } elseif ( $bytevalue <= 0xEF ) { // 1110 xxxx
4074 $working = $bytevalue & 0x0F;
4075 $bytesleft = 2;
4076 } else { // 1111 0xxx
4077 $working = $bytevalue & 0x07;
4078 $bytesleft = 3;
4081 return $result;
4085 * Reverse the previously applied transliteration of non-ASCII characters
4086 * back to UTF-8. Used to protect data from corruption by broken web browsers
4087 * as listed in $wgBrowserBlackList.
4089 * @param string $invalue
4090 * @return string
4092 private function unmakeSafe( $invalue ) {
4093 $result = "";
4094 $valueLength = strlen( $invalue );
4095 for ( $i = 0; $i < $valueLength; $i++ ) {
4096 if ( ( substr( $invalue, $i, 3 ) == "&#x" ) && ( $invalue[$i + 3] != '0' ) ) {
4097 $i += 3;
4098 $hexstring = "";
4099 do {
4100 $hexstring .= $invalue[$i];
4101 $i++;
4102 } while ( ctype_xdigit( $invalue[$i] ) && ( $i < strlen( $invalue ) ) );
4104 // Do some sanity checks. These aren't needed for reversibility,
4105 // but should help keep the breakage down if the editor
4106 // breaks one of the entities whilst editing.
4107 if ( ( substr( $invalue, $i, 1 ) == ";" ) and ( strlen( $hexstring ) <= 6 ) ) {
4108 $codepoint = hexdec( $hexstring );
4109 $result .= codepointToUtf8( $codepoint );
4110 } else {
4111 $result .= "&#x" . $hexstring . substr( $invalue, $i, 1 );
4113 } else {
4114 $result .= substr( $invalue, $i, 1 );
4117 // reverse the transform that we made for reversibility reasons.
4118 return strtr( $result, array( "&#x0" => "&#x" ) );