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
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
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.
40 * Status: Article successfully updated
42 const AS_SUCCESS_UPDATE
= 200;
45 * Status: Article successfully created
47 const AS_SUCCESS_NEW_ARTICLE
= 201;
50 * Status: Article update aborted by a hook function
52 const AS_HOOK_ERROR
= 210;
55 * Status: A hook function returned an error
57 const AS_HOOK_ERROR_EXPECTED
= 212;
60 * Status: User is blocked from editing this page
62 const AS_BLOCKED_PAGE_FOR_USER
= 215;
65 * Status: Content too big (> $wgMaxArticleSize)
67 const AS_CONTENT_TOO_BIG
= 216;
70 * Status: this anonymous user is not allowed to edit this page
72 const AS_READ_ONLY_PAGE_ANON
= 218;
75 * Status: this logged in user is not allowed to edit this page
77 const AS_READ_ONLY_PAGE_LOGGED
= 219;
80 * Status: wiki is in readonly mode (wfReadOnly() == true)
82 const AS_READ_ONLY_PAGE
= 220;
85 * Status: rate limiter for action 'edit' was tripped
87 const AS_RATE_LIMITED
= 221;
90 * Status: article was deleted while editing and param wpRecreate == false or form
93 const AS_ARTICLE_WAS_DELETED
= 222;
96 * Status: user tried to create this page, but is not allowed to do that
97 * ( Title->userCan('create') == false )
99 const AS_NO_CREATE_PERMISSION
= 223;
102 * Status: user tried to create a blank page and wpIgnoreBlankArticle == false
104 const AS_BLANK_ARTICLE
= 224;
107 * Status: (non-resolvable) edit conflict
109 const AS_CONFLICT_DETECTED
= 225;
112 * Status: no edit summary given and the user has forceeditsummary set and the user is not
113 * editing in his own userspace or talkspace and wpIgnoreBlankSummary == false
115 const AS_SUMMARY_NEEDED
= 226;
118 * Status: user tried to create a new section without content
120 const AS_TEXTBOX_EMPTY
= 228;
123 * Status: article is too big (> $wgMaxArticleSize), after merging in the new section
125 const AS_MAX_ARTICLE_SIZE_EXCEEDED
= 229;
128 * Status: WikiPage::doEdit() was unsuccessful
133 * Status: summary contained spam according to one of the regexes in $wgSummarySpamRegex
135 const AS_SPAM_ERROR
= 232;
138 * Status: anonymous user is not allowed to upload (User::isAllowed('upload') == false)
140 const AS_IMAGE_REDIRECT_ANON
= 233;
143 * Status: logged in user is not allowed to upload (User::isAllowed('upload') == false)
145 const AS_IMAGE_REDIRECT_LOGGED
= 234;
148 * Status: user tried to modify the content model, but is not allowed to do that
149 * ( User::isAllowed('editcontentmodel') == false )
151 const AS_NO_CHANGE_CONTENT_MODEL
= 235;
154 * Status: can't parse content
156 const AS_PARSE_ERROR
= 240;
159 * HTML id and name for the beginning of the edit form.
161 const EDITFORM_ID
= 'editform';
164 * Prefix of key for cookie used to pass post-edit state.
165 * The revision id edited is added after this
167 const POST_EDIT_COOKIE_KEY_PREFIX
= 'PostEditRevision';
170 * Duration of PostEdit cookie, in seconds.
171 * The cookie will be removed instantly if the JavaScript runs.
173 * Otherwise, though, we don't want the cookies to accumulate.
174 * RFC 2109 ( https://www.ietf.org/rfc/rfc2109.txt ) specifies a possible
175 * limit of only 20 cookies per domain. This still applies at least to some
176 * versions of IE without full updates:
177 * https://blogs.msdn.com/b/ieinternals/archive/2009/08/20/wininet-ie-cookie-internals-faq.aspx
179 * A value of 20 minutes should be enough to take into account slow loads and minor
180 * clock skew while still avoiding cookie accumulation when JavaScript is turned off.
182 const POST_EDIT_COOKIE_DURATION
= 1200;
190 /** @var null|Title */
191 private $mContextTitle = null;
194 public $action = 'submit';
197 public $isConflict = false;
200 public $isCssJsSubpage = false;
203 public $isCssSubpage = false;
206 public $isJsSubpage = false;
209 public $isWrongCaseCssJsPage = false;
211 /** @var bool New page or new section */
212 public $isNew = false;
215 public $deletedSinceEdit;
223 /** @var bool|stdClass */
227 public $mTokenOk = false;
230 public $mTokenOkExceptSuffix = false;
233 public $mTriedSave = false;
236 public $incompleteForm = false;
239 public $tooBig = false;
242 public $kblength = false;
245 public $missingComment = false;
248 public $missingSummary = false;
251 public $allowBlankSummary = false;
254 protected $blankArticle = false;
257 protected $allowBlankArticle = false;
260 public $autoSumm = '';
263 public $hookError = '';
265 /** @var ParserOutput */
266 public $mParserOutput;
268 /** @var bool Has a summary been preset using GET parameter &summary= ? */
269 public $hasPresetSummary = false;
272 public $mBaseRevision = false;
275 public $mShowSummaryField = true;
280 public $save = false;
283 public $preview = false;
286 public $diff = false;
289 public $minoredit = false;
292 public $watchthis = false;
295 public $recreate = false;
298 public $textbox1 = '';
301 public $textbox2 = '';
304 public $summary = '';
307 public $nosummary = false;
310 public $edittime = '';
313 public $section = '';
316 public $sectiontitle = '';
319 public $starttime = '';
325 public $parentRevId = 0;
328 public $editintro = '';
331 public $scrolltop = null;
336 /** @var null|string */
337 public $contentModel = null;
339 /** @var null|string */
340 public $contentFormat = null;
342 # Placeholders for text injection by hooks (must be HTML)
343 # extensions should take care to _append_ to the present value
345 /** @var string Before even the preview */
346 public $editFormPageTop = '';
347 public $editFormTextTop = '';
348 public $editFormTextBeforeContent = '';
349 public $editFormTextAfterWarn = '';
350 public $editFormTextAfterTools = '';
351 public $editFormTextBottom = '';
352 public $editFormTextAfterContent = '';
353 public $previewTextAfterContent = '';
354 public $mPreloadContent = null;
356 /* $didSave should be set to true whenever an article was successfully altered. */
357 public $didSave = false;
358 public $undidRev = 0;
360 public $suppressIntro = false;
362 /** @var bool Set to true to allow editing of non-text content types. */
363 public $allowNonTextContent = false;
372 * @param Article $article
374 public function __construct( Article
$article ) {
375 $this->mArticle
= $article;
376 $this->mTitle
= $article->getTitle();
378 $this->contentModel
= $this->mTitle
->getContentModel();
380 $handler = ContentHandler
::getForModelID( $this->contentModel
);
381 $this->contentFormat
= $handler->getDefaultFormat();
387 public function getArticle() {
388 return $this->mArticle
;
395 public function getTitle() {
396 return $this->mTitle
;
400 * Set the context Title object
402 * @param Title|null $title Title object or null
404 public function setContextTitle( $title ) {
405 $this->mContextTitle
= $title;
409 * Get the context title object.
410 * If not set, $wgTitle will be returned. This behavior might change in
411 * the future to return $this->mTitle instead.
415 public function getContextTitle() {
416 if ( is_null( $this->mContextTitle
) ) {
420 return $this->mContextTitle
;
425 * Returns if the given content model is editable.
427 * @param string $modelId The ID of the content model to test. Use CONTENT_MODEL_XXX constants.
429 * @throws MWException If $modelId has no known handler
431 public function isSupportedContentModel( $modelId ) {
432 return $this->allowNonTextContent ||
433 ContentHandler
::getForModelID( $modelId ) instanceof TextContentHandler
;
441 * This is the function that gets called for "action=edit". It
442 * sets up various member variables, then passes execution to
443 * another function, usually showEditForm()
445 * The edit form is self-submitting, so that when things like
446 * preview and edit conflicts occur, we get the same form back
447 * with the extra stuff added. Only when the final submission
448 * is made and all is well do we actually save and redirect to
449 * the newly-edited page.
452 global $wgOut, $wgRequest, $wgUser;
453 // Allow extensions to modify/prevent this form or submission
454 if ( !wfRunHooks( 'AlternateEdit', array( $this ) ) ) {
458 wfProfileIn( __METHOD__
);
459 wfDebug( __METHOD__
. ": enter\n" );
461 // If they used redlink=1 and the page exists, redirect to the main article
462 if ( $wgRequest->getBool( 'redlink' ) && $this->mTitle
->exists() ) {
463 $wgOut->redirect( $this->mTitle
->getFullURL() );
464 wfProfileOut( __METHOD__
);
468 $this->importFormData( $wgRequest );
469 $this->firsttime
= false;
472 $this->livePreview();
473 wfProfileOut( __METHOD__
);
477 if ( wfReadOnly() && $this->save
) {
480 $this->preview
= true;
484 $this->formtype
= 'save';
485 } elseif ( $this->preview
) {
486 $this->formtype
= 'preview';
487 } elseif ( $this->diff
) {
488 $this->formtype
= 'diff';
489 } else { # First time through
490 $this->firsttime
= true;
491 if ( $this->previewOnOpen() ) {
492 $this->formtype
= 'preview';
494 $this->formtype
= 'initial';
498 $permErrors = $this->getEditPermissionErrors();
500 wfDebug( __METHOD__
. ": User can't edit\n" );
501 // Auto-block user's IP if the account was "hard" blocked
502 $wgUser->spreadAnyEditBlock();
504 $this->displayPermissionsError( $permErrors );
506 wfProfileOut( __METHOD__
);
510 wfProfileIn( __METHOD__
. "-business-end" );
512 $this->isConflict
= false;
513 // css / js subpages of user pages get a special treatment
514 $this->isCssJsSubpage
= $this->mTitle
->isCssJsSubpage();
515 $this->isCssSubpage
= $this->mTitle
->isCssSubpage();
516 $this->isJsSubpage
= $this->mTitle
->isJsSubpage();
517 // @todo FIXME: Silly assignment.
518 $this->isWrongCaseCssJsPage
= $this->isWrongCaseCssJsPage();
520 # Show applicable editing introductions
521 if ( $this->formtype
== 'initial' ||
$this->firsttime
) {
525 # Attempt submission here. This will check for edit conflicts,
526 # and redundantly check for locked database, blocked IPs, etc.
527 # that edit() already checked just in case someone tries to sneak
528 # in the back door with a hand-edited submission URL.
530 if ( 'save' == $this->formtype
) {
531 if ( !$this->attemptSave() ) {
532 wfProfileOut( __METHOD__
. "-business-end" );
533 wfProfileOut( __METHOD__
);
538 # First time through: get contents, set time for conflict
540 if ( 'initial' == $this->formtype ||
$this->firsttime
) {
541 if ( $this->initialiseForm() === false ) {
542 $this->noSuchSectionPage();
543 wfProfileOut( __METHOD__
. "-business-end" );
544 wfProfileOut( __METHOD__
);
548 if ( !$this->mTitle
->getArticleID() ) {
549 wfRunHooks( 'EditFormPreloadText', array( &$this->textbox1
, &$this->mTitle
) );
551 wfRunHooks( 'EditFormInitialText', array( $this ) );
556 $this->showEditForm();
557 wfProfileOut( __METHOD__
. "-business-end" );
558 wfProfileOut( __METHOD__
);
564 protected function getEditPermissionErrors() {
566 $permErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $wgUser );
567 # Can this title be created?
568 if ( !$this->mTitle
->exists() ) {
569 $permErrors = array_merge( $permErrors,
570 wfArrayDiff2( $this->mTitle
->getUserPermissionsErrors( 'create', $wgUser ), $permErrors ) );
572 # Ignore some permissions errors when a user is just previewing/viewing diffs
574 foreach ( $permErrors as $error ) {
575 if ( ( $this->preview ||
$this->diff
)
576 && ( $error[0] == 'blockedtext' ||
$error[0] == 'autoblockedtext' )
581 $permErrors = wfArrayDiff2( $permErrors, $remove );
586 * Display a permissions error page, like OutputPage::showPermissionsErrorPage(),
587 * but with the following differences:
588 * - If redlink=1, the user will be redirected to the page
589 * - If there is content to display or the error occurs while either saving,
590 * previewing or showing the difference, it will be a
591 * "View source for ..." page displaying the source code after the error message.
594 * @param array $permErrors Array of permissions errors, as returned by
595 * Title::getUserPermissionsErrors().
596 * @throws PermissionsError
598 protected function displayPermissionsError( array $permErrors ) {
599 global $wgRequest, $wgOut;
601 if ( $wgRequest->getBool( 'redlink' ) ) {
602 // The edit page was reached via a red link.
603 // Redirect to the article page and let them click the edit tab if
604 // they really want a permission error.
605 $wgOut->redirect( $this->mTitle
->getFullURL() );
609 $content = $this->getContentObject();
611 # Use the normal message if there's nothing to display
612 if ( $this->firsttime
&& ( !$content ||
$content->isEmpty() ) ) {
613 $action = $this->mTitle
->exists() ?
'edit' :
614 ( $this->mTitle
->isTalkPage() ?
'createtalk' : 'createpage' );
615 throw new PermissionsError( $action, $permErrors );
618 wfRunHooks( 'EditPage::showReadOnlyForm:initial', array( $this, &$wgOut ) );
620 $wgOut->setRobotPolicy( 'noindex,nofollow' );
621 $wgOut->setPageTitle( wfMessage(
623 $this->getContextTitle()->getPrefixedText()
625 $wgOut->addBacklinkSubtitle( $this->getContextTitle() );
626 $wgOut->addWikiText( $wgOut->formatPermissionsErrorMessage( $permErrors, 'edit' ) );
627 $wgOut->addHTML( "<hr />\n" );
629 # If the user made changes, preserve them when showing the markup
630 # (This happens when a user is blocked during edit, for instance)
631 if ( !$this->firsttime
) {
632 $text = $this->textbox1
;
633 $wgOut->addWikiMsg( 'viewyourtext' );
635 $text = $this->toEditText( $content );
636 $wgOut->addWikiMsg( 'viewsourcetext' );
639 $this->showTextbox( $text, 'wpTextbox1', array( 'readonly' ) );
641 $wgOut->addHTML( Html
::rawElement( 'div', array( 'class' => 'templatesUsed' ),
642 Linker
::formatTemplates( $this->getTemplates() ) ) );
644 $wgOut->addModules( 'mediawiki.action.edit.collapsibleFooter' );
646 if ( $this->mTitle
->exists() ) {
647 $wgOut->returnToMain( null, $this->mTitle
);
652 * Should we show a preview when the edit form is first shown?
656 protected function previewOnOpen() {
657 global $wgRequest, $wgUser, $wgPreviewOnOpenNamespaces;
658 if ( $wgRequest->getVal( 'preview' ) == 'yes' ) {
659 // Explicit override from request
661 } elseif ( $wgRequest->getVal( 'preview' ) == 'no' ) {
662 // Explicit override from request
664 } elseif ( $this->section
== 'new' ) {
665 // Nothing *to* preview for new sections
667 } elseif ( ( $wgRequest->getVal( 'preload' ) !== null ||
$this->mTitle
->exists() )
668 && $wgUser->getOption( 'previewonfirst' )
670 // Standard preference behavior
672 } elseif ( !$this->mTitle
->exists()
673 && isset( $wgPreviewOnOpenNamespaces[$this->mTitle
->getNamespace()] )
674 && $wgPreviewOnOpenNamespaces[$this->mTitle
->getNamespace()]
676 // Categories are special
684 * Checks whether the user entered a skin name in uppercase,
685 * e.g. "User:Example/Monobook.css" instead of "monobook.css"
689 protected function isWrongCaseCssJsPage() {
690 if ( $this->mTitle
->isCssJsSubpage() ) {
691 $name = $this->mTitle
->getSkinFromCssJsSubpage();
692 $skins = array_merge(
693 array_keys( Skin
::getSkinNames() ),
696 return !in_array( $name, $skins )
697 && in_array( strtolower( $name ), $skins );
704 * Returns whether section editing is supported for the current page.
705 * Subclasses may override this to replace the default behavior, which is
706 * to check ContentHandler::supportsSections.
708 * @return bool True if this edit page supports sections, false otherwise.
710 protected function isSectionEditSupported() {
711 $contentHandler = ContentHandler
::getForTitle( $this->mTitle
);
712 return $contentHandler->supportsSections();
716 * This function collects the form data and uses it to populate various member variables.
717 * @param WebRequest $request
718 * @throws ErrorPageError
720 function importFormData( &$request ) {
721 global $wgContLang, $wgUser;
723 wfProfileIn( __METHOD__
);
725 # Section edit can come from either the form or a link
726 $this->section
= $request->getVal( 'wpSection', $request->getVal( 'section' ) );
728 if ( $this->section
!== null && $this->section
!== '' && !$this->isSectionEditSupported() ) {
729 wfProfileOut( __METHOD__
);
730 throw new ErrorPageError( 'sectioneditnotsupported-title', 'sectioneditnotsupported-text' );
733 $this->isNew
= !$this->mTitle
->exists() ||
$this->section
== 'new';
735 if ( $request->wasPosted() ) {
736 # These fields need to be checked for encoding.
737 # Also remove trailing whitespace, but don't remove _initial_
738 # whitespace from the text boxes. This may be significant formatting.
739 $this->textbox1
= $this->safeUnicodeInput( $request, 'wpTextbox1' );
740 if ( !$request->getCheck( 'wpTextbox2' ) ) {
741 // Skip this if wpTextbox2 has input, it indicates that we came
742 // from a conflict page with raw page text, not a custom form
743 // modified by subclasses
744 wfProfileIn( get_class( $this ) . "::importContentFormData" );
745 $textbox1 = $this->importContentFormData( $request );
746 if ( $textbox1 !== null ) {
747 $this->textbox1
= $textbox1;
750 wfProfileOut( get_class( $this ) . "::importContentFormData" );
753 # Truncate for whole multibyte characters
754 $this->summary
= $wgContLang->truncate( $request->getText( 'wpSummary' ), 255 );
756 # If the summary consists of a heading, e.g. '==Foobar==', extract the title from the
757 # header syntax, e.g. 'Foobar'. This is mainly an issue when we are using wpSummary for
759 $this->summary
= preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->summary
);
761 # Treat sectiontitle the same way as summary.
762 # Note that wpSectionTitle is not yet a part of the actual edit form, as wpSummary is
763 # currently doing double duty as both edit summary and section title. Right now this
764 # is just to allow API edits to work around this limitation, but this should be
765 # incorporated into the actual edit form when EditPage is rewritten (Bugs 18654, 26312).
766 $this->sectiontitle
= $wgContLang->truncate( $request->getText( 'wpSectionTitle' ), 255 );
767 $this->sectiontitle
= preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->sectiontitle
);
769 $this->edittime
= $request->getVal( 'wpEdittime' );
770 $this->starttime
= $request->getVal( 'wpStarttime' );
772 $undidRev = $request->getInt( 'wpUndidRevision' );
774 $this->undidRev
= $undidRev;
777 $this->scrolltop
= $request->getIntOrNull( 'wpScrolltop' );
779 if ( $this->textbox1
=== '' && $request->getVal( 'wpTextbox1' ) === null ) {
780 // wpTextbox1 field is missing, possibly due to being "too big"
781 // according to some filter rules such as Suhosin's setting for
782 // suhosin.request.max_value_length (d'oh)
783 $this->incompleteForm
= true;
785 // If we receive the last parameter of the request, we can fairly
786 // claim the POST request has not been truncated.
788 // TODO: softened the check for cutover. Once we determine
789 // that it is safe, we should complete the transition by
790 // removing the "edittime" clause.
791 $this->incompleteForm
= ( !$request->getVal( 'wpUltimateParam' )
792 && is_null( $this->edittime
) );
794 if ( $this->incompleteForm
) {
795 # If the form is incomplete, force to preview.
796 wfDebug( __METHOD__
. ": Form data appears to be incomplete\n" );
797 wfDebug( "POST DATA: " . var_export( $_POST, true ) . "\n" );
798 $this->preview
= true;
800 /* Fallback for live preview */
801 $this->preview
= $request->getCheck( 'wpPreview' ) ||
$request->getCheck( 'wpLivePreview' );
802 $this->diff
= $request->getCheck( 'wpDiff' );
804 // Remember whether a save was requested, so we can indicate
805 // if we forced preview due to session failure.
806 $this->mTriedSave
= !$this->preview
;
808 if ( $this->tokenOk( $request ) ) {
809 # Some browsers will not report any submit button
810 # if the user hits enter in the comment box.
811 # The unmarked state will be assumed to be a save,
812 # if the form seems otherwise complete.
813 wfDebug( __METHOD__
. ": Passed token check.\n" );
814 } elseif ( $this->diff
) {
815 # Failed token check, but only requested "Show Changes".
816 wfDebug( __METHOD__
. ": Failed token check; Show Changes requested.\n" );
818 # Page might be a hack attempt posted from
819 # an external site. Preview instead of saving.
820 wfDebug( __METHOD__
. ": Failed token check; forcing preview\n" );
821 $this->preview
= true;
824 $this->save
= !$this->preview
&& !$this->diff
;
825 if ( !preg_match( '/^\d{14}$/', $this->edittime
) ) {
826 $this->edittime
= null;
829 if ( !preg_match( '/^\d{14}$/', $this->starttime
) ) {
830 $this->starttime
= null;
833 $this->recreate
= $request->getCheck( 'wpRecreate' );
835 $this->minoredit
= $request->getCheck( 'wpMinoredit' );
836 $this->watchthis
= $request->getCheck( 'wpWatchthis' );
838 # Don't force edit summaries when a user is editing their own user or talk page
839 if ( ( $this->mTitle
->mNamespace
== NS_USER ||
$this->mTitle
->mNamespace
== NS_USER_TALK
)
840 && $this->mTitle
->getText() == $wgUser->getName()
842 $this->allowBlankSummary
= true;
844 $this->allowBlankSummary
= $request->getBool( 'wpIgnoreBlankSummary' )
845 ||
!$wgUser->getOption( 'forceeditsummary' );
848 $this->autoSumm
= $request->getText( 'wpAutoSummary' );
850 $this->allowBlankArticle
= $request->getBool( 'wpIgnoreBlankArticle' );
852 # Not a posted form? Start with nothing.
853 wfDebug( __METHOD__
. ": Not a posted form.\n" );
854 $this->textbox1
= '';
856 $this->sectiontitle
= '';
857 $this->edittime
= '';
858 $this->starttime
= wfTimestampNow();
860 $this->preview
= false;
863 $this->minoredit
= false;
864 // Watch may be overridden by request parameters
865 $this->watchthis
= $request->getBool( 'watchthis', false );
866 $this->recreate
= false;
868 // When creating a new section, we can preload a section title by passing it as the
869 // preloadtitle parameter in the URL (Bug 13100)
870 if ( $this->section
== 'new' && $request->getVal( 'preloadtitle' ) ) {
871 $this->sectiontitle
= $request->getVal( 'preloadtitle' );
872 // Once wpSummary isn't being use for setting section titles, we should delete this.
873 $this->summary
= $request->getVal( 'preloadtitle' );
874 } elseif ( $this->section
!= 'new' && $request->getVal( 'summary' ) ) {
875 $this->summary
= $request->getText( 'summary' );
876 if ( $this->summary
!== '' ) {
877 $this->hasPresetSummary
= true;
881 if ( $request->getVal( 'minor' ) ) {
882 $this->minoredit
= true;
886 $this->oldid
= $request->getInt( 'oldid' );
887 $this->parentRevId
= $request->getInt( 'parentRevId' );
889 $this->bot
= $request->getBool( 'bot', true );
890 $this->nosummary
= $request->getBool( 'nosummary' );
892 // May be overridden by revision.
893 $this->contentModel
= $request->getText( 'model', $this->contentModel
);
894 // May be overridden by revision.
895 $this->contentFormat
= $request->getText( 'format', $this->contentFormat
);
897 if ( !ContentHandler
::getForModelID( $this->contentModel
)
898 ->isSupportedFormat( $this->contentFormat
)
900 throw new ErrorPageError(
901 'editpage-notsupportedcontentformat-title',
902 'editpage-notsupportedcontentformat-text',
903 array( $this->contentFormat
, ContentHandler
::getLocalizedName( $this->contentModel
) )
908 * @todo Check if the desired model is allowed in this namespace, and if
909 * a transition from the page's current model to the new model is
913 $this->live
= $request->getCheck( 'live' );
914 $this->editintro
= $request->getText( 'editintro',
915 // Custom edit intro for new sections
916 $this->section
=== 'new' ?
'MediaWiki:addsection-editintro' : '' );
918 // Allow extensions to modify form data
919 wfRunHooks( 'EditPage::importFormData', array( $this, $request ) );
921 wfProfileOut( __METHOD__
);
925 * Subpage overridable method for extracting the page content data from the
926 * posted form to be placed in $this->textbox1, if using customized input
927 * this method should be overridden and return the page text that will be used
928 * for saving, preview parsing and so on...
930 * @param WebRequest $request
932 protected function importContentFormData( &$request ) {
933 return; // Don't do anything, EditPage already extracted wpTextbox1
937 * Initialise form fields in the object
938 * Called on the first invocation, e.g. when a user clicks an edit link
939 * @return bool If the requested section is valid
941 function initialiseForm() {
943 $this->edittime
= $this->mArticle
->getTimestamp();
945 $content = $this->getContentObject( false ); #TODO: track content object?!
946 if ( $content === false ) {
949 $this->textbox1
= $this->toEditText( $content );
951 // activate checkboxes if user wants them to be always active
952 # Sort out the "watch" checkbox
953 if ( $wgUser->getOption( 'watchdefault' ) ) {
955 $this->watchthis
= true;
956 } elseif ( $wgUser->getOption( 'watchcreations' ) && !$this->mTitle
->exists() ) {
958 $this->watchthis
= true;
959 } elseif ( $wgUser->isWatched( $this->mTitle
) ) {
961 $this->watchthis
= true;
963 if ( $wgUser->getOption( 'minordefault' ) && !$this->isNew
) {
964 $this->minoredit
= true;
966 if ( $this->textbox1
=== false ) {
973 * @param Content|null $def_content The default value to return
975 * @return Content|null Content on success, $def_content for invalid sections
979 protected function getContentObject( $def_content = null ) {
980 global $wgOut, $wgRequest, $wgUser, $wgContLang;
982 wfProfileIn( __METHOD__
);
986 // For message page not locally set, use the i18n message.
987 // For other non-existent articles, use preload text if any.
988 if ( !$this->mTitle
->exists() ||
$this->section
== 'new' ) {
989 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
&& $this->section
!= 'new' ) {
990 # If this is a system message, get the default text.
991 $msg = $this->mTitle
->getDefaultMessageText();
993 $content = $this->toEditContent( $msg );
995 if ( $content === false ) {
996 # If requested, preload some text.
997 $preload = $wgRequest->getVal( 'preload',
998 // Custom preload text for new sections
999 $this->section
=== 'new' ?
'MediaWiki:addsection-preload' : '' );
1000 $params = $wgRequest->getArray( 'preloadparams', array() );
1002 $content = $this->getPreloadedContent( $preload, $params );
1004 // For existing pages, get text based on "undo" or section parameters.
1006 if ( $this->section
!= '' ) {
1007 // Get section edit text (returns $def_text for invalid sections)
1008 $orig = $this->getOriginalContent( $wgUser );
1009 $content = $orig ?
$orig->getSection( $this->section
) : null;
1012 $content = $def_content;
1015 $undoafter = $wgRequest->getInt( 'undoafter' );
1016 $undo = $wgRequest->getInt( 'undo' );
1018 if ( $undo > 0 && $undoafter > 0 ) {
1020 $undorev = Revision
::newFromId( $undo );
1021 $oldrev = Revision
::newFromId( $undoafter );
1023 # Sanity check, make sure it's the right page,
1024 # the revisions exist and they were not deleted.
1025 # Otherwise, $content will be left as-is.
1026 if ( !is_null( $undorev ) && !is_null( $oldrev ) &&
1027 !$undorev->isDeleted( Revision
::DELETED_TEXT
) &&
1028 !$oldrev->isDeleted( Revision
::DELETED_TEXT
) ) {
1030 $content = $this->mArticle
->getUndoContent( $undorev, $oldrev );
1032 if ( $content === false ) {
1033 # Warn the user that something went wrong
1034 $undoMsg = 'failure';
1036 $oldContent = $this->mArticle
->getPage()->getContent( Revision
::RAW
);
1037 $popts = ParserOptions
::newFromUserAndLang( $wgUser, $wgContLang );
1038 $newContent = $content->preSaveTransform( $this->mTitle
, $wgUser, $popts );
1040 if ( $newContent->equals( $oldContent ) ) {
1041 # Tell the user that the undo results in no change,
1042 # i.e. the revisions were already undone.
1043 $undoMsg = 'nochange';
1046 # Inform the user of our success and set an automatic edit summary
1047 $undoMsg = 'success';
1049 # If we just undid one rev, use an autosummary
1050 $firstrev = $oldrev->getNext();
1051 if ( $firstrev && $firstrev->getId() == $undo ) {
1052 $userText = $undorev->getUserText();
1053 if ( $userText === '' ) {
1054 $undoSummary = wfMessage(
1055 'undo-summary-username-hidden',
1057 )->inContentLanguage()->text();
1059 $undoSummary = wfMessage(
1063 )->inContentLanguage()->text();
1065 if ( $this->summary
=== '' ) {
1066 $this->summary
= $undoSummary;
1068 $this->summary
= $undoSummary . wfMessage( 'colon-separator' )
1069 ->inContentLanguage()->text() . $this->summary
;
1071 $this->undidRev
= $undo;
1073 $this->formtype
= 'diff';
1077 // Failed basic sanity checks.
1078 // Older revisions may have been removed since the link
1079 // was created, or we may simply have got bogus input.
1083 // Messages: undo-success, undo-failure, undo-norev, undo-nochange
1084 $class = ( $undoMsg == 'success' ?
'' : 'error ' ) . "mw-undo-{$undoMsg}";
1085 $this->editFormPageTop
.= $wgOut->parse( "<div class=\"{$class}\">" .
1086 wfMessage( 'undo-' . $undoMsg )->plain() . '</div>', true, /* interface */true );
1089 if ( $content === false ) {
1090 $content = $this->getOriginalContent( $wgUser );
1095 wfProfileOut( __METHOD__
);
1100 * Get the content of the wanted revision, without section extraction.
1102 * The result of this function can be used to compare user's input with
1103 * section replaced in its context (using WikiPage::replaceSection())
1104 * to the original text of the edit.
1106 * This differs from Article::getContent() that when a missing revision is
1107 * encountered the result will be null and not the
1108 * 'missing-revision' message.
1111 * @param User $user The user to get the revision for
1112 * @return Content|null
1114 private function getOriginalContent( User
$user ) {
1115 if ( $this->section
== 'new' ) {
1116 return $this->getCurrentContent();
1118 $revision = $this->mArticle
->getRevisionFetched();
1119 if ( $revision === null ) {
1120 if ( !$this->contentModel
) {
1121 $this->contentModel
= $this->getTitle()->getContentModel();
1123 $handler = ContentHandler
::getForModelID( $this->contentModel
);
1125 return $handler->makeEmptyContent();
1127 $content = $revision->getContent( Revision
::FOR_THIS_USER
, $user );
1132 * Get the current content of the page. This is basically similar to
1133 * WikiPage::getContent( Revision::RAW ) except that when the page doesn't exist an empty
1134 * content object is returned instead of null.
1139 protected function getCurrentContent() {
1140 $rev = $this->mArticle
->getRevision();
1141 $content = $rev ?
$rev->getContent( Revision
::RAW
) : null;
1143 if ( $content === false ||
$content === null ) {
1144 if ( !$this->contentModel
) {
1145 $this->contentModel
= $this->getTitle()->getContentModel();
1147 $handler = ContentHandler
::getForModelID( $this->contentModel
);
1149 return $handler->makeEmptyContent();
1151 # nasty side-effect, but needed for consistency
1152 $this->contentModel
= $rev->getContentModel();
1153 $this->contentFormat
= $rev->getContentFormat();
1160 * Use this method before edit() to preload some content into the edit box
1162 * @param Content $content
1166 public function setPreloadedContent( Content
$content ) {
1167 $this->mPreloadContent
= $content;
1171 * Get the contents to be preloaded into the box, either set by
1172 * an earlier setPreloadText() or by loading the given page.
1174 * @param string $preload Representing the title to preload from.
1175 * @param array $params Parameters to use (interface-message style) in the preloaded text
1181 protected function getPreloadedContent( $preload, $params = array() ) {
1184 if ( !empty( $this->mPreloadContent
) ) {
1185 return $this->mPreloadContent
;
1188 $handler = ContentHandler
::getForTitle( $this->getTitle() );
1190 if ( $preload === '' ) {
1191 return $handler->makeEmptyContent();
1194 $title = Title
::newFromText( $preload );
1195 # Check for existence to avoid getting MediaWiki:Noarticletext
1196 if ( $title === null ||
!$title->exists() ||
!$title->userCan( 'read', $wgUser ) ) {
1197 //TODO: somehow show a warning to the user!
1198 return $handler->makeEmptyContent();
1201 $page = WikiPage
::factory( $title );
1202 if ( $page->isRedirect() ) {
1203 $title = $page->getRedirectTarget();
1205 if ( $title === null ||
!$title->exists() ||
!$title->userCan( 'read', $wgUser ) ) {
1206 //TODO: somehow show a warning to the user!
1207 return $handler->makeEmptyContent();
1209 $page = WikiPage
::factory( $title );
1212 $parserOptions = ParserOptions
::newFromUser( $wgUser );
1213 $content = $page->getContent( Revision
::RAW
);
1216 //TODO: somehow show a warning to the user!
1217 return $handler->makeEmptyContent();
1220 if ( $content->getModel() !== $handler->getModelID() ) {
1221 $converted = $content->convert( $handler->getModelID() );
1223 if ( !$converted ) {
1224 //TODO: somehow show a warning to the user!
1225 wfDebug( "Attempt to preload incompatible content: "
1226 . "can't convert " . $content->getModel()
1227 . " to " . $handler->getModelID() );
1229 return $handler->makeEmptyContent();
1232 $content = $converted;
1235 return $content->preloadTransform( $title, $parserOptions, $params );
1239 * Make sure the form isn't faking a user's credentials.
1241 * @param WebRequest $request
1245 function tokenOk( &$request ) {
1247 $token = $request->getVal( 'wpEditToken' );
1248 $this->mTokenOk
= $wgUser->matchEditToken( $token );
1249 $this->mTokenOkExceptSuffix
= $wgUser->matchEditTokenNoSuffix( $token );
1250 return $this->mTokenOk
;
1254 * Sets post-edit cookie indicating the user just saved a particular revision.
1256 * This uses a temporary cookie for each revision ID so separate saves will never
1257 * interfere with each other.
1259 * The cookie is deleted in the mediawiki.action.view.postEdit JS module after
1260 * the redirect. It must be clearable by JavaScript code, so it must not be
1261 * marked HttpOnly. The JavaScript code converts the cookie to a wgPostEdit config
1264 * If the variable were set on the server, it would be cached, which is unwanted
1265 * since the post-edit state should only apply to the load right after the save.
1267 * @param int $statusValue The status value (to check for new article status)
1269 protected function setPostEditCookie( $statusValue ) {
1270 $revisionId = $this->mArticle
->getLatest();
1271 $postEditKey = self
::POST_EDIT_COOKIE_KEY_PREFIX
. $revisionId;
1274 if ( $statusValue == self
::AS_SUCCESS_NEW_ARTICLE
) {
1276 } elseif ( $this->oldid
) {
1280 $response = RequestContext
::getMain()->getRequest()->response();
1281 $response->setcookie( $postEditKey, $val, time() + self
::POST_EDIT_COOKIE_DURATION
, array(
1282 'httpOnly' => false,
1287 * Attempt submission
1288 * @throws UserBlockedError|ReadOnlyError|ThrottledError|PermissionsError
1289 * @return bool False if output is done, true if the rest of the form should be displayed
1291 public function attemptSave() {
1294 $resultDetails = false;
1295 # Allow bots to exempt some edits from bot flagging
1296 $bot = $wgUser->isAllowed( 'bot' ) && $this->bot
;
1297 $status = $this->internalAttemptSave( $resultDetails, $bot );
1299 return $this->handleStatus( $status, $resultDetails );
1303 * Handle status, such as after attempt save
1305 * @param Status $status
1306 * @param array|bool $resultDetails
1308 * @throws ErrorPageError
1309 * @return bool False, if output is done, true if rest of the form should be displayed
1311 private function handleStatus( Status
$status, $resultDetails ) {
1312 global $wgUser, $wgOut;
1315 * @todo FIXME: once the interface for internalAttemptSave() is made
1316 * nicer, this should use the message in $status
1318 if ( $status->value
== self
::AS_SUCCESS_UPDATE
1319 ||
$status->value
== self
::AS_SUCCESS_NEW_ARTICLE
1321 $this->didSave
= true;
1322 if ( !$resultDetails['nullEdit'] ) {
1323 $this->setPostEditCookie( $status->value
);
1327 switch ( $status->value
) {
1328 case self
::AS_HOOK_ERROR_EXPECTED
:
1329 case self
::AS_CONTENT_TOO_BIG
:
1330 case self
::AS_ARTICLE_WAS_DELETED
:
1331 case self
::AS_CONFLICT_DETECTED
:
1332 case self
::AS_SUMMARY_NEEDED
:
1333 case self
::AS_TEXTBOX_EMPTY
:
1334 case self
::AS_MAX_ARTICLE_SIZE_EXCEEDED
:
1336 case self
::AS_BLANK_ARTICLE
:
1339 case self
::AS_HOOK_ERROR
:
1342 case self
::AS_PARSE_ERROR
:
1343 $wgOut->addWikiText( '<div class="error">' . $status->getWikiText() . '</div>' );
1346 case self
::AS_SUCCESS_NEW_ARTICLE
:
1347 $query = $resultDetails['redirect'] ?
'redirect=no' : '';
1348 $anchor = isset( $resultDetails['sectionanchor'] ) ?
$resultDetails['sectionanchor'] : '';
1349 $wgOut->redirect( $this->mTitle
->getFullURL( $query ) . $anchor );
1352 case self
::AS_SUCCESS_UPDATE
:
1354 $sectionanchor = $resultDetails['sectionanchor'];
1356 // Give extensions a chance to modify URL query on update
1358 'ArticleUpdateBeforeRedirect',
1359 array( $this->mArticle
, &$sectionanchor, &$extraQuery )
1362 if ( $resultDetails['redirect'] ) {
1363 if ( $extraQuery == '' ) {
1364 $extraQuery = 'redirect=no';
1366 $extraQuery = 'redirect=no&' . $extraQuery;
1369 $wgOut->redirect( $this->mTitle
->getFullURL( $extraQuery ) . $sectionanchor );
1372 case self
::AS_SPAM_ERROR
:
1373 $this->spamPageWithContent( $resultDetails['spam'] );
1376 case self
::AS_BLOCKED_PAGE_FOR_USER
:
1377 throw new UserBlockedError( $wgUser->getBlock() );
1379 case self
::AS_IMAGE_REDIRECT_ANON
:
1380 case self
::AS_IMAGE_REDIRECT_LOGGED
:
1381 throw new PermissionsError( 'upload' );
1383 case self
::AS_READ_ONLY_PAGE_ANON
:
1384 case self
::AS_READ_ONLY_PAGE_LOGGED
:
1385 throw new PermissionsError( 'edit' );
1387 case self
::AS_READ_ONLY_PAGE
:
1388 throw new ReadOnlyError
;
1390 case self
::AS_RATE_LIMITED
:
1391 throw new ThrottledError();
1393 case self
::AS_NO_CREATE_PERMISSION
:
1394 $permission = $this->mTitle
->isTalkPage() ?
'createtalk' : 'createpage';
1395 throw new PermissionsError( $permission );
1397 case self
::AS_NO_CHANGE_CONTENT_MODEL
:
1398 throw new PermissionsError( 'editcontentmodel' );
1401 // We don't recognize $status->value. The only way that can happen
1402 // is if an extension hook aborted from inside ArticleSave.
1403 // Render the status object into $this->hookError
1404 // FIXME this sucks, we should just use the Status object throughout
1405 $this->hookError
= '<div class="error">' . $status->getWikitext() .
1412 * Run hooks that can filter edits just before they get saved.
1414 * @param Content $content The Content to filter.
1415 * @param Status $status For reporting the outcome to the caller
1416 * @param User $user The user performing the edit
1420 protected function runPostMergeFilters( Content
$content, Status
$status, User
$user ) {
1421 // Run old style post-section-merge edit filter
1422 if ( !ContentHandler
::runLegacyHooks( 'EditFilterMerged',
1423 array( $this, $content, &$this->hookError
, $this->summary
) ) ) {
1425 # Error messages etc. could be handled within the hook...
1426 $status->fatal( 'hookaborted' );
1427 $status->value
= self
::AS_HOOK_ERROR
;
1429 } elseif ( $this->hookError
!= '' ) {
1430 # ...or the hook could be expecting us to produce an error
1431 $status->fatal( 'hookaborted' );
1432 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1436 // Run new style post-section-merge edit filter
1437 if ( !wfRunHooks( 'EditFilterMergedContent',
1438 array( $this->mArticle
->getContext(), $content, $status, $this->summary
,
1439 $user, $this->minoredit
) ) ) {
1441 # Error messages etc. could be handled within the hook...
1442 // XXX: $status->value may already be something informative...
1443 $this->hookError
= $status->getWikiText();
1444 $status->fatal( 'hookaborted' );
1445 $status->value
= self
::AS_HOOK_ERROR
;
1447 } elseif ( !$status->isOK() ) {
1448 # ...or the hook could be expecting us to produce an error
1449 // FIXME this sucks, we should just use the Status object throughout
1450 $this->hookError
= $status->getWikiText();
1451 $status->fatal( 'hookaborted' );
1452 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1460 * Return the summary to be used for a new section.
1462 * @param string $sectionanchor Set to the section anchor text
1465 private function newSectionSummary( &$sectionanchor = null ) {
1468 if ( $this->sectiontitle
!== '' ) {
1469 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $this->sectiontitle
);
1470 // If no edit summary was specified, create one automatically from the section
1471 // title and have it link to the new section. Otherwise, respect the summary as
1473 if ( $this->summary
=== '' ) {
1474 $cleanSectionTitle = $wgParser->stripSectionName( $this->sectiontitle
);
1475 return wfMessage( 'newsectionsummary' )
1476 ->rawParams( $cleanSectionTitle )->inContentLanguage()->text();
1478 } elseif ( $this->summary
!== '' ) {
1479 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $this->summary
);
1480 # This is a new section, so create a link to the new section
1481 # in the revision summary.
1482 $cleanSummary = $wgParser->stripSectionName( $this->summary
);
1483 return wfMessage( 'newsectionsummary' )
1484 ->rawParams( $cleanSummary )->inContentLanguage()->text();
1486 return $this->summary
;
1490 * Attempt submission (no UI)
1492 * @param array $result Array to add statuses to, currently with the
1494 * - spam (string): Spam string from content if any spam is detected by
1496 * - sectionanchor (string): Section anchor for a section save.
1497 * - nullEdit (boolean): Set if doEditContent is OK. True if null edit,
1499 * - redirect (bool): Set if doEditContent is OK. True if resulting
1500 * revision is a redirect.
1501 * @param bool $bot True if edit is being made under the bot right.
1503 * @return Status Status object, possibly with a message, but always with
1504 * one of the AS_* constants in $status->value,
1506 * @todo FIXME: This interface is TERRIBLE, but hard to get rid of due to
1507 * various error display idiosyncrasies. There are also lots of cases
1508 * where error metadata is set in the object and retrieved later instead
1509 * of being returned, e.g. AS_CONTENT_TOO_BIG and
1510 * AS_BLOCKED_PAGE_FOR_USER. All that stuff needs to be cleaned up some
1513 function internalAttemptSave( &$result, $bot = false ) {
1514 global $wgUser, $wgRequest, $wgParser, $wgMaxArticleSize;
1516 $status = Status
::newGood();
1518 wfProfileIn( __METHOD__
);
1519 wfProfileIn( __METHOD__
. '-checks' );
1521 if ( !wfRunHooks( 'EditPage::attemptSave', array( $this ) ) ) {
1522 wfDebug( "Hook 'EditPage::attemptSave' aborted article saving\n" );
1523 $status->fatal( 'hookaborted' );
1524 $status->value
= self
::AS_HOOK_ERROR
;
1525 wfProfileOut( __METHOD__
. '-checks' );
1526 wfProfileOut( __METHOD__
);
1530 $spam = $wgRequest->getText( 'wpAntispam' );
1531 if ( $spam !== '' ) {
1534 $wgUser->getName() .
1536 $this->mTitle
->getPrefixedText() .
1537 '" submitted bogus field "' .
1541 $status->fatal( 'spamprotectionmatch', false );
1542 $status->value
= self
::AS_SPAM_ERROR
;
1543 wfProfileOut( __METHOD__
. '-checks' );
1544 wfProfileOut( __METHOD__
);
1549 # Construct Content object
1550 $textbox_content = $this->toEditContent( $this->textbox1
);
1551 } catch ( MWContentSerializationException
$ex ) {
1553 'content-failed-to-parse',
1554 $this->contentModel
,
1555 $this->contentFormat
,
1558 $status->value
= self
::AS_PARSE_ERROR
;
1559 wfProfileOut( __METHOD__
. '-checks' );
1560 wfProfileOut( __METHOD__
);
1564 # Check image redirect
1565 if ( $this->mTitle
->getNamespace() == NS_FILE
&&
1566 $textbox_content->isRedirect() &&
1567 !$wgUser->isAllowed( 'upload' )
1569 $code = $wgUser->isAnon() ? self
::AS_IMAGE_REDIRECT_ANON
: self
::AS_IMAGE_REDIRECT_LOGGED
;
1570 $status->setResult( false, $code );
1572 wfProfileOut( __METHOD__
. '-checks' );
1573 wfProfileOut( __METHOD__
);
1579 $match = self
::matchSummarySpamRegex( $this->summary
);
1580 if ( $match === false && $this->section
== 'new' ) {
1581 # $wgSpamRegex is enforced on this new heading/summary because, unlike
1582 # regular summaries, it is added to the actual wikitext.
1583 if ( $this->sectiontitle
!== '' ) {
1584 # This branch is taken when the API is used with the 'sectiontitle' parameter.
1585 $match = self
::matchSpamRegex( $this->sectiontitle
);
1587 # This branch is taken when the "Add Topic" user interface is used, or the API
1588 # is used with the 'summary' parameter.
1589 $match = self
::matchSpamRegex( $this->summary
);
1592 if ( $match === false ) {
1593 $match = self
::matchSpamRegex( $this->textbox1
);
1595 if ( $match !== false ) {
1596 $result['spam'] = $match;
1597 $ip = $wgRequest->getIP();
1598 $pdbk = $this->mTitle
->getPrefixedDBkey();
1599 $match = str_replace( "\n", '', $match );
1600 wfDebugLog( 'SpamRegex', "$ip spam regex hit [[$pdbk]]: \"$match\"" );
1601 $status->fatal( 'spamprotectionmatch', $match );
1602 $status->value
= self
::AS_SPAM_ERROR
;
1603 wfProfileOut( __METHOD__
. '-checks' );
1604 wfProfileOut( __METHOD__
);
1609 array( $this, $this->textbox1
, $this->section
, &$this->hookError
, $this->summary
) )
1611 # Error messages etc. could be handled within the hook...
1612 $status->fatal( 'hookaborted' );
1613 $status->value
= self
::AS_HOOK_ERROR
;
1614 wfProfileOut( __METHOD__
. '-checks' );
1615 wfProfileOut( __METHOD__
);
1617 } elseif ( $this->hookError
!= '' ) {
1618 # ...or the hook could be expecting us to produce an error
1619 $status->fatal( 'hookaborted' );
1620 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1621 wfProfileOut( __METHOD__
. '-checks' );
1622 wfProfileOut( __METHOD__
);
1626 if ( $wgUser->isBlockedFrom( $this->mTitle
, false ) ) {
1627 // Auto-block user's IP if the account was "hard" blocked
1628 $wgUser->spreadAnyEditBlock();
1629 # Check block state against master, thus 'false'.
1630 $status->setResult( false, self
::AS_BLOCKED_PAGE_FOR_USER
);
1631 wfProfileOut( __METHOD__
. '-checks' );
1632 wfProfileOut( __METHOD__
);
1636 $this->kblength
= (int)( strlen( $this->textbox1
) / 1024 );
1637 if ( $this->kblength
> $wgMaxArticleSize ) {
1638 // Error will be displayed by showEditForm()
1639 $this->tooBig
= true;
1640 $status->setResult( false, self
::AS_CONTENT_TOO_BIG
);
1641 wfProfileOut( __METHOD__
. '-checks' );
1642 wfProfileOut( __METHOD__
);
1646 if ( !$wgUser->isAllowed( 'edit' ) ) {
1647 if ( $wgUser->isAnon() ) {
1648 $status->setResult( false, self
::AS_READ_ONLY_PAGE_ANON
);
1649 wfProfileOut( __METHOD__
. '-checks' );
1650 wfProfileOut( __METHOD__
);
1653 $status->fatal( 'readonlytext' );
1654 $status->value
= self
::AS_READ_ONLY_PAGE_LOGGED
;
1655 wfProfileOut( __METHOD__
. '-checks' );
1656 wfProfileOut( __METHOD__
);
1661 if ( $this->contentModel
!== $this->mTitle
->getContentModel()
1662 && !$wgUser->isAllowed( 'editcontentmodel' )
1664 $status->setResult( false, self
::AS_NO_CHANGE_CONTENT_MODEL
);
1665 wfProfileOut( __METHOD__
. '-checks' );
1666 wfProfileOut( __METHOD__
);
1670 if ( wfReadOnly() ) {
1671 $status->fatal( 'readonlytext' );
1672 $status->value
= self
::AS_READ_ONLY_PAGE
;
1673 wfProfileOut( __METHOD__
. '-checks' );
1674 wfProfileOut( __METHOD__
);
1677 if ( $wgUser->pingLimiter() ||
$wgUser->pingLimiter( 'linkpurge', 0 ) ) {
1678 $status->fatal( 'actionthrottledtext' );
1679 $status->value
= self
::AS_RATE_LIMITED
;
1680 wfProfileOut( __METHOD__
. '-checks' );
1681 wfProfileOut( __METHOD__
);
1685 # If the article has been deleted while editing, don't save it without
1687 if ( $this->wasDeletedSinceLastEdit() && !$this->recreate
) {
1688 $status->setResult( false, self
::AS_ARTICLE_WAS_DELETED
);
1689 wfProfileOut( __METHOD__
. '-checks' );
1690 wfProfileOut( __METHOD__
);
1694 wfProfileOut( __METHOD__
. '-checks' );
1696 # Load the page data from the master. If anything changes in the meantime,
1697 # we detect it by using page_latest like a token in a 1 try compare-and-swap.
1698 $this->mArticle
->loadPageData( 'fromdbmaster' );
1699 $new = !$this->mArticle
->exists();
1702 // Late check for create permission, just in case *PARANOIA*
1703 if ( !$this->mTitle
->userCan( 'create', $wgUser ) ) {
1704 $status->fatal( 'nocreatetext' );
1705 $status->value
= self
::AS_NO_CREATE_PERMISSION
;
1706 wfDebug( __METHOD__
. ": no create permission\n" );
1707 wfProfileOut( __METHOD__
);
1711 // Don't save a new page if it's blank or if it's a MediaWiki:
1712 // message with content equivalent to default (allow empty pages
1713 // in this case to disable messages, see bug 50124)
1714 $defaultMessageText = $this->mTitle
->getDefaultMessageText();
1715 if ( $this->mTitle
->getNamespace() === NS_MEDIAWIKI
&& $defaultMessageText !== false ) {
1716 $defaultText = $defaultMessageText;
1721 if ( !$this->allowBlankArticle
&& $this->textbox1
=== $defaultText ) {
1722 $this->blankArticle
= true;
1723 $status->fatal( 'blankarticle' );
1724 $status->setResult( false, self
::AS_BLANK_ARTICLE
);
1725 wfProfileOut( __METHOD__
);
1729 if ( !$this->runPostMergeFilters( $textbox_content, $status, $wgUser ) ) {
1730 wfProfileOut( __METHOD__
);
1734 $content = $textbox_content;
1736 $result['sectionanchor'] = '';
1737 if ( $this->section
== 'new' ) {
1738 if ( $this->sectiontitle
!== '' ) {
1739 // Insert the section title above the content.
1740 $content = $content->addSectionHeader( $this->sectiontitle
);
1741 } elseif ( $this->summary
!== '' ) {
1742 // Insert the section title above the content.
1743 $content = $content->addSectionHeader( $this->summary
);
1745 $this->summary
= $this->newSectionSummary( $result['sectionanchor'] );
1748 $status->value
= self
::AS_SUCCESS_NEW_ARTICLE
;
1752 # Article exists. Check for edit conflict.
1754 $this->mArticle
->clear(); # Force reload of dates, etc.
1755 $timestamp = $this->mArticle
->getTimestamp();
1757 wfDebug( "timestamp: {$timestamp}, edittime: {$this->edittime}\n" );
1759 if ( $timestamp != $this->edittime
) {
1760 $this->isConflict
= true;
1761 if ( $this->section
== 'new' ) {
1762 if ( $this->mArticle
->getUserText() == $wgUser->getName() &&
1763 $this->mArticle
->getComment() == $this->newSectionSummary()
1765 // Probably a duplicate submission of a new comment.
1766 // This can happen when squid resends a request after
1767 // a timeout but the first one actually went through.
1769 . ": duplicate new section submission; trigger edit conflict!\n" );
1771 // New comment; suppress conflict.
1772 $this->isConflict
= false;
1773 wfDebug( __METHOD__
. ": conflict suppressed; new section\n" );
1775 } elseif ( $this->section
== ''
1776 && Revision
::userWasLastToEdit(
1777 DB_MASTER
, $this->mTitle
->getArticleID(),
1778 $wgUser->getId(), $this->edittime
1781 # Suppress edit conflict with self, except for section edits where merging is required.
1782 wfDebug( __METHOD__
. ": Suppressing edit conflict, same user.\n" );
1783 $this->isConflict
= false;
1787 // If sectiontitle is set, use it, otherwise use the summary as the section title.
1788 if ( $this->sectiontitle
!== '' ) {
1789 $sectionTitle = $this->sectiontitle
;
1791 $sectionTitle = $this->summary
;
1796 if ( $this->isConflict
) {
1798 . ": conflict! getting section '{$this->section}' for time '{$this->edittime}'"
1799 . " (article time '{$timestamp}')\n" );
1801 $content = $this->mArticle
->replaceSectionContent(
1808 wfDebug( __METHOD__
. ": getting section '{$this->section}'\n" );
1809 $content = $this->mArticle
->replaceSectionContent(
1816 if ( is_null( $content ) ) {
1817 wfDebug( __METHOD__
. ": activating conflict; section replace failed.\n" );
1818 $this->isConflict
= true;
1819 $content = $textbox_content; // do not try to merge here!
1820 } elseif ( $this->isConflict
) {
1822 if ( $this->mergeChangesIntoContent( $content ) ) {
1823 // Successful merge! Maybe we should tell the user the good news?
1824 $this->isConflict
= false;
1825 wfDebug( __METHOD__
. ": Suppressing edit conflict, successful merge.\n" );
1827 $this->section
= '';
1828 $this->textbox1
= ContentHandler
::getContentText( $content );
1829 wfDebug( __METHOD__
. ": Keeping edit conflict, failed merge.\n" );
1833 if ( $this->isConflict
) {
1834 $status->setResult( false, self
::AS_CONFLICT_DETECTED
);
1835 wfProfileOut( __METHOD__
);
1839 if ( !$this->runPostMergeFilters( $content, $status, $wgUser ) ) {
1840 wfProfileOut( __METHOD__
);
1844 if ( $this->section
== 'new' ) {
1845 // Handle the user preference to force summaries here
1846 if ( !$this->allowBlankSummary
&& trim( $this->summary
) == '' ) {
1847 $this->missingSummary
= true;
1848 $status->fatal( 'missingsummary' ); // or 'missingcommentheader' if $section == 'new'. Blegh
1849 $status->value
= self
::AS_SUMMARY_NEEDED
;
1850 wfProfileOut( __METHOD__
);
1854 // Do not allow the user to post an empty comment
1855 if ( $this->textbox1
== '' ) {
1856 $this->missingComment
= true;
1857 $status->fatal( 'missingcommenttext' );
1858 $status->value
= self
::AS_TEXTBOX_EMPTY
;
1859 wfProfileOut( __METHOD__
);
1862 } elseif ( !$this->allowBlankSummary
1863 && !$content->equals( $this->getOriginalContent( $wgUser ) )
1864 && !$content->isRedirect()
1865 && md5( $this->summary
) == $this->autoSumm
1867 $this->missingSummary
= true;
1868 $status->fatal( 'missingsummary' );
1869 $status->value
= self
::AS_SUMMARY_NEEDED
;
1870 wfProfileOut( __METHOD__
);
1875 wfProfileIn( __METHOD__
. '-sectionanchor' );
1876 $sectionanchor = '';
1877 if ( $this->section
== 'new' ) {
1878 $this->summary
= $this->newSectionSummary( $sectionanchor );
1879 } elseif ( $this->section
!= '' ) {
1880 # Try to get a section anchor from the section source, redirect
1881 # to edited section if header found.
1882 # XXX: Might be better to integrate this into Article::replaceSection
1883 # for duplicate heading checking and maybe parsing.
1884 $hasmatch = preg_match( "/^ *([=]{1,6})(.*?)(\\1) *\\n/i", $this->textbox1
, $matches );
1885 # We can't deal with anchors, includes, html etc in the header for now,
1886 # headline would need to be parsed to improve this.
1887 if ( $hasmatch && strlen( $matches[2] ) > 0 ) {
1888 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $matches[2] );
1891 $result['sectionanchor'] = $sectionanchor;
1892 wfProfileOut( __METHOD__
. '-sectionanchor' );
1894 // Save errors may fall down to the edit form, but we've now
1895 // merged the section into full text. Clear the section field
1896 // so that later submission of conflict forms won't try to
1897 // replace that into a duplicated mess.
1898 $this->textbox1
= $this->toEditText( $content );
1899 $this->section
= '';
1901 $status->value
= self
::AS_SUCCESS_UPDATE
;
1904 // Check for length errors again now that the section is merged in
1905 $this->kblength
= (int)( strlen( $this->toEditText( $content ) ) / 1024 );
1906 if ( $this->kblength
> $wgMaxArticleSize ) {
1907 $this->tooBig
= true;
1908 $status->setResult( false, self
::AS_MAX_ARTICLE_SIZE_EXCEEDED
);
1909 wfProfileOut( __METHOD__
);
1913 $flags = EDIT_DEFER_UPDATES | EDIT_AUTOSUMMARY |
1914 ( $new ? EDIT_NEW
: EDIT_UPDATE
) |
1915 ( ( $this->minoredit
&& !$this->isNew
) ? EDIT_MINOR
: 0 ) |
1916 ( $bot ? EDIT_FORCE_BOT
: 0 );
1918 $doEditStatus = $this->mArticle
->doEditContent(
1924 $content->getDefaultFormat()
1927 if ( !$doEditStatus->isOK() ) {
1928 // Failure from doEdit()
1929 // Show the edit conflict page for certain recognized errors from doEdit(),
1930 // but don't show it for errors from extension hooks
1931 $errors = $doEditStatus->getErrorsArray();
1932 if ( in_array( $errors[0][0],
1933 array( 'edit-gone-missing', 'edit-conflict', 'edit-already-exists' ) )
1935 $this->isConflict
= true;
1936 // Destroys data doEdit() put in $status->value but who cares
1937 $doEditStatus->value
= self
::AS_END
;
1939 wfProfileOut( __METHOD__
);
1940 return $doEditStatus;
1943 $result['nullEdit'] = $doEditStatus->hasMessage( 'edit-no-change' );
1944 if ( $result['nullEdit'] ) {
1945 // We don't know if it was a null edit until now, so increment here
1946 $wgUser->pingLimiter( 'linkpurge' );
1948 $result['redirect'] = $content->isRedirect();
1949 $this->updateWatchlist();
1950 wfProfileOut( __METHOD__
);
1955 * Register the change of watch status
1957 protected function updateWatchlist() {
1960 if ( $wgUser->isLoggedIn()
1961 && $this->watchthis
!= $wgUser->isWatched( $this->mTitle
, WatchedItem
::IGNORE_USER_RIGHTS
)
1963 $fname = __METHOD__
;
1964 $title = $this->mTitle
;
1965 $watch = $this->watchthis
;
1967 // Do this in its own transaction to reduce contention...
1968 $dbw = wfGetDB( DB_MASTER
);
1969 $dbw->onTransactionIdle( function () use ( $dbw, $title, $watch, $wgUser, $fname ) {
1970 WatchAction
::doWatchOrUnwatch( $watch, $title, $wgUser );
1976 * Attempts to do 3-way merge of edit content with a base revision
1977 * and current content, in case of edit conflict, in whichever way appropriate
1978 * for the content type.
1982 * @param Content $editContent
1986 private function mergeChangesIntoContent( &$editContent ) {
1987 wfProfileIn( __METHOD__
);
1989 $db = wfGetDB( DB_MASTER
);
1991 // This is the revision the editor started from
1992 $baseRevision = $this->getBaseRevision();
1993 $baseContent = $baseRevision ?
$baseRevision->getContent() : null;
1995 if ( is_null( $baseContent ) ) {
1996 wfProfileOut( __METHOD__
);
2000 // The current state, we want to merge updates into it
2001 $currentRevision = Revision
::loadFromTitle( $db, $this->mTitle
);
2002 $currentContent = $currentRevision ?
$currentRevision->getContent() : null;
2004 if ( is_null( $currentContent ) ) {
2005 wfProfileOut( __METHOD__
);
2009 $handler = ContentHandler
::getForModelID( $baseContent->getModel() );
2011 $result = $handler->merge3( $baseContent, $editContent, $currentContent );
2014 $editContent = $result;
2015 wfProfileOut( __METHOD__
);
2019 wfProfileOut( __METHOD__
);
2026 function getBaseRevision() {
2027 if ( !$this->mBaseRevision
) {
2028 $db = wfGetDB( DB_MASTER
);
2029 $this->mBaseRevision
= Revision
::loadFromTimestamp(
2030 $db, $this->mTitle
, $this->edittime
);
2032 return $this->mBaseRevision
;
2036 * Check given input text against $wgSpamRegex, and return the text of the first match.
2038 * @param string $text
2040 * @return string|bool Matching string or false
2042 public static function matchSpamRegex( $text ) {
2043 global $wgSpamRegex;
2044 // For back compatibility, $wgSpamRegex may be a single string or an array of regexes.
2045 $regexes = (array)$wgSpamRegex;
2046 return self
::matchSpamRegexInternal( $text, $regexes );
2050 * Check given input text against $wgSummarySpamRegex, and return the text of the first match.
2052 * @param string $text
2054 * @return string|bool Matching string or false
2056 public static function matchSummarySpamRegex( $text ) {
2057 global $wgSummarySpamRegex;
2058 $regexes = (array)$wgSummarySpamRegex;
2059 return self
::matchSpamRegexInternal( $text, $regexes );
2063 * @param string $text
2064 * @param array $regexes
2065 * @return bool|string
2067 protected static function matchSpamRegexInternal( $text, $regexes ) {
2068 foreach ( $regexes as $regex ) {
2070 if ( preg_match( $regex, $text, $matches ) ) {
2077 function setHeaders() {
2078 global $wgOut, $wgUser, $wgAjaxEditStash;
2080 $wgOut->addModules( 'mediawiki.action.edit' );
2081 $wgOut->addModuleStyles( 'mediawiki.action.edit.styles' );
2083 if ( $wgUser->getOption( 'uselivepreview', false ) ) {
2084 $wgOut->addModules( 'mediawiki.action.edit.preview' );
2087 if ( $wgUser->getOption( 'useeditwarning', false ) ) {
2088 $wgOut->addModules( 'mediawiki.action.edit.editWarning' );
2091 if ( $wgAjaxEditStash ) {
2092 $wgOut->addModules( 'mediawiki.action.edit.stash' );
2095 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2097 # Enabled article-related sidebar, toplinks, etc.
2098 $wgOut->setArticleRelated( true );
2100 $contextTitle = $this->getContextTitle();
2101 if ( $this->isConflict
) {
2102 $msg = 'editconflict';
2103 } elseif ( $contextTitle->exists() && $this->section
!= '' ) {
2104 $msg = $this->section
== 'new' ?
'editingcomment' : 'editingsection';
2106 $msg = $contextTitle->exists()
2107 ||
( $contextTitle->getNamespace() == NS_MEDIAWIKI
2108 && $contextTitle->getDefaultMessageText() !== false
2114 # Use the title defined by DISPLAYTITLE magic word when present
2115 $displayTitle = isset( $this->mParserOutput
) ?
$this->mParserOutput
->getDisplayTitle() : false;
2116 if ( $displayTitle === false ) {
2117 $displayTitle = $contextTitle->getPrefixedText();
2119 $wgOut->setPageTitle( wfMessage( $msg, $displayTitle ) );
2123 * Show all applicable editing introductions
2125 protected function showIntro() {
2126 global $wgOut, $wgUser;
2127 if ( $this->suppressIntro
) {
2131 $namespace = $this->mTitle
->getNamespace();
2133 if ( $namespace == NS_MEDIAWIKI
) {
2134 # Show a warning if editing an interface message
2135 $wgOut->wrapWikiMsg( "<div class='mw-editinginterface'>\n$1\n</div>", 'editinginterface' );
2136 # If this is a default message (but not css or js),
2137 # show a hint that it is translatable on translatewiki.net
2138 if ( !$this->mTitle
->hasContentModel( CONTENT_MODEL_CSS
)
2139 && !$this->mTitle
->hasContentModel( CONTENT_MODEL_JAVASCRIPT
)
2141 $defaultMessageText = $this->mTitle
->getDefaultMessageText();
2142 if ( $defaultMessageText !== false ) {
2143 $wgOut->wrapWikiMsg( "<div class='mw-translateinterface'>\n$1\n</div>",
2144 'translateinterface' );
2147 } elseif ( $namespace == NS_FILE
) {
2148 # Show a hint to shared repo
2149 $file = wfFindFile( $this->mTitle
);
2150 if ( $file && !$file->isLocal() ) {
2151 $descUrl = $file->getDescriptionUrl();
2152 # there must be a description url to show a hint to shared repo
2154 if ( !$this->mTitle
->exists() ) {
2155 $wgOut->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-create\">\n$1\n</div>", array(
2156 'sharedupload-desc-create', $file->getRepo()->getDisplayName(), $descUrl
2159 $wgOut->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-edit\">\n$1\n</div>", array(
2160 'sharedupload-desc-edit', $file->getRepo()->getDisplayName(), $descUrl
2167 # Show a warning message when someone creates/edits a user (talk) page but the user does not exist
2168 # Show log extract when the user is currently blocked
2169 if ( $namespace == NS_USER ||
$namespace == NS_USER_TALK
) {
2170 $parts = explode( '/', $this->mTitle
->getText(), 2 );
2171 $username = $parts[0];
2172 $user = User
::newFromName( $username, false /* allow IP users*/ );
2173 $ip = User
::isIP( $username );
2174 $block = Block
::newFromTarget( $user, $user );
2175 if ( !( $user && $user->isLoggedIn() ) && !$ip ) { # User does not exist
2176 $wgOut->wrapWikiMsg( "<div class=\"mw-userpage-userdoesnotexist error\">\n$1\n</div>",
2177 array( 'userpage-userdoesnotexist', wfEscapeWikiText( $username ) ) );
2178 } elseif ( !is_null( $block ) && $block->getType() != Block
::TYPE_AUTO
) {
2179 # Show log extract if the user is currently blocked
2180 LogEventsList
::showLogExtract(
2183 MWNamespace
::getCanonicalName( NS_USER
) . ':' . $block->getTarget(),
2187 'showIfEmpty' => false,
2189 'blocked-notice-logextract',
2190 $user->getName() # Support GENDER in notice
2196 # Try to add a custom edit intro, or use the standard one if this is not possible.
2197 if ( !$this->showCustomIntro() && !$this->mTitle
->exists() ) {
2198 $helpLink = wfExpandUrl( Skin
::makeInternalOrExternalUrl(
2199 wfMessage( 'helppage' )->inContentLanguage()->text()
2201 if ( $wgUser->isLoggedIn() ) {
2202 $wgOut->wrapWikiMsg(
2203 // Suppress the external link icon, consider the help url an internal one
2204 "<div class=\"mw-newarticletext plainlinks\">\n$1\n</div>",
2211 $wgOut->wrapWikiMsg(
2212 // Suppress the external link icon, consider the help url an internal one
2213 "<div class=\"mw-newarticletextanon plainlinks\">\n$1\n</div>",
2215 'newarticletextanon',
2221 # Give a notice if the user is editing a deleted/moved page...
2222 if ( !$this->mTitle
->exists() ) {
2223 LogEventsList
::showLogExtract( $wgOut, array( 'delete', 'move' ), $this->mTitle
,
2227 'conds' => array( "log_action != 'revision'" ),
2228 'showIfEmpty' => false,
2229 'msgKey' => array( 'recreate-moveddeleted-warn' )
2236 * Attempt to show a custom editing introduction, if supplied
2240 protected function showCustomIntro() {
2241 if ( $this->editintro
) {
2242 $title = Title
::newFromText( $this->editintro
);
2243 if ( $title instanceof Title
&& $title->exists() && $title->userCan( 'read' ) ) {
2245 // Added using template syntax, to take <noinclude>'s into account.
2246 $wgOut->addWikiTextTitleTidy(
2247 '<div class="mw-editintro">{{:' . $title->getFullText() . '}}</div>',
2257 * Gets an editable textual representation of $content.
2258 * The textual representation can be turned by into a Content object by the
2259 * toEditContent() method.
2261 * If $content is null or false or a string, $content is returned unchanged.
2263 * If the given Content object is not of a type that can be edited using
2264 * the text base EditPage, an exception will be raised. Set
2265 * $this->allowNonTextContent to true to allow editing of non-textual
2268 * @param Content|null|bool|string $content
2269 * @return string The editable text form of the content.
2271 * @throws MWException If $content is not an instance of TextContent and
2272 * $this->allowNonTextContent is not true.
2274 protected function toEditText( $content ) {
2275 if ( $content === null ||
$content === false ||
is_string( $content ) ) {
2279 if ( !$this->isSupportedContentModel( $content->getModel() ) ) {
2280 throw new MWException( 'This content model is not supported: '
2281 . ContentHandler
::getLocalizedName( $content->getModel() ) );
2284 return $content->serialize( $this->contentFormat
);
2288 * Turns the given text into a Content object by unserializing it.
2290 * If the resulting Content object is not of a type that can be edited using
2291 * the text base EditPage, an exception will be raised. Set
2292 * $this->allowNonTextContent to true to allow editing of non-textual
2295 * @param string|null|bool $text Text to unserialize
2296 * @return Content The content object created from $text. If $text was false
2297 * or null, false resp. null will be returned instead.
2299 * @throws MWException If unserializing the text results in a Content
2300 * object that is not an instance of TextContent and
2301 * $this->allowNonTextContent is not true.
2303 protected function toEditContent( $text ) {
2304 if ( $text === false ||
$text === null ) {
2308 $content = ContentHandler
::makeContent( $text, $this->getTitle(),
2309 $this->contentModel
, $this->contentFormat
);
2311 if ( !$this->isSupportedContentModel( $content->getModel() ) ) {
2312 throw new MWException( 'This content model is not supported: '
2313 . ContentHandler
::getLocalizedName( $content->getModel() ) );
2320 * Send the edit form and related headers to $wgOut
2321 * @param callable|null $formCallback That takes an OutputPage parameter; will be called
2322 * during form output near the top, for captchas and the like.
2324 function showEditForm( $formCallback = null ) {
2325 global $wgOut, $wgUser;
2327 wfProfileIn( __METHOD__
);
2329 # need to parse the preview early so that we know which templates are used,
2330 # otherwise users with "show preview after edit box" will get a blank list
2331 # we parse this near the beginning so that setHeaders can do the title
2332 # setting work instead of leaving it in getPreviewText
2333 $previewOutput = '';
2334 if ( $this->formtype
== 'preview' ) {
2335 $previewOutput = $this->getPreviewText();
2338 wfRunHooks( 'EditPage::showEditForm:initial', array( &$this, &$wgOut ) );
2340 $this->setHeaders();
2342 if ( $this->showHeader() === false ) {
2343 wfProfileOut( __METHOD__
);
2347 $wgOut->addHTML( $this->editFormPageTop
);
2349 if ( $wgUser->getOption( 'previewontop' ) ) {
2350 $this->displayPreviewArea( $previewOutput, true );
2353 $wgOut->addHTML( $this->editFormTextTop
);
2355 $showToolbar = true;
2356 if ( $this->wasDeletedSinceLastEdit() ) {
2357 if ( $this->formtype
== 'save' ) {
2358 // Hide the toolbar and edit area, user can click preview to get it back
2359 // Add an confirmation checkbox and explanation.
2360 $showToolbar = false;
2362 $wgOut->wrapWikiMsg( "<div class='error mw-deleted-while-editing'>\n$1\n</div>",
2363 'deletedwhileediting' );
2367 // @todo add EditForm plugin interface and use it here!
2368 // search for textarea1 and textares2, and allow EditForm to override all uses.
2369 $wgOut->addHTML( Html
::openElement(
2372 'id' => self
::EDITFORM_ID
,
2373 'name' => self
::EDITFORM_ID
,
2375 'action' => $this->getActionURL( $this->getContextTitle() ),
2376 'enctype' => 'multipart/form-data'
2380 if ( is_callable( $formCallback ) ) {
2381 call_user_func_array( $formCallback, array( &$wgOut ) );
2384 // Add an empty field to trip up spambots
2386 Xml
::openElement( 'div', array( 'id' => 'antispam-container', 'style' => 'display: none;' ) )
2389 array( 'for' => 'wpAntiSpam' ),
2390 wfMessage( 'simpleantispam-label' )->parse()
2396 'name' => 'wpAntispam',
2397 'id' => 'wpAntispam',
2401 . Xml
::closeElement( 'div' )
2404 wfRunHooks( 'EditPage::showEditForm:fields', array( &$this, &$wgOut ) );
2406 // Put these up at the top to ensure they aren't lost on early form submission
2407 $this->showFormBeforeText();
2409 if ( $this->wasDeletedSinceLastEdit() && 'save' == $this->formtype
) {
2410 $username = $this->lastDelete
->user_name
;
2411 $comment = $this->lastDelete
->log_comment
;
2413 // It is better to not parse the comment at all than to have templates expanded in the middle
2414 // TODO: can the checkLabel be moved outside of the div so that wrapWikiMsg could be used?
2415 $key = $comment === ''
2416 ?
'confirmrecreate-noreason'
2417 : 'confirmrecreate';
2419 '<div class="mw-confirm-recreate">' .
2420 wfMessage( $key, $username, "<nowiki>$comment</nowiki>" )->parse() .
2421 Xml
::checkLabel( wfMessage( 'recreate' )->text(), 'wpRecreate', 'wpRecreate', false,
2422 array( 'title' => Linker
::titleAttrib( 'recreate' ), 'tabindex' => 1, 'id' => 'wpRecreate' )
2428 # When the summary is hidden, also hide them on preview/show changes
2429 if ( $this->nosummary
) {
2430 $wgOut->addHTML( Html
::hidden( 'nosummary', true ) );
2433 # If a blank edit summary was previously provided, and the appropriate
2434 # user preference is active, pass a hidden tag as wpIgnoreBlankSummary. This will stop the
2435 # user being bounced back more than once in the event that a summary
2438 # For a bit more sophisticated detection of blank summaries, hash the
2439 # automatic one and pass that in the hidden field wpAutoSummary.
2440 if ( $this->missingSummary ||
( $this->section
== 'new' && $this->nosummary
) ) {
2441 $wgOut->addHTML( Html
::hidden( 'wpIgnoreBlankSummary', true ) );
2444 if ( $this->undidRev
) {
2445 $wgOut->addHTML( Html
::hidden( 'wpUndidRevision', $this->undidRev
) );
2448 if ( $this->hasPresetSummary
) {
2449 // If a summary has been preset using &summary= we don't want to prompt for
2450 // a different summary. Only prompt for a summary if the summary is blanked.
2452 $this->autoSumm
= md5( '' );
2455 $autosumm = $this->autoSumm ?
$this->autoSumm
: md5( $this->summary
);
2456 $wgOut->addHTML( Html
::hidden( 'wpAutoSummary', $autosumm ) );
2458 $wgOut->addHTML( Html
::hidden( 'oldid', $this->oldid
) );
2459 $wgOut->addHTML( Html
::hidden( 'parentRevId',
2460 $this->parentRevId ?
: $this->mArticle
->getRevIdFetched() ) );
2462 $wgOut->addHTML( Html
::hidden( 'format', $this->contentFormat
) );
2463 $wgOut->addHTML( Html
::hidden( 'model', $this->contentModel
) );
2465 if ( $this->section
== 'new' ) {
2466 $this->showSummaryInput( true, $this->summary
);
2467 $wgOut->addHTML( $this->getSummaryPreview( true, $this->summary
) );
2470 $wgOut->addHTML( $this->editFormTextBeforeContent
);
2472 if ( !$this->isCssJsSubpage
&& $showToolbar && $wgUser->getOption( 'showtoolbar' ) ) {
2473 $wgOut->addHTML( EditPage
::getEditToolbar() );
2476 if ( $this->blankArticle
) {
2477 $wgOut->addHTML( Html
::hidden( 'wpIgnoreBlankArticle', true ) );
2480 if ( $this->isConflict
) {
2481 // In an edit conflict bypass the overridable content form method
2482 // and fallback to the raw wpTextbox1 since editconflicts can't be
2483 // resolved between page source edits and custom ui edits using the
2485 $this->textbox2
= $this->textbox1
;
2487 $content = $this->getCurrentContent();
2488 $this->textbox1
= $this->toEditText( $content );
2490 $this->showTextbox1();
2492 $this->showContentForm();
2495 $wgOut->addHTML( $this->editFormTextAfterContent
);
2497 $this->showStandardInputs();
2499 $this->showFormAfterText();
2501 $this->showTosSummary();
2503 $this->showEditTools();
2505 $wgOut->addHTML( $this->editFormTextAfterTools
. "\n" );
2507 $wgOut->addHTML( Html
::rawElement( 'div', array( 'class' => 'templatesUsed' ),
2508 Linker
::formatTemplates( $this->getTemplates(), $this->preview
, $this->section
!= '' ) ) );
2510 $wgOut->addHTML( Html
::rawElement( 'div', array( 'class' => 'hiddencats' ),
2511 Linker
::formatHiddenCategories( $this->mArticle
->getHiddenCategories() ) ) );
2513 $wgOut->addHTML( Html
::rawElement( 'div', array( 'class' => 'limitreport' ),
2514 self
::getPreviewLimitReport( $this->mParserOutput
) ) );
2516 $wgOut->addModules( 'mediawiki.action.edit.collapsibleFooter' );
2518 if ( $this->isConflict
) {
2520 $this->showConflict();
2521 } catch ( MWContentSerializationException
$ex ) {
2522 // this can't really happen, but be nice if it does.
2524 'content-failed-to-parse',
2525 $this->contentModel
,
2526 $this->contentFormat
,
2529 $wgOut->addWikiText( '<div class="error">' . $msg->text() . '</div>' );
2533 // Marker for detecting truncated form data. This must be the last
2534 // parameter sent in order to be of use, so do not move me.
2535 $wgOut->addHTML( Html
::hidden( 'wpUltimateParam', true ) );
2536 $wgOut->addHTML( $this->editFormTextBottom
. "\n</form>\n" );
2538 if ( !$wgUser->getOption( 'previewontop' ) ) {
2539 $this->displayPreviewArea( $previewOutput, false );
2542 wfProfileOut( __METHOD__
);
2546 * Extract the section title from current section text, if any.
2548 * @param string $text
2549 * @return string|bool String or false
2551 public static function extractSectionTitle( $text ) {
2552 preg_match( "/^(=+)(.+)\\1\\s*(\n|$)/i", $text, $matches );
2553 if ( !empty( $matches[2] ) ) {
2555 return $wgParser->stripSectionName( trim( $matches[2] ) );
2564 protected function showHeader() {
2565 global $wgOut, $wgUser, $wgMaxArticleSize, $wgLang;
2566 global $wgAllowUserCss, $wgAllowUserJs;
2568 if ( $this->mTitle
->isTalkPage() ) {
2569 $wgOut->addWikiMsg( 'talkpagetext' );
2573 $wgOut->addHTML( implode( "\n", $this->mTitle
->getEditNotices( $this->oldid
) ) );
2575 if ( $this->isConflict
) {
2576 $wgOut->wrapWikiMsg( "<div class='mw-explainconflict'>\n$1\n</div>", 'explainconflict' );
2577 $this->edittime
= $this->mArticle
->getTimestamp();
2579 if ( $this->section
!= '' && !$this->isSectionEditSupported() ) {
2580 // We use $this->section to much before this and getVal('wgSection') directly in other places
2581 // at this point we can't reset $this->section to '' to fallback to non-section editing.
2582 // Someone is welcome to try refactoring though
2583 $wgOut->showErrorPage( 'sectioneditnotsupported-title', 'sectioneditnotsupported-text' );
2587 if ( $this->section
!= '' && $this->section
!= 'new' ) {
2588 if ( !$this->summary
&& !$this->preview
&& !$this->diff
) {
2589 $sectionTitle = self
::extractSectionTitle( $this->textbox1
); //FIXME: use Content object
2590 if ( $sectionTitle !== false ) {
2591 $this->summary
= "/* $sectionTitle */ ";
2596 if ( $this->missingComment
) {
2597 $wgOut->wrapWikiMsg( "<div id='mw-missingcommenttext'>\n$1\n</div>", 'missingcommenttext' );
2600 if ( $this->missingSummary
&& $this->section
!= 'new' ) {
2601 $wgOut->wrapWikiMsg( "<div id='mw-missingsummary'>\n$1\n</div>", 'missingsummary' );
2604 if ( $this->missingSummary
&& $this->section
== 'new' ) {
2605 $wgOut->wrapWikiMsg( "<div id='mw-missingcommentheader'>\n$1\n</div>", 'missingcommentheader' );
2608 if ( $this->blankArticle
) {
2609 $wgOut->wrapWikiMsg( "<div id='mw-blankarticle'>\n$1\n</div>", 'blankarticle' );
2612 if ( $this->hookError
!== '' ) {
2613 $wgOut->addWikiText( $this->hookError
);
2616 if ( !$this->checkUnicodeCompliantBrowser() ) {
2617 $wgOut->addWikiMsg( 'nonunicodebrowser' );
2620 if ( $this->section
!= 'new' ) {
2621 $revision = $this->mArticle
->getRevisionFetched();
2623 // Let sysop know that this will make private content public if saved
2625 if ( !$revision->userCan( Revision
::DELETED_TEXT
, $wgUser ) ) {
2626 $wgOut->wrapWikiMsg(
2627 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
2628 'rev-deleted-text-permission'
2630 } elseif ( $revision->isDeleted( Revision
::DELETED_TEXT
) ) {
2631 $wgOut->wrapWikiMsg(
2632 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
2633 'rev-deleted-text-view'
2637 if ( !$revision->isCurrent() ) {
2638 $this->mArticle
->setOldSubtitle( $revision->getId() );
2639 $wgOut->addWikiMsg( 'editingold' );
2641 } elseif ( $this->mTitle
->exists() ) {
2642 // Something went wrong
2644 $wgOut->wrapWikiMsg( "<div class='errorbox'>\n$1\n</div>\n",
2645 array( 'missing-revision', $this->oldid
) );
2650 if ( wfReadOnly() ) {
2651 $wgOut->wrapWikiMsg(
2652 "<div id=\"mw-read-only-warning\">\n$1\n</div>",
2653 array( 'readonlywarning', wfReadOnlyReason() )
2655 } elseif ( $wgUser->isAnon() ) {
2656 if ( $this->formtype
!= 'preview' ) {
2657 $wgOut->wrapWikiMsg(
2658 "<div id='mw-anon-edit-warning'>\n$1\n</div>",
2659 array( 'anoneditwarning',
2661 '{{fullurl:Special:UserLogin|returnto={{FULLPAGENAMEE}}}}',
2663 '{{fullurl:Special:UserLogin/signup|returnto={{FULLPAGENAMEE}}}}' )
2666 $wgOut->wrapWikiMsg( "<div id=\"mw-anon-preview-warning\">\n$1</div>",
2667 'anonpreviewwarning'
2671 if ( $this->isCssJsSubpage
) {
2672 # Check the skin exists
2673 if ( $this->isWrongCaseCssJsPage
) {
2674 $wgOut->wrapWikiMsg(
2675 "<div class='error' id='mw-userinvalidcssjstitle'>\n$1\n</div>",
2676 array( 'userinvalidcssjstitle', $this->mTitle
->getSkinFromCssJsSubpage() )
2679 if ( $this->formtype
!== 'preview' ) {
2680 if ( $this->isCssSubpage
&& $wgAllowUserCss ) {
2681 $wgOut->wrapWikiMsg(
2682 "<div id='mw-usercssyoucanpreview'>\n$1\n</div>",
2683 array( 'usercssyoucanpreview' )
2687 if ( $this->isJsSubpage
&& $wgAllowUserJs ) {
2688 $wgOut->wrapWikiMsg(
2689 "<div id='mw-userjsyoucanpreview'>\n$1\n</div>",
2690 array( 'userjsyoucanpreview' )
2697 if ( $this->mTitle
->isProtected( 'edit' ) &&
2698 MWNamespace
::getRestrictionLevels( $this->mTitle
->getNamespace() ) !== array( '' )
2700 # Is the title semi-protected?
2701 if ( $this->mTitle
->isSemiProtected() ) {
2702 $noticeMsg = 'semiprotectedpagewarning';
2704 # Then it must be protected based on static groups (regular)
2705 $noticeMsg = 'protectedpagewarning';
2707 LogEventsList
::showLogExtract( $wgOut, 'protect', $this->mTitle
, '',
2708 array( 'lim' => 1, 'msgKey' => array( $noticeMsg ) ) );
2710 if ( $this->mTitle
->isCascadeProtected() ) {
2711 # Is this page under cascading protection from some source pages?
2712 list( $cascadeSources, /* $restrictions */ ) = $this->mTitle
->getCascadeProtectionSources();
2713 $notice = "<div class='mw-cascadeprotectedwarning'>\n$1\n";
2714 $cascadeSourcesCount = count( $cascadeSources );
2715 if ( $cascadeSourcesCount > 0 ) {
2716 # Explain, and list the titles responsible
2717 foreach ( $cascadeSources as $page ) {
2718 $notice .= '* [[:' . $page->getPrefixedText() . "]]\n";
2721 $notice .= '</div>';
2722 $wgOut->wrapWikiMsg( $notice, array( 'cascadeprotectedwarning', $cascadeSourcesCount ) );
2724 if ( !$this->mTitle
->exists() && $this->mTitle
->getRestrictions( 'create' ) ) {
2725 LogEventsList
::showLogExtract( $wgOut, 'protect', $this->mTitle
, '',
2727 'showIfEmpty' => false,
2728 'msgKey' => array( 'titleprotectedwarning' ),
2729 'wrap' => "<div class=\"mw-titleprotectedwarning\">\n$1</div>" ) );
2732 if ( $this->kblength
=== false ) {
2733 $this->kblength
= (int)( strlen( $this->textbox1
) / 1024 );
2736 if ( $this->tooBig ||
$this->kblength
> $wgMaxArticleSize ) {
2737 $wgOut->wrapWikiMsg( "<div class='error' id='mw-edit-longpageerror'>\n$1\n</div>",
2740 $wgLang->formatNum( $this->kblength
),
2741 $wgLang->formatNum( $wgMaxArticleSize )
2745 if ( !wfMessage( 'longpage-hint' )->isDisabled() ) {
2746 $wgOut->wrapWikiMsg( "<div id='mw-edit-longpage-hint'>\n$1\n</div>",
2749 $wgLang->formatSize( strlen( $this->textbox1
) ),
2750 strlen( $this->textbox1
)
2755 # Add header copyright warning
2756 $this->showHeaderCopyrightWarning();
2762 * Standard summary input and label (wgSummary), abstracted so EditPage
2763 * subclasses may reorganize the form.
2764 * Note that you do not need to worry about the label's for=, it will be
2765 * inferred by the id given to the input. You can remove them both by
2766 * passing array( 'id' => false ) to $userInputAttrs.
2768 * @param string $summary The value of the summary input
2769 * @param string $labelText The html to place inside the label
2770 * @param array $inputAttrs Array of attrs to use on the input
2771 * @param array $spanLabelAttrs Array of attrs to use on the span inside the label
2773 * @return array An array in the format array( $label, $input )
2775 function getSummaryInput( $summary = "", $labelText = null,
2776 $inputAttrs = null, $spanLabelAttrs = null
2778 // Note: the maxlength is overridden in JS to 255 and to make it use UTF-8 bytes, not characters.
2779 $inputAttrs = ( is_array( $inputAttrs ) ?
$inputAttrs : array() ) +
array(
2780 'id' => 'wpSummary',
2781 'maxlength' => '200',
2784 'spellcheck' => 'true',
2785 ) + Linker
::tooltipAndAccesskeyAttribs( 'summary' );
2787 $spanLabelAttrs = ( is_array( $spanLabelAttrs ) ?
$spanLabelAttrs : array() ) +
array(
2788 'class' => $this->missingSummary ?
'mw-summarymissed' : 'mw-summary',
2789 'id' => "wpSummaryLabel"
2796 $inputAttrs['id'] ?
array( 'for' => $inputAttrs['id'] ) : null,
2799 $label = Xml
::tags( 'span', $spanLabelAttrs, $label );
2802 $input = Html
::input( 'wpSummary', $summary, 'text', $inputAttrs );
2804 return array( $label, $input );
2808 * @param bool $isSubjectPreview True if this is the section subject/title
2809 * up top, or false if this is the comment summary
2810 * down below the textarea
2811 * @param string $summary The text of the summary to display
2813 protected function showSummaryInput( $isSubjectPreview, $summary = "" ) {
2814 global $wgOut, $wgContLang;
2815 # Add a class if 'missingsummary' is triggered to allow styling of the summary line
2816 $summaryClass = $this->missingSummary ?
'mw-summarymissed' : 'mw-summary';
2817 if ( $isSubjectPreview ) {
2818 if ( $this->nosummary
) {
2822 if ( !$this->mShowSummaryField
) {
2826 $summary = $wgContLang->recodeForEdit( $summary );
2827 $labelText = wfMessage( $isSubjectPreview ?
'subject' : 'summary' )->parse();
2828 list( $label, $input ) = $this->getSummaryInput(
2831 array( 'class' => $summaryClass ),
2834 $wgOut->addHTML( "{$label} {$input}" );
2838 * @param bool $isSubjectPreview True if this is the section subject/title
2839 * up top, or false if this is the comment summary
2840 * down below the textarea
2841 * @param string $summary The text of the summary to display
2844 protected function getSummaryPreview( $isSubjectPreview, $summary = "" ) {
2845 // avoid spaces in preview, gets always trimmed on save
2846 $summary = trim( $summary );
2847 if ( !$summary ||
( !$this->preview
&& !$this->diff
) ) {
2853 if ( $isSubjectPreview ) {
2854 $summary = wfMessage( 'newsectionsummary' )->rawParams( $wgParser->stripSectionName( $summary ) )
2855 ->inContentLanguage()->text();
2858 $message = $isSubjectPreview ?
'subject-preview' : 'summary-preview';
2860 $summary = wfMessage( $message )->parse()
2861 . Linker
::commentBlock( $summary, $this->mTitle
, $isSubjectPreview );
2862 return Xml
::tags( 'div', array( 'class' => 'mw-summary-preview' ), $summary );
2865 protected function showFormBeforeText() {
2867 $section = htmlspecialchars( $this->section
);
2868 $wgOut->addHTML( <<<HTML
2869 <input type='hidden' value="{$section}" name="wpSection"/>
2870 <input type='hidden' value="{$this->starttime}" name="wpStarttime" />
2871 <input type='hidden' value="{$this->edittime}" name="wpEdittime" />
2872 <input type='hidden' value="{$this->scrolltop}" name="wpScrolltop" id="wpScrolltop" />
2876 if ( !$this->checkUnicodeCompliantBrowser() ) {
2877 $wgOut->addHTML( Html
::hidden( 'safemode', '1' ) );
2881 protected function showFormAfterText() {
2882 global $wgOut, $wgUser;
2884 * To make it harder for someone to slip a user a page
2885 * which submits an edit form to the wiki without their
2886 * knowledge, a random token is associated with the login
2887 * session. If it's not passed back with the submission,
2888 * we won't save the page, or render user JavaScript and
2891 * For anon editors, who may not have a session, we just
2892 * include the constant suffix to prevent editing from
2893 * broken text-mangling proxies.
2895 $wgOut->addHTML( "\n" . Html
::hidden( "wpEditToken", $wgUser->getEditToken() ) . "\n" );
2899 * Subpage overridable method for printing the form for page content editing
2900 * By default this simply outputs wpTextbox1
2901 * Subclasses can override this to provide a custom UI for editing;
2902 * be it a form, or simply wpTextbox1 with a modified content that will be
2903 * reverse modified when extracted from the post data.
2904 * Note that this is basically the inverse for importContentFormData
2906 protected function showContentForm() {
2907 $this->showTextbox1();
2911 * Method to output wpTextbox1
2912 * The $textoverride method can be used by subclasses overriding showContentForm
2913 * to pass back to this method.
2915 * @param array $customAttribs Array of html attributes to use in the textarea
2916 * @param string $textoverride Optional text to override $this->textarea1 with
2918 protected function showTextbox1( $customAttribs = null, $textoverride = null ) {
2919 if ( $this->wasDeletedSinceLastEdit() && $this->formtype
== 'save' ) {
2920 $attribs = array( 'style' => 'display:none;' );
2922 $classes = array(); // Textarea CSS
2923 if ( $this->mTitle
->isProtected( 'edit' ) &&
2924 MWNamespace
::getRestrictionLevels( $this->mTitle
->getNamespace() ) !== array( '' )
2926 # Is the title semi-protected?
2927 if ( $this->mTitle
->isSemiProtected() ) {
2928 $classes[] = 'mw-textarea-sprotected';
2930 # Then it must be protected based on static groups (regular)
2931 $classes[] = 'mw-textarea-protected';
2933 # Is the title cascade-protected?
2934 if ( $this->mTitle
->isCascadeProtected() ) {
2935 $classes[] = 'mw-textarea-cprotected';
2939 $attribs = array( 'tabindex' => 1 );
2941 if ( is_array( $customAttribs ) ) {
2942 $attribs +
= $customAttribs;
2945 if ( count( $classes ) ) {
2946 if ( isset( $attribs['class'] ) ) {
2947 $classes[] = $attribs['class'];
2949 $attribs['class'] = implode( ' ', $classes );
2954 $textoverride !== null ?
$textoverride : $this->textbox1
,
2960 protected function showTextbox2() {
2961 $this->showTextbox( $this->textbox2
, 'wpTextbox2', array( 'tabindex' => 6, 'readonly' ) );
2964 protected function showTextbox( $text, $name, $customAttribs = array() ) {
2965 global $wgOut, $wgUser;
2967 $wikitext = $this->safeUnicodeOutput( $text );
2968 if ( strval( $wikitext ) !== '' ) {
2969 // Ensure there's a newline at the end, otherwise adding lines
2971 // But don't add a newline if the ext is empty, or Firefox in XHTML
2972 // mode will show an extra newline. A bit annoying.
2976 $attribs = $customAttribs +
array(
2979 'cols' => $wgUser->getIntOption( 'cols' ),
2980 'rows' => $wgUser->getIntOption( 'rows' ),
2981 // Avoid PHP notices when appending preferences
2982 // (appending allows customAttribs['style'] to still work).
2986 $pageLang = $this->mTitle
->getPageLanguage();
2987 $attribs['lang'] = $pageLang->getHtmlCode();
2988 $attribs['dir'] = $pageLang->getDir();
2990 $wgOut->addHTML( Html
::textarea( $name, $wikitext, $attribs ) );
2993 protected function displayPreviewArea( $previewOutput, $isOnTop = false ) {
2997 $classes[] = 'ontop';
3000 $attribs = array( 'id' => 'wikiPreview', 'class' => implode( ' ', $classes ) );
3002 if ( $this->formtype
!= 'preview' ) {
3003 $attribs['style'] = 'display: none;';
3006 $wgOut->addHTML( Xml
::openElement( 'div', $attribs ) );
3008 if ( $this->formtype
== 'preview' ) {
3009 $this->showPreview( $previewOutput );
3012 $wgOut->addHTML( '</div>' );
3014 if ( $this->formtype
== 'diff' ) {
3017 } catch ( MWContentSerializationException
$ex ) {
3019 'content-failed-to-parse',
3020 $this->contentModel
,
3021 $this->contentFormat
,
3024 $wgOut->addWikiText( '<div class="error">' . $msg->text() . '</div>' );
3030 * Append preview output to $wgOut.
3031 * Includes category rendering if this is a category page.
3033 * @param string $text The HTML to be output for the preview.
3035 protected function showPreview( $text ) {
3037 if ( $this->mTitle
->getNamespace() == NS_CATEGORY
) {
3038 $this->mArticle
->openShowCategory();
3040 # This hook seems slightly odd here, but makes things more
3041 # consistent for extensions.
3042 wfRunHooks( 'OutputPageBeforeHTML', array( &$wgOut, &$text ) );
3043 $wgOut->addHTML( $text );
3044 if ( $this->mTitle
->getNamespace() == NS_CATEGORY
) {
3045 $this->mArticle
->closeShowCategory();
3050 * Get a diff between the current contents of the edit box and the
3051 * version of the page we're editing from.
3053 * If this is a section edit, we'll replace the section as for final
3054 * save and then make a comparison.
3056 function showDiff() {
3057 global $wgUser, $wgContLang, $wgOut;
3059 $oldtitlemsg = 'currentrev';
3060 # if message does not exist, show diff against the preloaded default
3061 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
&& !$this->mTitle
->exists() ) {
3062 $oldtext = $this->mTitle
->getDefaultMessageText();
3063 if ( $oldtext !== false ) {
3064 $oldtitlemsg = 'defaultmessagetext';
3065 $oldContent = $this->toEditContent( $oldtext );
3070 $oldContent = $this->getCurrentContent();
3073 $textboxContent = $this->toEditContent( $this->textbox1
);
3075 $newContent = $this->mArticle
->replaceSectionContent(
3076 $this->section
, $textboxContent,
3077 $this->summary
, $this->edittime
);
3079 if ( $newContent ) {
3080 ContentHandler
::runLegacyHooks( 'EditPageGetDiffText', array( $this, &$newContent ) );
3081 wfRunHooks( 'EditPageGetDiffContent', array( $this, &$newContent ) );
3083 $popts = ParserOptions
::newFromUserAndLang( $wgUser, $wgContLang );
3084 $newContent = $newContent->preSaveTransform( $this->mTitle
, $wgUser, $popts );
3087 if ( ( $oldContent && !$oldContent->isEmpty() ) ||
( $newContent && !$newContent->isEmpty() ) ) {
3088 $oldtitle = wfMessage( $oldtitlemsg )->parse();
3089 $newtitle = wfMessage( 'yourtext' )->parse();
3091 if ( !$oldContent ) {
3092 $oldContent = $newContent->getContentHandler()->makeEmptyContent();
3095 if ( !$newContent ) {
3096 $newContent = $oldContent->getContentHandler()->makeEmptyContent();
3099 $de = $oldContent->getContentHandler()->createDifferenceEngine( $this->mArticle
->getContext() );
3100 $de->setContent( $oldContent, $newContent );
3102 $difftext = $de->getDiff( $oldtitle, $newtitle );
3103 $de->showDiffStyle();
3108 $wgOut->addHTML( '<div id="wikiDiff">' . $difftext . '</div>' );
3112 * Show the header copyright warning.
3114 protected function showHeaderCopyrightWarning() {
3115 $msg = 'editpage-head-copy-warn';
3116 if ( !wfMessage( $msg )->isDisabled() ) {
3118 $wgOut->wrapWikiMsg( "<div class='editpage-head-copywarn'>\n$1\n</div>",
3119 'editpage-head-copy-warn' );
3124 * Give a chance for site and per-namespace customizations of
3125 * terms of service summary link that might exist separately
3126 * from the copyright notice.
3128 * This will display between the save button and the edit tools,
3129 * so should remain short!
3131 protected function showTosSummary() {
3132 $msg = 'editpage-tos-summary';
3133 wfRunHooks( 'EditPageTosSummary', array( $this->mTitle
, &$msg ) );
3134 if ( !wfMessage( $msg )->isDisabled() ) {
3136 $wgOut->addHTML( '<div class="mw-tos-summary">' );
3137 $wgOut->addWikiMsg( $msg );
3138 $wgOut->addHTML( '</div>' );
3142 protected function showEditTools() {
3144 $wgOut->addHTML( '<div class="mw-editTools">' .
3145 wfMessage( 'edittools' )->inContentLanguage()->parse() .
3150 * Get the copyright warning
3152 * Renamed to getCopyrightWarning(), old name kept around for backwards compatibility
3155 protected function getCopywarn() {
3156 return self
::getCopyrightWarning( $this->mTitle
);
3160 * Get the copyright warning, by default returns wikitext
3162 * @param Title $title
3163 * @param string $format Output format, valid values are any function of a Message object
3166 public static function getCopyrightWarning( $title, $format = 'plain' ) {
3167 global $wgRightsText;
3168 if ( $wgRightsText ) {
3169 $copywarnMsg = array( 'copyrightwarning',
3170 '[[' . wfMessage( 'copyrightpage' )->inContentLanguage()->text() . ']]',
3173 $copywarnMsg = array( 'copyrightwarning2',
3174 '[[' . wfMessage( 'copyrightpage' )->inContentLanguage()->text() . ']]' );
3176 // Allow for site and per-namespace customization of contribution/copyright notice.
3177 wfRunHooks( 'EditPageCopyrightWarning', array( $title, &$copywarnMsg ) );
3179 return "<div id=\"editpage-copywarn\">\n" .
3180 call_user_func_array( 'wfMessage', $copywarnMsg )->$format() . "\n</div>";
3184 * Get the Limit report for page previews
3187 * @param ParserOutput $output ParserOutput object from the parse
3188 * @return string HTML
3190 public static function getPreviewLimitReport( $output ) {
3191 if ( !$output ||
!$output->getLimitReportData() ) {
3195 wfProfileIn( __METHOD__
);
3197 $limitReport = Html
::rawElement( 'div', array( 'class' => 'mw-limitReportExplanation' ),
3198 wfMessage( 'limitreport-title' )->parseAsBlock()
3201 // Show/hide animation doesn't work correctly on a table, so wrap it in a div.
3202 $limitReport .= Html
::openElement( 'div', array( 'class' => 'preview-limit-report-wrapper' ) );
3204 $limitReport .= Html
::openElement( 'table', array(
3205 'class' => 'preview-limit-report wikitable'
3207 Html
::openElement( 'tbody' );
3209 foreach ( $output->getLimitReportData() as $key => $value ) {
3210 if ( wfRunHooks( 'ParserLimitReportFormat',
3211 array( $key, &$value, &$limitReport, true, true )
3213 $keyMsg = wfMessage( $key );
3214 $valueMsg = wfMessage( array( "$key-value-html", "$key-value" ) );
3215 if ( !$valueMsg->exists() ) {
3216 $valueMsg = new RawMessage( '$1' );
3218 if ( !$keyMsg->isDisabled() && !$valueMsg->isDisabled() ) {
3219 $limitReport .= Html
::openElement( 'tr' ) .
3220 Html
::rawElement( 'th', null, $keyMsg->parse() ) .
3221 Html
::rawElement( 'td', null, $valueMsg->params( $value )->parse() ) .
3222 Html
::closeElement( 'tr' );
3227 $limitReport .= Html
::closeElement( 'tbody' ) .
3228 Html
::closeElement( 'table' ) .
3229 Html
::closeElement( 'div' );
3231 wfProfileOut( __METHOD__
);
3233 return $limitReport;
3236 protected function showStandardInputs( &$tabindex = 2 ) {
3238 $wgOut->addHTML( "<div class='editOptions'>\n" );
3240 if ( $this->section
!= 'new' ) {
3241 $this->showSummaryInput( false, $this->summary
);
3242 $wgOut->addHTML( $this->getSummaryPreview( false, $this->summary
) );
3245 $checkboxes = $this->getCheckboxes( $tabindex,
3246 array( 'minor' => $this->minoredit
, 'watch' => $this->watchthis
) );
3247 $wgOut->addHTML( "<div class='editCheckboxes'>" . implode( $checkboxes, "\n" ) . "</div>\n" );
3249 // Show copyright warning.
3250 $wgOut->addWikiText( $this->getCopywarn() );
3251 $wgOut->addHTML( $this->editFormTextAfterWarn
);
3253 $wgOut->addHTML( "<div class='editButtons'>\n" );
3254 $wgOut->addHTML( implode( $this->getEditButtons( $tabindex ), "\n" ) . "\n" );
3256 $cancel = $this->getCancelLink();
3257 if ( $cancel !== '' ) {
3258 $cancel .= Html
::element( 'span',
3259 array( 'class' => 'mw-editButtons-pipe-separator' ),
3260 wfMessage( 'pipe-separator' )->text() );
3263 $message = wfMessage( 'edithelppage' )->inContentLanguage()->text();
3264 $edithelpurl = Skin
::makeInternalOrExternalUrl( $message );
3266 'target' => 'helpwindow',
3267 'href' => $edithelpurl,
3269 $edithelp = Html
::linkButton( wfMessage( 'edithelp' )->text(),
3270 $attrs, array( 'mw-ui-quiet' ) ) .
3271 wfMessage( 'word-separator' )->escaped() .
3272 wfMessage( 'newwindow' )->parse();
3274 $wgOut->addHTML( " <span class='cancelLink'>{$cancel}</span>\n" );
3275 $wgOut->addHTML( " <span class='editHelp'>{$edithelp}</span>\n" );
3276 $wgOut->addHTML( "</div><!-- editButtons -->\n" );
3278 wfRunHooks( 'EditPage::showStandardInputs:options', array( $this, $wgOut, &$tabindex ) );
3280 $wgOut->addHTML( "</div><!-- editOptions -->\n" );
3284 * Show an edit conflict. textbox1 is already shown in showEditForm().
3285 * If you want to use another entry point to this function, be careful.
3287 protected function showConflict() {
3290 if ( wfRunHooks( 'EditPageBeforeConflictDiff', array( &$this, &$wgOut ) ) ) {
3291 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
3293 $content1 = $this->toEditContent( $this->textbox1
);
3294 $content2 = $this->toEditContent( $this->textbox2
);
3296 $handler = ContentHandler
::getForModelID( $this->contentModel
);
3297 $de = $handler->createDifferenceEngine( $this->mArticle
->getContext() );
3298 $de->setContent( $content2, $content1 );
3300 wfMessage( 'yourtext' )->parse(),
3301 wfMessage( 'storedversion' )->text()
3304 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
3305 $this->showTextbox2();
3312 public function getCancelLink() {
3313 $cancelParams = array();
3314 if ( !$this->isConflict
&& $this->oldid
> 0 ) {
3315 $cancelParams['oldid'] = $this->oldid
;
3317 $attrs = array( 'id' => 'mw-editform-cancel' );
3319 return Linker
::linkKnown(
3320 $this->getContextTitle(),
3321 wfMessage( 'cancel' )->parse(),
3322 Html
::buttonAttributes( $attrs, array( 'mw-ui-quiet' ) ),
3328 * Returns the URL to use in the form's action attribute.
3329 * This is used by EditPage subclasses when simply customizing the action
3330 * variable in the constructor is not enough. This can be used when the
3331 * EditPage lives inside of a Special page rather than a custom page action.
3333 * @param Title $title Title object for which is being edited (where we go to for &action= links)
3336 protected function getActionURL( Title
$title ) {
3337 return $title->getLocalURL( array( 'action' => $this->action
) );
3341 * Check if a page was deleted while the user was editing it, before submit.
3342 * Note that we rely on the logging table, which hasn't been always there,
3343 * but that doesn't matter, because this only applies to brand new
3347 protected function wasDeletedSinceLastEdit() {
3348 if ( $this->deletedSinceEdit
!== null ) {
3349 return $this->deletedSinceEdit
;
3352 $this->deletedSinceEdit
= false;
3354 if ( $this->mTitle
->isDeletedQuick() ) {
3355 $this->lastDelete
= $this->getLastDelete();
3356 if ( $this->lastDelete
) {
3357 $deleteTime = wfTimestamp( TS_MW
, $this->lastDelete
->log_timestamp
);
3358 if ( $deleteTime > $this->starttime
) {
3359 $this->deletedSinceEdit
= true;
3364 return $this->deletedSinceEdit
;
3368 * @return bool|stdClass
3370 protected function getLastDelete() {
3371 $dbr = wfGetDB( DB_SLAVE
);
3372 $data = $dbr->selectRow(
3373 array( 'logging', 'user' ),
3386 'log_namespace' => $this->mTitle
->getNamespace(),
3387 'log_title' => $this->mTitle
->getDBkey(),
3388 'log_type' => 'delete',
3389 'log_action' => 'delete',
3393 array( 'LIMIT' => 1, 'ORDER BY' => 'log_timestamp DESC' )
3395 // Quick paranoid permission checks...
3396 if ( is_object( $data ) ) {
3397 if ( $data->log_deleted
& LogPage
::DELETED_USER
) {
3398 $data->user_name
= wfMessage( 'rev-deleted-user' )->escaped();
3401 if ( $data->log_deleted
& LogPage
::DELETED_COMMENT
) {
3402 $data->log_comment
= wfMessage( 'rev-deleted-comment' )->escaped();
3410 * Get the rendered text for previewing.
3411 * @throws MWException
3414 function getPreviewText() {
3415 global $wgOut, $wgUser, $wgRawHtml, $wgLang;
3416 global $wgAllowUserCss, $wgAllowUserJs;
3418 wfProfileIn( __METHOD__
);
3420 if ( $wgRawHtml && !$this->mTokenOk
) {
3421 // Could be an offsite preview attempt. This is very unsafe if
3422 // HTML is enabled, as it could be an attack.
3424 if ( $this->textbox1
!== '' ) {
3425 // Do not put big scary notice, if previewing the empty
3426 // string, which happens when you initially edit
3427 // a category page, due to automatic preview-on-open.
3428 $parsedNote = $wgOut->parse( "<div class='previewnote'>" .
3429 wfMessage( 'session_fail_preview_html' )->text() . "</div>", true, /* interface */true );
3431 wfProfileOut( __METHOD__
);
3438 $content = $this->toEditContent( $this->textbox1
);
3442 'AlternateEditPreview',
3443 array( $this, &$content, &$previewHTML, &$this->mParserOutput
) )
3445 wfProfileOut( __METHOD__
);
3446 return $previewHTML;
3449 # provide a anchor link to the editform
3450 $continueEditing = '<span class="mw-continue-editing">' .
3451 '[[#' . self
::EDITFORM_ID
. '|' . $wgLang->getArrow() . ' ' .
3452 wfMessage( 'continue-editing' )->text() . ']]</span>';
3453 if ( $this->mTriedSave
&& !$this->mTokenOk
) {
3454 if ( $this->mTokenOkExceptSuffix
) {
3455 $note = wfMessage( 'token_suffix_mismatch' )->plain();
3457 $note = wfMessage( 'session_fail_preview' )->plain();
3459 } elseif ( $this->incompleteForm
) {
3460 $note = wfMessage( 'edit_form_incomplete' )->plain();
3462 $note = wfMessage( 'previewnote' )->plain() . ' ' . $continueEditing;
3465 $parserOptions = $this->mArticle
->makeParserOptions( $this->mArticle
->getContext() );
3466 $parserOptions->setEditSection( false );
3467 $parserOptions->setIsPreview( true );
3468 $parserOptions->setIsSectionPreview( !is_null( $this->section
) && $this->section
!== '' );
3470 # don't parse non-wikitext pages, show message about preview
3471 if ( $this->mTitle
->isCssJsSubpage() ||
$this->mTitle
->isCssOrJsPage() ) {
3472 if ( $this->mTitle
->isCssJsSubpage() ) {
3474 } elseif ( $this->mTitle
->isCssOrJsPage() ) {
3480 if ( $content->getModel() == CONTENT_MODEL_CSS
) {
3482 if ( $level === 'user' && !$wgAllowUserCss ) {
3485 } elseif ( $content->getModel() == CONTENT_MODEL_JAVASCRIPT
) {
3487 if ( $level === 'user' && !$wgAllowUserJs ) {
3494 # Used messages to make sure grep find them:
3495 # Messages: usercsspreview, userjspreview, sitecsspreview, sitejspreview
3496 if ( $level && $format ) {
3497 $note = "<div id='mw-{$level}{$format}preview'>" .
3498 wfMessage( "{$level}{$format}preview" )->text() .
3499 ' ' . $continueEditing . "</div>";
3503 # If we're adding a comment, we need to show the
3504 # summary as the headline
3505 if ( $this->section
=== "new" && $this->summary
!== "" ) {
3506 $content = $content->addSectionHeader( $this->summary
);
3509 $hook_args = array( $this, &$content );
3510 ContentHandler
::runLegacyHooks( 'EditPageGetPreviewText', $hook_args );
3511 wfRunHooks( 'EditPageGetPreviewContent', $hook_args );
3513 $parserOptions->enableLimitReport();
3515 # For CSS/JS pages, we should have called the ShowRawCssJs hook here.
3516 # But it's now deprecated, so never mind
3518 $content = $content->preSaveTransform( $this->mTitle
, $wgUser, $parserOptions );
3519 $parserOutput = $content->getParserOutput(
3520 $this->getArticle()->getTitle(),
3525 $previewHTML = $parserOutput->getText();
3526 $this->mParserOutput
= $parserOutput;
3527 $wgOut->addParserOutputMetadata( $parserOutput );
3529 if ( count( $parserOutput->getWarnings() ) ) {
3530 $note .= "\n\n" . implode( "\n\n", $parserOutput->getWarnings() );
3532 } catch ( MWContentSerializationException
$ex ) {
3534 'content-failed-to-parse',
3535 $this->contentModel
,
3536 $this->contentFormat
,
3539 $note .= "\n\n" . $m->parse();
3543 if ( $this->isConflict
) {
3544 $conflict = '<h2 id="mw-previewconflict">'
3545 . wfMessage( 'previewconflict' )->escaped() . "</h2>\n";
3547 $conflict = '<hr />';
3550 $previewhead = "<div class='previewnote'>\n" .
3551 '<h2 id="mw-previewheader">' . wfMessage( 'preview' )->escaped() . "</h2>" .
3552 $wgOut->parse( $note, true, /* interface */true ) . $conflict . "</div>\n";
3554 $pageViewLang = $this->mTitle
->getPageViewLanguage();
3555 $attribs = array( 'lang' => $pageViewLang->getHtmlCode(), 'dir' => $pageViewLang->getDir(),
3556 'class' => 'mw-content-' . $pageViewLang->getDir() );
3557 $previewHTML = Html
::rawElement( 'div', $attribs, $previewHTML );
3559 wfProfileOut( __METHOD__
);
3560 return $previewhead . $previewHTML . $this->previewTextAfterContent
;
3566 function getTemplates() {
3567 if ( $this->preview ||
$this->section
!= '' ) {
3568 $templates = array();
3569 if ( !isset( $this->mParserOutput
) ) {
3572 foreach ( $this->mParserOutput
->getTemplates() as $ns => $template ) {
3573 foreach ( array_keys( $template ) as $dbk ) {
3574 $templates[] = Title
::makeTitle( $ns, $dbk );
3579 return $this->mTitle
->getTemplateLinksFrom();
3584 * Shows a bulletin board style toolbar for common editing functions.
3585 * It can be disabled in the user preferences.
3589 static function getEditToolbar() {
3590 global $wgContLang, $wgOut;
3591 global $wgEnableUploads, $wgForeignFileRepos;
3593 $imagesAvailable = $wgEnableUploads ||
count( $wgForeignFileRepos );
3596 * $toolarray is an array of arrays each of which includes the
3597 * opening tag, the closing tag, optionally a sample text that is
3598 * inserted between the two when no selection is highlighted
3599 * and. The tip text is shown when the user moves the mouse
3602 * Images are defined in ResourceLoaderEditToolbarModule.
3606 'id' => 'mw-editbutton-bold',
3608 'close' => '\'\'\'',
3609 'sample' => wfMessage( 'bold_sample' )->text(),
3610 'tip' => wfMessage( 'bold_tip' )->text(),
3613 'id' => 'mw-editbutton-italic',
3616 'sample' => wfMessage( 'italic_sample' )->text(),
3617 'tip' => wfMessage( 'italic_tip' )->text(),
3620 'id' => 'mw-editbutton-link',
3623 'sample' => wfMessage( 'link_sample' )->text(),
3624 'tip' => wfMessage( 'link_tip' )->text(),
3627 'id' => 'mw-editbutton-extlink',
3630 'sample' => wfMessage( 'extlink_sample' )->text(),
3631 'tip' => wfMessage( 'extlink_tip' )->text(),
3634 'id' => 'mw-editbutton-headline',
3637 'sample' => wfMessage( 'headline_sample' )->text(),
3638 'tip' => wfMessage( 'headline_tip' )->text(),
3640 $imagesAvailable ?
array(
3641 'id' => 'mw-editbutton-image',
3642 'open' => '[[' . $wgContLang->getNsText( NS_FILE
) . ':',
3644 'sample' => wfMessage( 'image_sample' )->text(),
3645 'tip' => wfMessage( 'image_tip' )->text(),
3647 $imagesAvailable ?
array(
3648 'id' => 'mw-editbutton-media',
3649 'open' => '[[' . $wgContLang->getNsText( NS_MEDIA
) . ':',
3651 'sample' => wfMessage( 'media_sample' )->text(),
3652 'tip' => wfMessage( 'media_tip' )->text(),
3655 'id' => 'mw-editbutton-nowiki',
3656 'open' => "<nowiki>",
3657 'close' => "</nowiki>",
3658 'sample' => wfMessage( 'nowiki_sample' )->text(),
3659 'tip' => wfMessage( 'nowiki_tip' )->text(),
3662 'id' => 'mw-editbutton-signature',
3666 'tip' => wfMessage( 'sig_tip' )->text(),
3669 'id' => 'mw-editbutton-hr',
3670 'open' => "\n----\n",
3673 'tip' => wfMessage( 'hr_tip' )->text(),
3677 $script = 'mw.loader.using("mediawiki.toolbar", function () {';
3678 foreach ( $toolarray as $tool ) {
3684 // Images are defined in ResourceLoaderEditToolbarModule
3686 // Note that we use the tip both for the ALT tag and the TITLE tag of the image.
3687 // Older browsers show a "speedtip" type message only for ALT.
3688 // Ideally these should be different, realistically they
3689 // probably don't need to be.
3697 $script .= Xml
::encodeJsCall( 'mw.toolbar.addButton', $params );
3701 $wgOut->addScript( Html
::inlineScript( ResourceLoader
::makeLoaderConditionalScript( $script ) ) );
3703 $toolbar = '<div id="toolbar"></div>';
3705 wfRunHooks( 'EditPageBeforeEditToolbar', array( &$toolbar ) );
3711 * Returns an array of html code of the following checkboxes:
3714 * @param int $tabindex Current tabindex
3715 * @param array $checked Array of checkbox => bool, where bool indicates the checked
3716 * status of the checkbox
3720 public function getCheckboxes( &$tabindex, $checked ) {
3721 global $wgUser, $wgUseMediaWikiUIEverywhere;
3723 $checkboxes = array();
3725 // don't show the minor edit checkbox if it's a new page or section
3726 if ( !$this->isNew
) {
3727 $checkboxes['minor'] = '';
3728 $minorLabel = wfMessage( 'minoredit' )->parse();
3729 if ( $wgUser->isAllowed( 'minoredit' ) ) {
3731 'tabindex' => ++
$tabindex,
3732 'accesskey' => wfMessage( 'accesskey-minoredit' )->text(),
3733 'id' => 'wpMinoredit',
3736 Xml
::check( 'wpMinoredit', $checked['minor'], $attribs ) .
3737 " <label for='wpMinoredit' id='mw-editpage-minoredit'" .
3738 Xml
::expandAttributes( array( 'title' => Linker
::titleAttrib( 'minoredit', 'withaccess' ) ) ) .
3739 ">{$minorLabel}</label>";
3741 if ( $wgUseMediaWikiUIEverywhere ) {
3742 $checkboxes['minor'] = Html
::openElement( 'div', array( 'class' => 'mw-ui-checkbox' ) ) .
3744 Html
::closeElement( 'div' );
3746 $checkboxes['minor'] = $minorEditHtml;
3751 $watchLabel = wfMessage( 'watchthis' )->parse();
3752 $checkboxes['watch'] = '';
3753 if ( $wgUser->isLoggedIn() ) {
3755 'tabindex' => ++
$tabindex,
3756 'accesskey' => wfMessage( 'accesskey-watch' )->text(),
3757 'id' => 'wpWatchthis',
3760 Xml
::check( 'wpWatchthis', $checked['watch'], $attribs ) .
3761 " <label for='wpWatchthis' id='mw-editpage-watch'" .
3762 Xml
::expandAttributes( array( 'title' => Linker
::titleAttrib( 'watch', 'withaccess' ) ) ) .
3763 ">{$watchLabel}</label>";
3764 if ( $wgUseMediaWikiUIEverywhere ) {
3765 $checkboxes['watch'] = Html
::openElement( 'div', array( 'class' => 'mw-ui-checkbox' ) ) .
3767 Html
::closeElement( 'div' );
3769 $checkboxes['watch'] = $watchThisHtml;
3772 wfRunHooks( 'EditPageBeforeEditChecks', array( &$this, &$checkboxes, &$tabindex ) );
3777 * Returns an array of html code of the following buttons:
3778 * save, diff, preview and live
3780 * @param int $tabindex Current tabindex
3784 public function getEditButtons( &$tabindex ) {
3790 'tabindex' => ++
$tabindex,
3791 ) + Linker
::tooltipAndAccesskeyAttribs( 'save' );
3792 $buttons['save'] = Html
::submitButton( wfMessage( 'savearticle' )->text(),
3793 $attribs, array( 'mw-ui-constructive' ) );
3795 ++
$tabindex; // use the same for preview and live preview
3797 'id' => 'wpPreview',
3798 'name' => 'wpPreview',
3799 'tabindex' => $tabindex,
3800 ) + Linker
::tooltipAndAccesskeyAttribs( 'preview' );
3801 $buttons['preview'] = Html
::submitButton( wfMessage( 'showpreview' )->text(),
3803 $buttons['live'] = '';
3808 'tabindex' => ++
$tabindex,
3809 ) + Linker
::tooltipAndAccesskeyAttribs( 'diff' );
3810 $buttons['diff'] = Html
::submitButton( wfMessage( 'showdiff' )->text(),
3813 wfRunHooks( 'EditPageBeforeEditButtons', array( &$this, &$buttons, &$tabindex ) );
3818 * Output preview text only. This can be sucked into the edit page
3819 * via JavaScript, and saves the server time rendering the skin as
3820 * well as theoretically being more robust on the client (doesn't
3821 * disturb the edit box's undo history, won't eat your text on
3824 * @todo This doesn't include category or interlanguage links.
3825 * Would need to enhance it a bit, "<s>maybe wrap them in XML
3826 * or something...</s>" that might also require more skin
3827 * initialization, so check whether that's a problem.
3829 function livePreview() {
3832 header( 'Content-type: text/xml; charset=utf-8' );
3833 header( 'Cache-control: no-cache' );
3835 $previewText = $this->getPreviewText();
3836 #$categories = $skin->getCategoryLinks();
3839 '<?xml version="1.0" encoding="UTF-8" ?>' . "\n" .
3840 Xml
::tags( 'livepreview', null,
3841 Xml
::element( 'preview', null, $previewText )
3842 #. Xml::element( 'category', null, $categories )
3848 * Creates a basic error page which informs the user that
3849 * they have attempted to edit a nonexistent section.
3851 function noSuchSectionPage() {
3854 $wgOut->prepareErrorPage( wfMessage( 'nosuchsectiontitle' ) );
3856 $res = wfMessage( 'nosuchsectiontext', $this->section
)->parseAsBlock();
3857 wfRunHooks( 'EditPageNoSuchSection', array( &$this, &$res ) );
3858 $wgOut->addHTML( $res );
3860 $wgOut->returnToMain( false, $this->mTitle
);
3864 * Show "your edit contains spam" page with your diff and text
3866 * @param string|array|bool $match Text (or array of texts) which triggered one or more filters
3868 public function spamPageWithContent( $match = false ) {
3869 global $wgOut, $wgLang;
3870 $this->textbox2
= $this->textbox1
;
3872 if ( is_array( $match ) ) {
3873 $match = $wgLang->listToText( $match );
3875 $wgOut->prepareErrorPage( wfMessage( 'spamprotectiontitle' ) );
3877 $wgOut->addHTML( '<div id="spamprotected">' );
3878 $wgOut->addWikiMsg( 'spamprotectiontext' );
3880 $wgOut->addWikiMsg( 'spamprotectionmatch', wfEscapeWikiText( $match ) );
3882 $wgOut->addHTML( '</div>' );
3884 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
3887 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
3888 $this->showTextbox2();
3890 $wgOut->addReturnTo( $this->getContextTitle(), array( 'action' => 'edit' ) );
3894 * Check if the browser is on a blacklist of user-agents known to
3895 * mangle UTF-8 data on form submission. Returns true if Unicode
3896 * should make it through, false if it's known to be a problem.
3899 private function checkUnicodeCompliantBrowser() {
3900 global $wgBrowserBlackList, $wgRequest;
3902 $currentbrowser = $wgRequest->getHeader( 'User-Agent' );
3903 if ( $currentbrowser === false ) {
3904 // No User-Agent header sent? Trust it by default...
3908 foreach ( $wgBrowserBlackList as $browser ) {
3909 if ( preg_match( $browser, $currentbrowser ) ) {
3917 * Filter an input field through a Unicode de-armoring process if it
3918 * came from an old browser with known broken Unicode editing issues.
3920 * @param WebRequest $request
3921 * @param string $field
3924 protected function safeUnicodeInput( $request, $field ) {
3925 $text = rtrim( $request->getText( $field ) );
3926 return $request->getBool( 'safemode' )
3927 ?
$this->unmakeSafe( $text )
3932 * Filter an output field through a Unicode armoring process if it is
3933 * going to an old browser with known broken Unicode editing issues.
3935 * @param string $text
3938 protected function safeUnicodeOutput( $text ) {
3940 $codedText = $wgContLang->recodeForEdit( $text );
3941 return $this->checkUnicodeCompliantBrowser()
3943 : $this->makeSafe( $codedText );
3947 * A number of web browsers are known to corrupt non-ASCII characters
3948 * in a UTF-8 text editing environment. To protect against this,
3949 * detected browsers will be served an armored version of the text,
3950 * with non-ASCII chars converted to numeric HTML character references.
3952 * Preexisting such character references will have a 0 added to them
3953 * to ensure that round-trips do not alter the original data.
3955 * @param string $invalue
3958 private function makeSafe( $invalue ) {
3959 // Armor existing references for reversibility.
3960 $invalue = strtr( $invalue, array( "&#x" => "�" ) );
3965 $valueLength = strlen( $invalue );
3966 for ( $i = 0; $i < $valueLength; $i++
) {
3967 $bytevalue = ord( $invalue[$i] );
3968 if ( $bytevalue <= 0x7F ) { // 0xxx xxxx
3969 $result .= chr( $bytevalue );
3971 } elseif ( $bytevalue <= 0xBF ) { // 10xx xxxx
3972 $working = $working << 6;
3973 $working +
= ( $bytevalue & 0x3F );
3975 if ( $bytesleft <= 0 ) {
3976 $result .= "&#x" . strtoupper( dechex( $working ) ) . ";";
3978 } elseif ( $bytevalue <= 0xDF ) { // 110x xxxx
3979 $working = $bytevalue & 0x1F;
3981 } elseif ( $bytevalue <= 0xEF ) { // 1110 xxxx
3982 $working = $bytevalue & 0x0F;
3984 } else { // 1111 0xxx
3985 $working = $bytevalue & 0x07;
3993 * Reverse the previously applied transliteration of non-ASCII characters
3994 * back to UTF-8. Used to protect data from corruption by broken web browsers
3995 * as listed in $wgBrowserBlackList.
3997 * @param string $invalue
4000 private function unmakeSafe( $invalue ) {
4002 $valueLength = strlen( $invalue );
4003 for ( $i = 0; $i < $valueLength; $i++
) {
4004 if ( ( substr( $invalue, $i, 3 ) == "&#x" ) && ( $invalue[$i +
3] != '0' ) ) {
4008 $hexstring .= $invalue[$i];
4010 } while ( ctype_xdigit( $invalue[$i] ) && ( $i < strlen( $invalue ) ) );
4012 // Do some sanity checks. These aren't needed for reversibility,
4013 // but should help keep the breakage down if the editor
4014 // breaks one of the entities whilst editing.
4015 if ( ( substr( $invalue, $i, 1 ) == ";" ) && ( strlen( $hexstring ) <= 6 ) ) {
4016 $codepoint = hexdec( $hexstring );
4017 $result .= codepointToUtf8( $codepoint );
4019 $result .= "&#x" . $hexstring . substr( $invalue, $i, 1 );
4022 $result .= substr( $invalue, $i, 1 );
4025 // reverse the transform that we made for reversibility reasons.
4026 return strtr( $result, array( "�" => "&#x" ) );