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: user tried to create self-redirect (redirect to the same article) and
155 * wpIgnoreSelfRedirect == false
157 const AS_SELF_REDIRECT
= 236;
160 * Status: can't parse content
162 const AS_PARSE_ERROR
= 240;
165 * HTML id and name for the beginning of the edit form.
167 const EDITFORM_ID
= 'editform';
170 * Prefix of key for cookie used to pass post-edit state.
171 * The revision id edited is added after this
173 const POST_EDIT_COOKIE_KEY_PREFIX
= 'PostEditRevision';
176 * Duration of PostEdit cookie, in seconds.
177 * The cookie will be removed instantly if the JavaScript runs.
179 * Otherwise, though, we don't want the cookies to accumulate.
180 * RFC 2109 ( https://www.ietf.org/rfc/rfc2109.txt ) specifies a possible
181 * limit of only 20 cookies per domain. This still applies at least to some
182 * versions of IE without full updates:
183 * https://blogs.msdn.com/b/ieinternals/archive/2009/08/20/wininet-ie-cookie-internals-faq.aspx
185 * A value of 20 minutes should be enough to take into account slow loads and minor
186 * clock skew while still avoiding cookie accumulation when JavaScript is turned off.
188 const POST_EDIT_COOKIE_DURATION
= 1200;
196 /** @var null|Title */
197 private $mContextTitle = null;
200 public $action = 'submit';
203 public $isConflict = false;
206 public $isCssJsSubpage = false;
209 public $isCssSubpage = false;
212 public $isJsSubpage = false;
215 public $isWrongCaseCssJsPage = false;
217 /** @var bool New page or new section */
218 public $isNew = false;
221 public $deletedSinceEdit;
229 /** @var bool|stdClass */
233 public $mTokenOk = false;
236 public $mTokenOkExceptSuffix = false;
239 public $mTriedSave = false;
242 public $incompleteForm = false;
245 public $tooBig = false;
248 public $kblength = false;
251 public $missingComment = false;
254 public $missingSummary = false;
257 public $allowBlankSummary = false;
260 protected $blankArticle = false;
263 protected $allowBlankArticle = false;
266 protected $selfRedirect = false;
269 protected $allowSelfRedirect = false;
272 public $autoSumm = '';
275 public $hookError = '';
277 /** @var ParserOutput */
278 public $mParserOutput;
280 /** @var bool Has a summary been preset using GET parameter &summary= ? */
281 public $hasPresetSummary = false;
284 public $mBaseRevision = false;
287 public $mShowSummaryField = true;
292 public $save = false;
295 public $preview = false;
298 public $diff = false;
301 public $minoredit = false;
304 public $watchthis = false;
307 public $recreate = false;
310 public $textbox1 = '';
313 public $textbox2 = '';
316 public $summary = '';
319 public $nosummary = false;
322 public $edittime = '';
325 public $section = '';
328 public $sectiontitle = '';
331 public $starttime = '';
337 public $parentRevId = 0;
340 public $editintro = '';
343 public $scrolltop = null;
348 /** @var null|string */
349 public $contentModel = null;
351 /** @var null|string */
352 public $contentFormat = null;
354 # Placeholders for text injection by hooks (must be HTML)
355 # extensions should take care to _append_ to the present value
357 /** @var string Before even the preview */
358 public $editFormPageTop = '';
359 public $editFormTextTop = '';
360 public $editFormTextBeforeContent = '';
361 public $editFormTextAfterWarn = '';
362 public $editFormTextAfterTools = '';
363 public $editFormTextBottom = '';
364 public $editFormTextAfterContent = '';
365 public $previewTextAfterContent = '';
366 public $mPreloadContent = null;
368 /* $didSave should be set to true whenever an article was successfully altered. */
369 public $didSave = false;
370 public $undidRev = 0;
372 public $suppressIntro = false;
374 /** @var bool Set to true to allow editing of non-text content types. */
375 public $allowNonTextContent = false;
381 * @param Article $article
383 public function __construct( Article
$article ) {
384 $this->mArticle
= $article;
385 $this->mTitle
= $article->getTitle();
387 $this->contentModel
= $this->mTitle
->getContentModel();
389 $handler = ContentHandler
::getForModelID( $this->contentModel
);
390 $this->contentFormat
= $handler->getDefaultFormat();
396 public function getArticle() {
397 return $this->mArticle
;
404 public function getTitle() {
405 return $this->mTitle
;
409 * Set the context Title object
411 * @param Title|null $title Title object or null
413 public function setContextTitle( $title ) {
414 $this->mContextTitle
= $title;
418 * Get the context title object.
419 * If not set, $wgTitle will be returned. This behavior might change in
420 * the future to return $this->mTitle instead.
424 public function getContextTitle() {
425 if ( is_null( $this->mContextTitle
) ) {
429 return $this->mContextTitle
;
434 * Returns if the given content model is editable.
436 * @param string $modelId The ID of the content model to test. Use CONTENT_MODEL_XXX constants.
438 * @throws MWException If $modelId has no known handler
440 public function isSupportedContentModel( $modelId ) {
441 return $this->allowNonTextContent ||
442 ContentHandler
::getForModelID( $modelId ) instanceof TextContentHandler
;
450 * This is the function that gets called for "action=edit". It
451 * sets up various member variables, then passes execution to
452 * another function, usually showEditForm()
454 * The edit form is self-submitting, so that when things like
455 * preview and edit conflicts occur, we get the same form back
456 * with the extra stuff added. Only when the final submission
457 * is made and all is well do we actually save and redirect to
458 * the newly-edited page.
461 global $wgOut, $wgRequest, $wgUser;
462 // Allow extensions to modify/prevent this form or submission
463 if ( !Hooks
::run( 'AlternateEdit', array( $this ) ) ) {
467 wfDebug( __METHOD__
. ": enter\n" );
469 // If they used redlink=1 and the page exists, redirect to the main article
470 if ( $wgRequest->getBool( 'redlink' ) && $this->mTitle
->exists() ) {
471 $wgOut->redirect( $this->mTitle
->getFullURL() );
475 $this->importFormData( $wgRequest );
476 $this->firsttime
= false;
478 if ( wfReadOnly() && $this->save
) {
481 $this->preview
= true;
485 $this->formtype
= 'save';
486 } elseif ( $this->preview
) {
487 $this->formtype
= 'preview';
488 } elseif ( $this->diff
) {
489 $this->formtype
= 'diff';
490 } else { # First time through
491 $this->firsttime
= true;
492 if ( $this->previewOnOpen() ) {
493 $this->formtype
= 'preview';
495 $this->formtype
= 'initial';
499 $permErrors = $this->getEditPermissionErrors( $this->save ?
'secure' : 'full' );
501 wfDebug( __METHOD__
. ": User can't edit\n" );
502 // Auto-block user's IP if the account was "hard" blocked
503 $wgUser->spreadAnyEditBlock();
505 $this->displayPermissionsError( $permErrors );
510 $this->isConflict
= false;
511 // css / js subpages of user pages get a special treatment
512 $this->isCssJsSubpage
= $this->mTitle
->isCssJsSubpage();
513 $this->isCssSubpage
= $this->mTitle
->isCssSubpage();
514 $this->isJsSubpage
= $this->mTitle
->isJsSubpage();
515 // @todo FIXME: Silly assignment.
516 $this->isWrongCaseCssJsPage
= $this->isWrongCaseCssJsPage();
518 # Show applicable editing introductions
519 if ( $this->formtype
== 'initial' ||
$this->firsttime
) {
523 # Attempt submission here. This will check for edit conflicts,
524 # and redundantly check for locked database, blocked IPs, etc.
525 # that edit() already checked just in case someone tries to sneak
526 # in the back door with a hand-edited submission URL.
528 if ( 'save' == $this->formtype
) {
529 $resultDetails = null;
530 $status = $this->attemptSave( $resultDetails );
531 if ( !$this->handleStatus( $status, $resultDetails ) ) {
536 # First time through: get contents, set time for conflict
538 if ( 'initial' == $this->formtype ||
$this->firsttime
) {
539 if ( $this->initialiseForm() === false ) {
540 $this->noSuchSectionPage();
544 if ( !$this->mTitle
->getArticleID() ) {
545 Hooks
::run( 'EditFormPreloadText', array( &$this->textbox1
, &$this->mTitle
) );
547 Hooks
::run( 'EditFormInitialText', array( $this ) );
552 $this->showEditForm();
556 * @param string $rigor Same format as Title::getUserPermissionErrors()
559 protected function getEditPermissionErrors( $rigor = 'secure' ) {
562 $permErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $wgUser, $rigor );
563 # Can this title be created?
564 if ( !$this->mTitle
->exists() ) {
565 $permErrors = array_merge(
568 $this->mTitle
->getUserPermissionsErrors( 'create', $wgUser, $rigor ),
573 # Ignore some permissions errors when a user is just previewing/viewing diffs
575 foreach ( $permErrors as $error ) {
576 if ( ( $this->preview ||
$this->diff
)
577 && ( $error[0] == 'blockedtext' ||
$error[0] == 'autoblockedtext' )
582 $permErrors = wfArrayDiff2( $permErrors, $remove );
588 * Display a permissions error page, like OutputPage::showPermissionsErrorPage(),
589 * but with the following differences:
590 * - If redlink=1, the user will be redirected to the page
591 * - If there is content to display or the error occurs while either saving,
592 * previewing or showing the difference, it will be a
593 * "View source for ..." page displaying the source code after the error message.
596 * @param array $permErrors Array of permissions errors, as returned by
597 * Title::getUserPermissionsErrors().
598 * @throws PermissionsError
600 protected function displayPermissionsError( array $permErrors ) {
601 global $wgRequest, $wgOut;
603 if ( $wgRequest->getBool( 'redlink' ) ) {
604 // The edit page was reached via a red link.
605 // Redirect to the article page and let them click the edit tab if
606 // they really want a permission error.
607 $wgOut->redirect( $this->mTitle
->getFullURL() );
611 $content = $this->getContentObject();
613 # Use the normal message if there's nothing to display
614 if ( $this->firsttime
&& ( !$content ||
$content->isEmpty() ) ) {
615 $action = $this->mTitle
->exists() ?
'edit' :
616 ( $this->mTitle
->isTalkPage() ?
'createtalk' : 'createpage' );
617 throw new PermissionsError( $action, $permErrors );
620 Hooks
::run( 'EditPage::showReadOnlyForm:initial', array( $this, &$wgOut ) );
622 $wgOut->setRobotPolicy( 'noindex,nofollow' );
623 $wgOut->setPageTitle( wfMessage(
625 $this->getContextTitle()->getPrefixedText()
627 $wgOut->addBacklinkSubtitle( $this->getContextTitle() );
628 $wgOut->addWikiText( $wgOut->formatPermissionsErrorMessage( $permErrors, 'edit' ) );
629 $wgOut->addHTML( "<hr />\n" );
631 # If the user made changes, preserve them when showing the markup
632 # (This happens when a user is blocked during edit, for instance)
633 if ( !$this->firsttime
) {
634 $text = $this->textbox1
;
635 $wgOut->addWikiMsg( 'viewyourtext' );
637 $text = $this->toEditText( $content );
638 $wgOut->addWikiMsg( 'viewsourcetext' );
641 $this->showTextbox( $text, 'wpTextbox1', array( 'readonly' ) );
643 $wgOut->addHTML( Html
::rawElement( 'div', array( 'class' => 'templatesUsed' ),
644 Linker
::formatTemplates( $this->getTemplates() ) ) );
646 $wgOut->addModules( 'mediawiki.action.edit.collapsibleFooter' );
648 if ( $this->mTitle
->exists() ) {
649 $wgOut->returnToMain( null, $this->mTitle
);
654 * Should we show a preview when the edit form is first shown?
658 protected function previewOnOpen() {
659 global $wgRequest, $wgUser, $wgPreviewOnOpenNamespaces;
660 if ( $wgRequest->getVal( 'preview' ) == 'yes' ) {
661 // Explicit override from request
663 } elseif ( $wgRequest->getVal( 'preview' ) == 'no' ) {
664 // Explicit override from request
666 } elseif ( $this->section
== 'new' ) {
667 // Nothing *to* preview for new sections
669 } elseif ( ( $wgRequest->getVal( 'preload' ) !== null ||
$this->mTitle
->exists() )
670 && $wgUser->getOption( 'previewonfirst' )
672 // Standard preference behavior
674 } elseif ( !$this->mTitle
->exists()
675 && isset( $wgPreviewOnOpenNamespaces[$this->mTitle
->getNamespace()] )
676 && $wgPreviewOnOpenNamespaces[$this->mTitle
->getNamespace()]
678 // Categories are special
686 * Checks whether the user entered a skin name in uppercase,
687 * e.g. "User:Example/Monobook.css" instead of "monobook.css"
691 protected function isWrongCaseCssJsPage() {
692 if ( $this->mTitle
->isCssJsSubpage() ) {
693 $name = $this->mTitle
->getSkinFromCssJsSubpage();
694 $skins = array_merge(
695 array_keys( Skin
::getSkinNames() ),
698 return !in_array( $name, $skins )
699 && in_array( strtolower( $name ), $skins );
706 * Returns whether section editing is supported for the current page.
707 * Subclasses may override this to replace the default behavior, which is
708 * to check ContentHandler::supportsSections.
710 * @return bool True if this edit page supports sections, false otherwise.
712 protected function isSectionEditSupported() {
713 $contentHandler = ContentHandler
::getForTitle( $this->mTitle
);
714 return $contentHandler->supportsSections();
718 * This function collects the form data and uses it to populate various member variables.
719 * @param WebRequest $request
720 * @throws ErrorPageError
722 function importFormData( &$request ) {
723 global $wgContLang, $wgUser;
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 throw new ErrorPageError( 'sectioneditnotsupported-title', 'sectioneditnotsupported-text' );
732 $this->isNew
= !$this->mTitle
->exists() ||
$this->section
== 'new';
734 if ( $request->wasPosted() ) {
735 # These fields need to be checked for encoding.
736 # Also remove trailing whitespace, but don't remove _initial_
737 # whitespace from the text boxes. This may be significant formatting.
738 $this->textbox1
= $this->safeUnicodeInput( $request, 'wpTextbox1' );
739 if ( !$request->getCheck( 'wpTextbox2' ) ) {
740 // Skip this if wpTextbox2 has input, it indicates that we came
741 // from a conflict page with raw page text, not a custom form
742 // modified by subclasses
743 $textbox1 = $this->importContentFormData( $request );
744 if ( $textbox1 !== null ) {
745 $this->textbox1
= $textbox1;
749 # Truncate for whole multibyte characters
750 $this->summary
= $wgContLang->truncate( $request->getText( 'wpSummary' ), 255 );
752 # If the summary consists of a heading, e.g. '==Foobar==', extract the title from the
753 # header syntax, e.g. 'Foobar'. This is mainly an issue when we are using wpSummary for
755 $this->summary
= preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->summary
);
757 # Treat sectiontitle the same way as summary.
758 # Note that wpSectionTitle is not yet a part of the actual edit form, as wpSummary is
759 # currently doing double duty as both edit summary and section title. Right now this
760 # is just to allow API edits to work around this limitation, but this should be
761 # incorporated into the actual edit form when EditPage is rewritten (Bugs 18654, 26312).
762 $this->sectiontitle
= $wgContLang->truncate( $request->getText( 'wpSectionTitle' ), 255 );
763 $this->sectiontitle
= preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->sectiontitle
);
765 $this->edittime
= $request->getVal( 'wpEdittime' );
766 $this->starttime
= $request->getVal( 'wpStarttime' );
768 $undidRev = $request->getInt( 'wpUndidRevision' );
770 $this->undidRev
= $undidRev;
773 $this->scrolltop
= $request->getIntOrNull( 'wpScrolltop' );
775 if ( $this->textbox1
=== '' && $request->getVal( 'wpTextbox1' ) === null ) {
776 // wpTextbox1 field is missing, possibly due to being "too big"
777 // according to some filter rules such as Suhosin's setting for
778 // suhosin.request.max_value_length (d'oh)
779 $this->incompleteForm
= true;
781 // If we receive the last parameter of the request, we can fairly
782 // claim the POST request has not been truncated.
784 // TODO: softened the check for cutover. Once we determine
785 // that it is safe, we should complete the transition by
786 // removing the "edittime" clause.
787 $this->incompleteForm
= ( !$request->getVal( 'wpUltimateParam' )
788 && is_null( $this->edittime
) );
790 if ( $this->incompleteForm
) {
791 # If the form is incomplete, force to preview.
792 wfDebug( __METHOD__
. ": Form data appears to be incomplete\n" );
793 wfDebug( "POST DATA: " . var_export( $_POST, true ) . "\n" );
794 $this->preview
= true;
796 $this->preview
= $request->getCheck( 'wpPreview' );
797 $this->diff
= $request->getCheck( 'wpDiff' );
799 // Remember whether a save was requested, so we can indicate
800 // if we forced preview due to session failure.
801 $this->mTriedSave
= !$this->preview
;
803 if ( $this->tokenOk( $request ) ) {
804 # Some browsers will not report any submit button
805 # if the user hits enter in the comment box.
806 # The unmarked state will be assumed to be a save,
807 # if the form seems otherwise complete.
808 wfDebug( __METHOD__
. ": Passed token check.\n" );
809 } elseif ( $this->diff
) {
810 # Failed token check, but only requested "Show Changes".
811 wfDebug( __METHOD__
. ": Failed token check; Show Changes requested.\n" );
813 # Page might be a hack attempt posted from
814 # an external site. Preview instead of saving.
815 wfDebug( __METHOD__
. ": Failed token check; forcing preview\n" );
816 $this->preview
= true;
819 $this->save
= !$this->preview
&& !$this->diff
;
820 if ( !preg_match( '/^\d{14}$/', $this->edittime
) ) {
821 $this->edittime
= null;
824 if ( !preg_match( '/^\d{14}$/', $this->starttime
) ) {
825 $this->starttime
= null;
828 $this->recreate
= $request->getCheck( 'wpRecreate' );
830 $this->minoredit
= $request->getCheck( 'wpMinoredit' );
831 $this->watchthis
= $request->getCheck( 'wpWatchthis' );
833 # Don't force edit summaries when a user is editing their own user or talk page
834 if ( ( $this->mTitle
->mNamespace
== NS_USER ||
$this->mTitle
->mNamespace
== NS_USER_TALK
)
835 && $this->mTitle
->getText() == $wgUser->getName()
837 $this->allowBlankSummary
= true;
839 $this->allowBlankSummary
= $request->getBool( 'wpIgnoreBlankSummary' )
840 ||
!$wgUser->getOption( 'forceeditsummary' );
843 $this->autoSumm
= $request->getText( 'wpAutoSummary' );
845 $this->allowBlankArticle
= $request->getBool( 'wpIgnoreBlankArticle' );
846 $this->allowSelfRedirect
= $request->getBool( 'wpIgnoreSelfRedirect' );
848 # Not a posted form? Start with nothing.
849 wfDebug( __METHOD__
. ": Not a posted form.\n" );
850 $this->textbox1
= '';
852 $this->sectiontitle
= '';
853 $this->edittime
= '';
854 $this->starttime
= wfTimestampNow();
856 $this->preview
= false;
859 $this->minoredit
= false;
860 // Watch may be overridden by request parameters
861 $this->watchthis
= $request->getBool( 'watchthis', false );
862 $this->recreate
= false;
864 // When creating a new section, we can preload a section title by passing it as the
865 // preloadtitle parameter in the URL (Bug 13100)
866 if ( $this->section
== 'new' && $request->getVal( 'preloadtitle' ) ) {
867 $this->sectiontitle
= $request->getVal( 'preloadtitle' );
868 // Once wpSummary isn't being use for setting section titles, we should delete this.
869 $this->summary
= $request->getVal( 'preloadtitle' );
870 } elseif ( $this->section
!= 'new' && $request->getVal( 'summary' ) ) {
871 $this->summary
= $request->getText( 'summary' );
872 if ( $this->summary
!== '' ) {
873 $this->hasPresetSummary
= true;
877 if ( $request->getVal( 'minor' ) ) {
878 $this->minoredit
= true;
882 $this->oldid
= $request->getInt( 'oldid' );
883 $this->parentRevId
= $request->getInt( 'parentRevId' );
885 $this->bot
= $request->getBool( 'bot', true );
886 $this->nosummary
= $request->getBool( 'nosummary' );
888 // May be overridden by revision.
889 $this->contentModel
= $request->getText( 'model', $this->contentModel
);
890 // May be overridden by revision.
891 $this->contentFormat
= $request->getText( 'format', $this->contentFormat
);
893 if ( !ContentHandler
::getForModelID( $this->contentModel
)
894 ->isSupportedFormat( $this->contentFormat
)
896 throw new ErrorPageError(
897 'editpage-notsupportedcontentformat-title',
898 'editpage-notsupportedcontentformat-text',
899 array( $this->contentFormat
, ContentHandler
::getLocalizedName( $this->contentModel
) )
904 * @todo Check if the desired model is allowed in this namespace, and if
905 * a transition from the page's current model to the new model is
909 $this->editintro
= $request->getText( 'editintro',
910 // Custom edit intro for new sections
911 $this->section
=== 'new' ?
'MediaWiki:addsection-editintro' : '' );
913 // Allow extensions to modify form data
914 Hooks
::run( 'EditPage::importFormData', array( $this, $request ) );
919 * Subpage overridable method for extracting the page content data from the
920 * posted form to be placed in $this->textbox1, if using customized input
921 * this method should be overridden and return the page text that will be used
922 * for saving, preview parsing and so on...
924 * @param WebRequest $request
926 protected function importContentFormData( &$request ) {
927 return; // Don't do anything, EditPage already extracted wpTextbox1
931 * Initialise form fields in the object
932 * Called on the first invocation, e.g. when a user clicks an edit link
933 * @return bool If the requested section is valid
935 function initialiseForm() {
937 $this->edittime
= $this->mArticle
->getTimestamp();
939 $content = $this->getContentObject( false ); #TODO: track content object?!
940 if ( $content === false ) {
943 $this->textbox1
= $this->toEditText( $content );
945 // activate checkboxes if user wants them to be always active
946 # Sort out the "watch" checkbox
947 if ( $wgUser->getOption( 'watchdefault' ) ) {
949 $this->watchthis
= true;
950 } elseif ( $wgUser->getOption( 'watchcreations' ) && !$this->mTitle
->exists() ) {
952 $this->watchthis
= true;
953 } elseif ( $wgUser->isWatched( $this->mTitle
) ) {
955 $this->watchthis
= true;
957 if ( $wgUser->getOption( 'minordefault' ) && !$this->isNew
) {
958 $this->minoredit
= true;
960 if ( $this->textbox1
=== false ) {
967 * @param Content|null $def_content The default value to return
969 * @return Content|null Content on success, $def_content for invalid sections
973 protected function getContentObject( $def_content = null ) {
974 global $wgOut, $wgRequest, $wgUser, $wgContLang;
978 // For message page not locally set, use the i18n message.
979 // For other non-existent articles, use preload text if any.
980 if ( !$this->mTitle
->exists() ||
$this->section
== 'new' ) {
981 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
&& $this->section
!= 'new' ) {
982 # If this is a system message, get the default text.
983 $msg = $this->mTitle
->getDefaultMessageText();
985 $content = $this->toEditContent( $msg );
987 if ( $content === false ) {
988 # If requested, preload some text.
989 $preload = $wgRequest->getVal( 'preload',
990 // Custom preload text for new sections
991 $this->section
=== 'new' ?
'MediaWiki:addsection-preload' : '' );
992 $params = $wgRequest->getArray( 'preloadparams', array() );
994 $content = $this->getPreloadedContent( $preload, $params );
996 // For existing pages, get text based on "undo" or section parameters.
998 if ( $this->section
!= '' ) {
999 // Get section edit text (returns $def_text for invalid sections)
1000 $orig = $this->getOriginalContent( $wgUser );
1001 $content = $orig ?
$orig->getSection( $this->section
) : null;
1004 $content = $def_content;
1007 $undoafter = $wgRequest->getInt( 'undoafter' );
1008 $undo = $wgRequest->getInt( 'undo' );
1010 if ( $undo > 0 && $undoafter > 0 ) {
1012 $undorev = Revision
::newFromId( $undo );
1013 $oldrev = Revision
::newFromId( $undoafter );
1015 # Sanity check, make sure it's the right page,
1016 # the revisions exist and they were not deleted.
1017 # Otherwise, $content will be left as-is.
1018 if ( !is_null( $undorev ) && !is_null( $oldrev ) &&
1019 !$undorev->isDeleted( Revision
::DELETED_TEXT
) &&
1020 !$oldrev->isDeleted( Revision
::DELETED_TEXT
) ) {
1022 $content = $this->mArticle
->getUndoContent( $undorev, $oldrev );
1024 if ( $content === false ) {
1025 # Warn the user that something went wrong
1026 $undoMsg = 'failure';
1028 $oldContent = $this->mArticle
->getPage()->getContent( Revision
::RAW
);
1029 $popts = ParserOptions
::newFromUserAndLang( $wgUser, $wgContLang );
1030 $newContent = $content->preSaveTransform( $this->mTitle
, $wgUser, $popts );
1032 if ( $newContent->equals( $oldContent ) ) {
1033 # Tell the user that the undo results in no change,
1034 # i.e. the revisions were already undone.
1035 $undoMsg = 'nochange';
1038 # Inform the user of our success and set an automatic edit summary
1039 $undoMsg = 'success';
1041 # If we just undid one rev, use an autosummary
1042 $firstrev = $oldrev->getNext();
1043 if ( $firstrev && $firstrev->getId() == $undo ) {
1044 $userText = $undorev->getUserText();
1045 if ( $userText === '' ) {
1046 $undoSummary = wfMessage(
1047 'undo-summary-username-hidden',
1049 )->inContentLanguage()->text();
1051 $undoSummary = wfMessage(
1055 )->inContentLanguage()->text();
1057 if ( $this->summary
=== '' ) {
1058 $this->summary
= $undoSummary;
1060 $this->summary
= $undoSummary . wfMessage( 'colon-separator' )
1061 ->inContentLanguage()->text() . $this->summary
;
1063 $this->undidRev
= $undo;
1065 $this->formtype
= 'diff';
1069 // Failed basic sanity checks.
1070 // Older revisions may have been removed since the link
1071 // was created, or we may simply have got bogus input.
1075 // Messages: undo-success, undo-failure, undo-norev, undo-nochange
1076 $class = ( $undoMsg == 'success' ?
'' : 'error ' ) . "mw-undo-{$undoMsg}";
1077 $this->editFormPageTop
.= $wgOut->parse( "<div class=\"{$class}\">" .
1078 wfMessage( 'undo-' . $undoMsg )->plain() . '</div>', true, /* interface */true );
1081 if ( $content === false ) {
1082 $content = $this->getOriginalContent( $wgUser );
1091 * Get the content of the wanted revision, without section extraction.
1093 * The result of this function can be used to compare user's input with
1094 * section replaced in its context (using WikiPage::replaceSection())
1095 * to the original text of the edit.
1097 * This differs from Article::getContent() that when a missing revision is
1098 * encountered the result will be null and not the
1099 * 'missing-revision' message.
1102 * @param User $user The user to get the revision for
1103 * @return Content|null
1105 private function getOriginalContent( User
$user ) {
1106 if ( $this->section
== 'new' ) {
1107 return $this->getCurrentContent();
1109 $revision = $this->mArticle
->getRevisionFetched();
1110 if ( $revision === null ) {
1111 if ( !$this->contentModel
) {
1112 $this->contentModel
= $this->getTitle()->getContentModel();
1114 $handler = ContentHandler
::getForModelID( $this->contentModel
);
1116 return $handler->makeEmptyContent();
1118 $content = $revision->getContent( Revision
::FOR_THIS_USER
, $user );
1123 * Get the current content of the page. This is basically similar to
1124 * WikiPage::getContent( Revision::RAW ) except that when the page doesn't exist an empty
1125 * content object is returned instead of null.
1130 protected function getCurrentContent() {
1131 $rev = $this->mArticle
->getRevision();
1132 $content = $rev ?
$rev->getContent( Revision
::RAW
) : null;
1134 if ( $content === false ||
$content === null ) {
1135 if ( !$this->contentModel
) {
1136 $this->contentModel
= $this->getTitle()->getContentModel();
1138 $handler = ContentHandler
::getForModelID( $this->contentModel
);
1140 return $handler->makeEmptyContent();
1142 # nasty side-effect, but needed for consistency
1143 $this->contentModel
= $rev->getContentModel();
1144 $this->contentFormat
= $rev->getContentFormat();
1151 * Use this method before edit() to preload some content into the edit box
1153 * @param Content $content
1157 public function setPreloadedContent( Content
$content ) {
1158 $this->mPreloadContent
= $content;
1162 * Get the contents to be preloaded into the box, either set by
1163 * an earlier setPreloadText() or by loading the given page.
1165 * @param string $preload Representing the title to preload from.
1166 * @param array $params Parameters to use (interface-message style) in the preloaded text
1172 protected function getPreloadedContent( $preload, $params = array() ) {
1175 if ( !empty( $this->mPreloadContent
) ) {
1176 return $this->mPreloadContent
;
1179 $handler = ContentHandler
::getForTitle( $this->getTitle() );
1181 if ( $preload === '' ) {
1182 return $handler->makeEmptyContent();
1185 $title = Title
::newFromText( $preload );
1186 # Check for existence to avoid getting MediaWiki:Noarticletext
1187 if ( $title === null ||
!$title->exists() ||
!$title->userCan( 'read', $wgUser ) ) {
1188 //TODO: somehow show a warning to the user!
1189 return $handler->makeEmptyContent();
1192 $page = WikiPage
::factory( $title );
1193 if ( $page->isRedirect() ) {
1194 $title = $page->getRedirectTarget();
1196 if ( $title === null ||
!$title->exists() ||
!$title->userCan( 'read', $wgUser ) ) {
1197 //TODO: somehow show a warning to the user!
1198 return $handler->makeEmptyContent();
1200 $page = WikiPage
::factory( $title );
1203 $parserOptions = ParserOptions
::newFromUser( $wgUser );
1204 $content = $page->getContent( Revision
::RAW
);
1207 //TODO: somehow show a warning to the user!
1208 return $handler->makeEmptyContent();
1211 if ( $content->getModel() !== $handler->getModelID() ) {
1212 $converted = $content->convert( $handler->getModelID() );
1214 if ( !$converted ) {
1215 //TODO: somehow show a warning to the user!
1216 wfDebug( "Attempt to preload incompatible content: "
1217 . "can't convert " . $content->getModel()
1218 . " to " . $handler->getModelID() );
1220 return $handler->makeEmptyContent();
1223 $content = $converted;
1226 return $content->preloadTransform( $title, $parserOptions, $params );
1230 * Make sure the form isn't faking a user's credentials.
1232 * @param WebRequest $request
1236 function tokenOk( &$request ) {
1238 $token = $request->getVal( 'wpEditToken' );
1239 $this->mTokenOk
= $wgUser->matchEditToken( $token );
1240 $this->mTokenOkExceptSuffix
= $wgUser->matchEditTokenNoSuffix( $token );
1241 return $this->mTokenOk
;
1245 * Sets post-edit cookie indicating the user just saved a particular revision.
1247 * This uses a temporary cookie for each revision ID so separate saves will never
1248 * interfere with each other.
1250 * The cookie is deleted in the mediawiki.action.view.postEdit JS module after
1251 * the redirect. It must be clearable by JavaScript code, so it must not be
1252 * marked HttpOnly. The JavaScript code converts the cookie to a wgPostEdit config
1255 * If the variable were set on the server, it would be cached, which is unwanted
1256 * since the post-edit state should only apply to the load right after the save.
1258 * @param int $statusValue The status value (to check for new article status)
1260 protected function setPostEditCookie( $statusValue ) {
1261 $revisionId = $this->mArticle
->getLatest();
1262 $postEditKey = self
::POST_EDIT_COOKIE_KEY_PREFIX
. $revisionId;
1265 if ( $statusValue == self
::AS_SUCCESS_NEW_ARTICLE
) {
1267 } elseif ( $this->oldid
) {
1271 $response = RequestContext
::getMain()->getRequest()->response();
1272 $response->setcookie( $postEditKey, $val, time() + self
::POST_EDIT_COOKIE_DURATION
, array(
1273 'httpOnly' => false,
1278 * Attempt submission
1279 * @param array $resultDetails See docs for $result in internalAttemptSave
1280 * @throws UserBlockedError|ReadOnlyError|ThrottledError|PermissionsError
1281 * @return Status The resulting status object.
1283 public function attemptSave( &$resultDetails = false ) {
1286 # Allow bots to exempt some edits from bot flagging
1287 $bot = $wgUser->isAllowed( 'bot' ) && $this->bot
;
1288 $status = $this->internalAttemptSave( $resultDetails, $bot );
1290 Hooks
::run( 'EditPage::attemptSave:after', array( $this, $status, $resultDetails ) );
1296 * Handle status, such as after attempt save
1298 * @param Status $status
1299 * @param array|bool $resultDetails
1301 * @throws ErrorPageError
1302 * @return bool False, if output is done, true if rest of the form should be displayed
1304 private function handleStatus( Status
$status, $resultDetails ) {
1305 global $wgUser, $wgOut;
1308 * @todo FIXME: once the interface for internalAttemptSave() is made
1309 * nicer, this should use the message in $status
1311 if ( $status->value
== self
::AS_SUCCESS_UPDATE
1312 ||
$status->value
== self
::AS_SUCCESS_NEW_ARTICLE
1314 $this->didSave
= true;
1315 if ( !$resultDetails['nullEdit'] ) {
1316 $this->setPostEditCookie( $status->value
);
1320 switch ( $status->value
) {
1321 case self
::AS_HOOK_ERROR_EXPECTED
:
1322 case self
::AS_CONTENT_TOO_BIG
:
1323 case self
::AS_ARTICLE_WAS_DELETED
:
1324 case self
::AS_CONFLICT_DETECTED
:
1325 case self
::AS_SUMMARY_NEEDED
:
1326 case self
::AS_TEXTBOX_EMPTY
:
1327 case self
::AS_MAX_ARTICLE_SIZE_EXCEEDED
:
1329 case self
::AS_BLANK_ARTICLE
:
1330 case self
::AS_SELF_REDIRECT
:
1333 case self
::AS_HOOK_ERROR
:
1336 case self
::AS_PARSE_ERROR
:
1337 $wgOut->addWikiText( '<div class="error">' . $status->getWikiText() . '</div>' );
1340 case self
::AS_SUCCESS_NEW_ARTICLE
:
1341 $query = $resultDetails['redirect'] ?
'redirect=no' : '';
1342 $anchor = isset( $resultDetails['sectionanchor'] ) ?
$resultDetails['sectionanchor'] : '';
1343 $wgOut->redirect( $this->mTitle
->getFullURL( $query ) . $anchor );
1346 case self
::AS_SUCCESS_UPDATE
:
1348 $sectionanchor = $resultDetails['sectionanchor'];
1350 // Give extensions a chance to modify URL query on update
1352 'ArticleUpdateBeforeRedirect',
1353 array( $this->mArticle
, &$sectionanchor, &$extraQuery )
1356 if ( $resultDetails['redirect'] ) {
1357 if ( $extraQuery == '' ) {
1358 $extraQuery = 'redirect=no';
1360 $extraQuery = 'redirect=no&' . $extraQuery;
1363 $wgOut->redirect( $this->mTitle
->getFullURL( $extraQuery ) . $sectionanchor );
1366 case self
::AS_SPAM_ERROR
:
1367 $this->spamPageWithContent( $resultDetails['spam'] );
1370 case self
::AS_BLOCKED_PAGE_FOR_USER
:
1371 throw new UserBlockedError( $wgUser->getBlock() );
1373 case self
::AS_IMAGE_REDIRECT_ANON
:
1374 case self
::AS_IMAGE_REDIRECT_LOGGED
:
1375 throw new PermissionsError( 'upload' );
1377 case self
::AS_READ_ONLY_PAGE_ANON
:
1378 case self
::AS_READ_ONLY_PAGE_LOGGED
:
1379 throw new PermissionsError( 'edit' );
1381 case self
::AS_READ_ONLY_PAGE
:
1382 throw new ReadOnlyError
;
1384 case self
::AS_RATE_LIMITED
:
1385 throw new ThrottledError();
1387 case self
::AS_NO_CREATE_PERMISSION
:
1388 $permission = $this->mTitle
->isTalkPage() ?
'createtalk' : 'createpage';
1389 throw new PermissionsError( $permission );
1391 case self
::AS_NO_CHANGE_CONTENT_MODEL
:
1392 throw new PermissionsError( 'editcontentmodel' );
1395 // We don't recognize $status->value. The only way that can happen
1396 // is if an extension hook aborted from inside ArticleSave.
1397 // Render the status object into $this->hookError
1398 // FIXME this sucks, we should just use the Status object throughout
1399 $this->hookError
= '<div class="error">' . $status->getWikitext() .
1406 * Run hooks that can filter edits just before they get saved.
1408 * @param Content $content The Content to filter.
1409 * @param Status $status For reporting the outcome to the caller
1410 * @param User $user The user performing the edit
1414 protected function runPostMergeFilters( Content
$content, Status
$status, User
$user ) {
1415 // Run old style post-section-merge edit filter
1416 if ( !ContentHandler
::runLegacyHooks( 'EditFilterMerged',
1417 array( $this, $content, &$this->hookError
, $this->summary
) )
1419 # Error messages etc. could be handled within the hook...
1420 $status->fatal( 'hookaborted' );
1421 $status->value
= self
::AS_HOOK_ERROR
;
1423 } elseif ( $this->hookError
!= '' ) {
1424 # ...or the hook could be expecting us to produce an error
1425 $status->fatal( 'hookaborted' );
1426 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1430 // Run new style post-section-merge edit filter
1431 if ( !Hooks
::run( 'EditFilterMergedContent',
1432 array( $this->mArticle
->getContext(), $content, $status, $this->summary
,
1433 $user, $this->minoredit
) )
1435 # Error messages etc. could be handled within the hook...
1436 if ( $status->isGood() ) {
1437 $status->fatal( 'hookaborted' );
1438 // Not setting $this->hookError here is a hack to allow the hook
1439 // to cause a return to the edit page without $this->hookError
1440 // being set. This is used by ConfirmEdit to display a captcha
1441 // without any error message cruft.
1443 $this->hookError
= $status->getWikiText();
1445 // Use the existing $status->value if the hook set it
1446 if ( !$status->value
) {
1447 $status->value
= self
::AS_HOOK_ERROR
;
1450 } elseif ( !$status->isOK() ) {
1451 # ...or the hook could be expecting us to produce an error
1452 // FIXME this sucks, we should just use the Status object throughout
1453 $this->hookError
= $status->getWikiText();
1454 $status->fatal( 'hookaborted' );
1455 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1463 * Return the summary to be used for a new section.
1465 * @param string $sectionanchor Set to the section anchor text
1468 private function newSectionSummary( &$sectionanchor = null ) {
1471 if ( $this->sectiontitle
!== '' ) {
1472 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $this->sectiontitle
);
1473 // If no edit summary was specified, create one automatically from the section
1474 // title and have it link to the new section. Otherwise, respect the summary as
1476 if ( $this->summary
=== '' ) {
1477 $cleanSectionTitle = $wgParser->stripSectionName( $this->sectiontitle
);
1478 return wfMessage( 'newsectionsummary' )
1479 ->rawParams( $cleanSectionTitle )->inContentLanguage()->text();
1481 } elseif ( $this->summary
!== '' ) {
1482 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $this->summary
);
1483 # This is a new section, so create a link to the new section
1484 # in the revision summary.
1485 $cleanSummary = $wgParser->stripSectionName( $this->summary
);
1486 return wfMessage( 'newsectionsummary' )
1487 ->rawParams( $cleanSummary )->inContentLanguage()->text();
1489 return $this->summary
;
1493 * Attempt submission (no UI)
1495 * @param array $result Array to add statuses to, currently with the
1497 * - spam (string): Spam string from content if any spam is detected by
1499 * - sectionanchor (string): Section anchor for a section save.
1500 * - nullEdit (boolean): Set if doEditContent is OK. True if null edit,
1502 * - redirect (bool): Set if doEditContent is OK. True if resulting
1503 * revision is a redirect.
1504 * @param bool $bot True if edit is being made under the bot right.
1506 * @return Status Status object, possibly with a message, but always with
1507 * one of the AS_* constants in $status->value,
1509 * @todo FIXME: This interface is TERRIBLE, but hard to get rid of due to
1510 * various error display idiosyncrasies. There are also lots of cases
1511 * where error metadata is set in the object and retrieved later instead
1512 * of being returned, e.g. AS_CONTENT_TOO_BIG and
1513 * AS_BLOCKED_PAGE_FOR_USER. All that stuff needs to be cleaned up some
1516 function internalAttemptSave( &$result, $bot = false ) {
1517 global $wgUser, $wgRequest, $wgParser, $wgMaxArticleSize;
1519 $status = Status
::newGood();
1521 if ( !Hooks
::run( 'EditPage::attemptSave', array( $this ) ) ) {
1522 wfDebug( "Hook 'EditPage::attemptSave' aborted article saving\n" );
1523 $status->fatal( 'hookaborted' );
1524 $status->value
= self
::AS_HOOK_ERROR
;
1528 $spam = $wgRequest->getText( 'wpAntispam' );
1529 if ( $spam !== '' ) {
1532 $wgUser->getName() .
1534 $this->mTitle
->getPrefixedText() .
1535 '" submitted bogus field "' .
1539 $status->fatal( 'spamprotectionmatch', false );
1540 $status->value
= self
::AS_SPAM_ERROR
;
1545 # Construct Content object
1546 $textbox_content = $this->toEditContent( $this->textbox1
);
1547 } catch ( MWContentSerializationException
$ex ) {
1549 'content-failed-to-parse',
1550 $this->contentModel
,
1551 $this->contentFormat
,
1554 $status->value
= self
::AS_PARSE_ERROR
;
1558 # Check image redirect
1559 if ( $this->mTitle
->getNamespace() == NS_FILE
&&
1560 $textbox_content->isRedirect() &&
1561 !$wgUser->isAllowed( 'upload' )
1563 $code = $wgUser->isAnon() ? self
::AS_IMAGE_REDIRECT_ANON
: self
::AS_IMAGE_REDIRECT_LOGGED
;
1564 $status->setResult( false, $code );
1570 $match = self
::matchSummarySpamRegex( $this->summary
);
1571 if ( $match === false && $this->section
== 'new' ) {
1572 # $wgSpamRegex is enforced on this new heading/summary because, unlike
1573 # regular summaries, it is added to the actual wikitext.
1574 if ( $this->sectiontitle
!== '' ) {
1575 # This branch is taken when the API is used with the 'sectiontitle' parameter.
1576 $match = self
::matchSpamRegex( $this->sectiontitle
);
1578 # This branch is taken when the "Add Topic" user interface is used, or the API
1579 # is used with the 'summary' parameter.
1580 $match = self
::matchSpamRegex( $this->summary
);
1583 if ( $match === false ) {
1584 $match = self
::matchSpamRegex( $this->textbox1
);
1586 if ( $match !== false ) {
1587 $result['spam'] = $match;
1588 $ip = $wgRequest->getIP();
1589 $pdbk = $this->mTitle
->getPrefixedDBkey();
1590 $match = str_replace( "\n", '', $match );
1591 wfDebugLog( 'SpamRegex', "$ip spam regex hit [[$pdbk]]: \"$match\"" );
1592 $status->fatal( 'spamprotectionmatch', $match );
1593 $status->value
= self
::AS_SPAM_ERROR
;
1598 array( $this, $this->textbox1
, $this->section
, &$this->hookError
, $this->summary
) )
1600 # Error messages etc. could be handled within the hook...
1601 $status->fatal( 'hookaborted' );
1602 $status->value
= self
::AS_HOOK_ERROR
;
1604 } elseif ( $this->hookError
!= '' ) {
1605 # ...or the hook could be expecting us to produce an error
1606 $status->fatal( 'hookaborted' );
1607 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1611 if ( $wgUser->isBlockedFrom( $this->mTitle
, false ) ) {
1612 // Auto-block user's IP if the account was "hard" blocked
1613 $wgUser->spreadAnyEditBlock();
1614 # Check block state against master, thus 'false'.
1615 $status->setResult( false, self
::AS_BLOCKED_PAGE_FOR_USER
);
1619 $this->kblength
= (int)( strlen( $this->textbox1
) / 1024 );
1620 if ( $this->kblength
> $wgMaxArticleSize ) {
1621 // Error will be displayed by showEditForm()
1622 $this->tooBig
= true;
1623 $status->setResult( false, self
::AS_CONTENT_TOO_BIG
);
1627 if ( !$wgUser->isAllowed( 'edit' ) ) {
1628 if ( $wgUser->isAnon() ) {
1629 $status->setResult( false, self
::AS_READ_ONLY_PAGE_ANON
);
1632 $status->fatal( 'readonlytext' );
1633 $status->value
= self
::AS_READ_ONLY_PAGE_LOGGED
;
1638 if ( $this->contentModel
!== $this->mTitle
->getContentModel()
1639 && !$wgUser->isAllowed( 'editcontentmodel' )
1641 $status->setResult( false, self
::AS_NO_CHANGE_CONTENT_MODEL
);
1645 if ( wfReadOnly() ) {
1646 $status->fatal( 'readonlytext' );
1647 $status->value
= self
::AS_READ_ONLY_PAGE
;
1650 if ( $wgUser->pingLimiter() ||
$wgUser->pingLimiter( 'linkpurge', 0 ) ) {
1651 $status->fatal( 'actionthrottledtext' );
1652 $status->value
= self
::AS_RATE_LIMITED
;
1656 # If the article has been deleted while editing, don't save it without
1658 if ( $this->wasDeletedSinceLastEdit() && !$this->recreate
) {
1659 $status->setResult( false, self
::AS_ARTICLE_WAS_DELETED
);
1663 # Load the page data from the master. If anything changes in the meantime,
1664 # we detect it by using page_latest like a token in a 1 try compare-and-swap.
1665 $this->mArticle
->loadPageData( 'fromdbmaster' );
1666 $new = !$this->mArticle
->exists();
1669 // Late check for create permission, just in case *PARANOIA*
1670 if ( !$this->mTitle
->userCan( 'create', $wgUser ) ) {
1671 $status->fatal( 'nocreatetext' );
1672 $status->value
= self
::AS_NO_CREATE_PERMISSION
;
1673 wfDebug( __METHOD__
. ": no create permission\n" );
1677 // Don't save a new page if it's blank or if it's a MediaWiki:
1678 // message with content equivalent to default (allow empty pages
1679 // in this case to disable messages, see bug 50124)
1680 $defaultMessageText = $this->mTitle
->getDefaultMessageText();
1681 if ( $this->mTitle
->getNamespace() === NS_MEDIAWIKI
&& $defaultMessageText !== false ) {
1682 $defaultText = $defaultMessageText;
1687 if ( !$this->allowBlankArticle
&& $this->textbox1
=== $defaultText ) {
1688 $this->blankArticle
= true;
1689 $status->fatal( 'blankarticle' );
1690 $status->setResult( false, self
::AS_BLANK_ARTICLE
);
1694 if ( !$this->runPostMergeFilters( $textbox_content, $status, $wgUser ) ) {
1698 $content = $textbox_content;
1700 $result['sectionanchor'] = '';
1701 if ( $this->section
== 'new' ) {
1702 if ( $this->sectiontitle
!== '' ) {
1703 // Insert the section title above the content.
1704 $content = $content->addSectionHeader( $this->sectiontitle
);
1705 } elseif ( $this->summary
!== '' ) {
1706 // Insert the section title above the content.
1707 $content = $content->addSectionHeader( $this->summary
);
1709 $this->summary
= $this->newSectionSummary( $result['sectionanchor'] );
1712 $status->value
= self
::AS_SUCCESS_NEW_ARTICLE
;
1716 # Article exists. Check for edit conflict.
1718 $this->mArticle
->clear(); # Force reload of dates, etc.
1719 $timestamp = $this->mArticle
->getTimestamp();
1721 wfDebug( "timestamp: {$timestamp}, edittime: {$this->edittime}\n" );
1723 if ( $timestamp != $this->edittime
) {
1724 $this->isConflict
= true;
1725 if ( $this->section
== 'new' ) {
1726 if ( $this->mArticle
->getUserText() == $wgUser->getName() &&
1727 $this->mArticle
->getComment() == $this->newSectionSummary()
1729 // Probably a duplicate submission of a new comment.
1730 // This can happen when squid resends a request after
1731 // a timeout but the first one actually went through.
1733 . ": duplicate new section submission; trigger edit conflict!\n" );
1735 // New comment; suppress conflict.
1736 $this->isConflict
= false;
1737 wfDebug( __METHOD__
. ": conflict suppressed; new section\n" );
1739 } elseif ( $this->section
== ''
1740 && Revision
::userWasLastToEdit(
1741 DB_MASTER
, $this->mTitle
->getArticleID(),
1742 $wgUser->getId(), $this->edittime
1745 # Suppress edit conflict with self, except for section edits where merging is required.
1746 wfDebug( __METHOD__
. ": Suppressing edit conflict, same user.\n" );
1747 $this->isConflict
= false;
1751 // If sectiontitle is set, use it, otherwise use the summary as the section title.
1752 if ( $this->sectiontitle
!== '' ) {
1753 $sectionTitle = $this->sectiontitle
;
1755 $sectionTitle = $this->summary
;
1760 if ( $this->isConflict
) {
1762 . ": conflict! getting section '{$this->section}' for time '{$this->edittime}'"
1763 . " (article time '{$timestamp}')\n" );
1765 $content = $this->mArticle
->replaceSectionContent(
1772 wfDebug( __METHOD__
. ": getting section '{$this->section}'\n" );
1773 $content = $this->mArticle
->replaceSectionContent(
1780 if ( is_null( $content ) ) {
1781 wfDebug( __METHOD__
. ": activating conflict; section replace failed.\n" );
1782 $this->isConflict
= true;
1783 $content = $textbox_content; // do not try to merge here!
1784 } elseif ( $this->isConflict
) {
1786 if ( $this->mergeChangesIntoContent( $content ) ) {
1787 // Successful merge! Maybe we should tell the user the good news?
1788 $this->isConflict
= false;
1789 wfDebug( __METHOD__
. ": Suppressing edit conflict, successful merge.\n" );
1791 $this->section
= '';
1792 $this->textbox1
= ContentHandler
::getContentText( $content );
1793 wfDebug( __METHOD__
. ": Keeping edit conflict, failed merge.\n" );
1797 if ( $this->isConflict
) {
1798 $status->setResult( false, self
::AS_CONFLICT_DETECTED
);
1802 if ( !$this->runPostMergeFilters( $content, $status, $wgUser ) ) {
1806 if ( $this->section
== 'new' ) {
1807 // Handle the user preference to force summaries here
1808 if ( !$this->allowBlankSummary
&& trim( $this->summary
) == '' ) {
1809 $this->missingSummary
= true;
1810 $status->fatal( 'missingsummary' ); // or 'missingcommentheader' if $section == 'new'. Blegh
1811 $status->value
= self
::AS_SUMMARY_NEEDED
;
1815 // Do not allow the user to post an empty comment
1816 if ( $this->textbox1
== '' ) {
1817 $this->missingComment
= true;
1818 $status->fatal( 'missingcommenttext' );
1819 $status->value
= self
::AS_TEXTBOX_EMPTY
;
1822 } elseif ( !$this->allowBlankSummary
1823 && !$content->equals( $this->getOriginalContent( $wgUser ) )
1824 && !$content->isRedirect()
1825 && md5( $this->summary
) == $this->autoSumm
1827 $this->missingSummary
= true;
1828 $status->fatal( 'missingsummary' );
1829 $status->value
= self
::AS_SUMMARY_NEEDED
;
1834 $sectionanchor = '';
1835 if ( $this->section
== 'new' ) {
1836 $this->summary
= $this->newSectionSummary( $sectionanchor );
1837 } elseif ( $this->section
!= '' ) {
1838 # Try to get a section anchor from the section source, redirect
1839 # to edited section if header found.
1840 # XXX: Might be better to integrate this into Article::replaceSection
1841 # for duplicate heading checking and maybe parsing.
1842 $hasmatch = preg_match( "/^ *([=]{1,6})(.*?)(\\1) *\\n/i", $this->textbox1
, $matches );
1843 # We can't deal with anchors, includes, html etc in the header for now,
1844 # headline would need to be parsed to improve this.
1845 if ( $hasmatch && strlen( $matches[2] ) > 0 ) {
1846 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $matches[2] );
1849 $result['sectionanchor'] = $sectionanchor;
1851 // Save errors may fall down to the edit form, but we've now
1852 // merged the section into full text. Clear the section field
1853 // so that later submission of conflict forms won't try to
1854 // replace that into a duplicated mess.
1855 $this->textbox1
= $this->toEditText( $content );
1856 $this->section
= '';
1858 $status->value
= self
::AS_SUCCESS_UPDATE
;
1861 if ( !$this->allowSelfRedirect
1862 && $content->isRedirect()
1863 && $content->getRedirectTarget()->equals( $this->getTitle() )
1865 // If the page already redirects to itself, don't warn.
1866 $currentTarget = $this->getCurrentContent()->getRedirectTarget();
1867 if ( !$currentTarget ||
!$currentTarget->equals( $this->getTitle() ) ) {
1868 $this->selfRedirect
= true;
1869 $status->fatal( 'selfredirect' );
1870 $status->value
= self
::AS_SELF_REDIRECT
;
1875 // Check for length errors again now that the section is merged in
1876 $this->kblength
= (int)( strlen( $this->toEditText( $content ) ) / 1024 );
1877 if ( $this->kblength
> $wgMaxArticleSize ) {
1878 $this->tooBig
= true;
1879 $status->setResult( false, self
::AS_MAX_ARTICLE_SIZE_EXCEEDED
);
1883 $flags = EDIT_DEFER_UPDATES | EDIT_AUTOSUMMARY |
1884 ( $new ? EDIT_NEW
: EDIT_UPDATE
) |
1885 ( ( $this->minoredit
&& !$this->isNew
) ? EDIT_MINOR
: 0 ) |
1886 ( $bot ? EDIT_FORCE_BOT
: 0 );
1888 $doEditStatus = $this->mArticle
->doEditContent(
1894 $content->getDefaultFormat()
1897 if ( !$doEditStatus->isOK() ) {
1898 // Failure from doEdit()
1899 // Show the edit conflict page for certain recognized errors from doEdit(),
1900 // but don't show it for errors from extension hooks
1901 $errors = $doEditStatus->getErrorsArray();
1902 if ( in_array( $errors[0][0],
1903 array( 'edit-gone-missing', 'edit-conflict', 'edit-already-exists' ) )
1905 $this->isConflict
= true;
1906 // Destroys data doEdit() put in $status->value but who cares
1907 $doEditStatus->value
= self
::AS_END
;
1909 return $doEditStatus;
1912 $result['nullEdit'] = $doEditStatus->hasMessage( 'edit-no-change' );
1913 if ( $result['nullEdit'] ) {
1914 // We don't know if it was a null edit until now, so increment here
1915 $wgUser->pingLimiter( 'linkpurge' );
1917 $result['redirect'] = $content->isRedirect();
1918 $this->updateWatchlist();
1923 * Register the change of watch status
1925 protected function updateWatchlist() {
1928 if ( $wgUser->isLoggedIn()
1929 && $this->watchthis
!= $wgUser->isWatched( $this->mTitle
, WatchedItem
::IGNORE_USER_RIGHTS
)
1931 $fname = __METHOD__
;
1932 $title = $this->mTitle
;
1933 $watch = $this->watchthis
;
1935 // Do this in its own transaction to reduce contention...
1936 $dbw = wfGetDB( DB_MASTER
);
1937 $dbw->onTransactionIdle( function () use ( $dbw, $title, $watch, $wgUser, $fname ) {
1938 WatchAction
::doWatchOrUnwatch( $watch, $title, $wgUser );
1944 * Attempts to do 3-way merge of edit content with a base revision
1945 * and current content, in case of edit conflict, in whichever way appropriate
1946 * for the content type.
1950 * @param Content $editContent
1954 private function mergeChangesIntoContent( &$editContent ) {
1956 $db = wfGetDB( DB_MASTER
);
1958 // This is the revision the editor started from
1959 $baseRevision = $this->getBaseRevision();
1960 $baseContent = $baseRevision ?
$baseRevision->getContent() : null;
1962 if ( is_null( $baseContent ) ) {
1966 // The current state, we want to merge updates into it
1967 $currentRevision = Revision
::loadFromTitle( $db, $this->mTitle
);
1968 $currentContent = $currentRevision ?
$currentRevision->getContent() : null;
1970 if ( is_null( $currentContent ) ) {
1974 $handler = ContentHandler
::getForModelID( $baseContent->getModel() );
1976 $result = $handler->merge3( $baseContent, $editContent, $currentContent );
1979 $editContent = $result;
1989 function getBaseRevision() {
1990 if ( !$this->mBaseRevision
) {
1991 $db = wfGetDB( DB_MASTER
);
1992 $this->mBaseRevision
= Revision
::loadFromTimestamp(
1993 $db, $this->mTitle
, $this->edittime
);
1995 return $this->mBaseRevision
;
1999 * Check given input text against $wgSpamRegex, and return the text of the first match.
2001 * @param string $text
2003 * @return string|bool Matching string or false
2005 public static function matchSpamRegex( $text ) {
2006 global $wgSpamRegex;
2007 // For back compatibility, $wgSpamRegex may be a single string or an array of regexes.
2008 $regexes = (array)$wgSpamRegex;
2009 return self
::matchSpamRegexInternal( $text, $regexes );
2013 * Check given input text against $wgSummarySpamRegex, and return the text of the first match.
2015 * @param string $text
2017 * @return string|bool Matching string or false
2019 public static function matchSummarySpamRegex( $text ) {
2020 global $wgSummarySpamRegex;
2021 $regexes = (array)$wgSummarySpamRegex;
2022 return self
::matchSpamRegexInternal( $text, $regexes );
2026 * @param string $text
2027 * @param array $regexes
2028 * @return bool|string
2030 protected static function matchSpamRegexInternal( $text, $regexes ) {
2031 foreach ( $regexes as $regex ) {
2033 if ( preg_match( $regex, $text, $matches ) ) {
2040 function setHeaders() {
2041 global $wgOut, $wgUser, $wgAjaxEditStash;
2043 $wgOut->addModules( 'mediawiki.action.edit' );
2044 $wgOut->addModuleStyles( 'mediawiki.action.edit.styles' );
2046 if ( $wgUser->getOption( 'showtoolbar' ) ) {
2047 // The addition of default buttons is handled by getEditToolbar() which
2048 // has its own dependency on this module. The call here ensures the module
2049 // is loaded in time (it has position "top") for other modules to register
2050 // buttons (e.g. extensions, gadgets, user scripts).
2051 $wgOut->addModules( 'mediawiki.toolbar' );
2054 if ( $wgUser->getOption( 'uselivepreview' ) ) {
2055 $wgOut->addModules( 'mediawiki.action.edit.preview' );
2058 if ( $wgUser->getOption( 'useeditwarning' ) ) {
2059 $wgOut->addModules( 'mediawiki.action.edit.editWarning' );
2062 if ( $wgAjaxEditStash ) {
2063 $wgOut->addModules( 'mediawiki.action.edit.stash' );
2066 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2068 # Enabled article-related sidebar, toplinks, etc.
2069 $wgOut->setArticleRelated( true );
2071 $contextTitle = $this->getContextTitle();
2072 if ( $this->isConflict
) {
2073 $msg = 'editconflict';
2074 } elseif ( $contextTitle->exists() && $this->section
!= '' ) {
2075 $msg = $this->section
== 'new' ?
'editingcomment' : 'editingsection';
2077 $msg = $contextTitle->exists()
2078 ||
( $contextTitle->getNamespace() == NS_MEDIAWIKI
2079 && $contextTitle->getDefaultMessageText() !== false
2085 # Use the title defined by DISPLAYTITLE magic word when present
2086 $displayTitle = isset( $this->mParserOutput
) ?
$this->mParserOutput
->getDisplayTitle() : false;
2087 if ( $displayTitle === false ) {
2088 $displayTitle = $contextTitle->getPrefixedText();
2090 $wgOut->setPageTitle( wfMessage( $msg, $displayTitle ) );
2091 # Transmit the name of the message to JavaScript for live preview
2092 # Keep Resources.php/mediawiki.action.edit.preview in sync with the possible keys
2093 $wgOut->addJsConfigVars( 'wgEditMessage', $msg );
2097 * Show all applicable editing introductions
2099 protected function showIntro() {
2100 global $wgOut, $wgUser;
2101 if ( $this->suppressIntro
) {
2105 $namespace = $this->mTitle
->getNamespace();
2107 if ( $namespace == NS_MEDIAWIKI
) {
2108 # Show a warning if editing an interface message
2109 $wgOut->wrapWikiMsg( "<div class='mw-editinginterface'>\n$1\n</div>", 'editinginterface' );
2110 # If this is a default message (but not css or js),
2111 # show a hint that it is translatable on translatewiki.net
2112 if ( !$this->mTitle
->hasContentModel( CONTENT_MODEL_CSS
)
2113 && !$this->mTitle
->hasContentModel( CONTENT_MODEL_JAVASCRIPT
)
2115 $defaultMessageText = $this->mTitle
->getDefaultMessageText();
2116 if ( $defaultMessageText !== false ) {
2117 $wgOut->wrapWikiMsg( "<div class='mw-translateinterface'>\n$1\n</div>",
2118 'translateinterface' );
2121 } elseif ( $namespace == NS_FILE
) {
2122 # Show a hint to shared repo
2123 $file = wfFindFile( $this->mTitle
);
2124 if ( $file && !$file->isLocal() ) {
2125 $descUrl = $file->getDescriptionUrl();
2126 # there must be a description url to show a hint to shared repo
2128 if ( !$this->mTitle
->exists() ) {
2129 $wgOut->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-create\">\n$1\n</div>", array(
2130 'sharedupload-desc-create', $file->getRepo()->getDisplayName(), $descUrl
2133 $wgOut->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-edit\">\n$1\n</div>", array(
2134 'sharedupload-desc-edit', $file->getRepo()->getDisplayName(), $descUrl
2141 # Show a warning message when someone creates/edits a user (talk) page but the user does not exist
2142 # Show log extract when the user is currently blocked
2143 if ( $namespace == NS_USER ||
$namespace == NS_USER_TALK
) {
2144 $parts = explode( '/', $this->mTitle
->getText(), 2 );
2145 $username = $parts[0];
2146 $user = User
::newFromName( $username, false /* allow IP users*/ );
2147 $ip = User
::isIP( $username );
2148 $block = Block
::newFromTarget( $user, $user );
2149 if ( !( $user && $user->isLoggedIn() ) && !$ip ) { # User does not exist
2150 $wgOut->wrapWikiMsg( "<div class=\"mw-userpage-userdoesnotexist error\">\n$1\n</div>",
2151 array( 'userpage-userdoesnotexist', wfEscapeWikiText( $username ) ) );
2152 } elseif ( !is_null( $block ) && $block->getType() != Block
::TYPE_AUTO
) {
2153 # Show log extract if the user is currently blocked
2154 LogEventsList
::showLogExtract(
2157 MWNamespace
::getCanonicalName( NS_USER
) . ':' . $block->getTarget(),
2161 'showIfEmpty' => false,
2163 'blocked-notice-logextract',
2164 $user->getName() # Support GENDER in notice
2170 # Try to add a custom edit intro, or use the standard one if this is not possible.
2171 if ( !$this->showCustomIntro() && !$this->mTitle
->exists() ) {
2172 $helpLink = wfExpandUrl( Skin
::makeInternalOrExternalUrl(
2173 wfMessage( 'helppage' )->inContentLanguage()->text()
2175 if ( $wgUser->isLoggedIn() ) {
2176 $wgOut->wrapWikiMsg(
2177 // Suppress the external link icon, consider the help url an internal one
2178 "<div class=\"mw-newarticletext plainlinks\">\n$1\n</div>",
2185 $wgOut->wrapWikiMsg(
2186 // Suppress the external link icon, consider the help url an internal one
2187 "<div class=\"mw-newarticletextanon plainlinks\">\n$1\n</div>",
2189 'newarticletextanon',
2195 # Give a notice if the user is editing a deleted/moved page...
2196 if ( !$this->mTitle
->exists() ) {
2197 LogEventsList
::showLogExtract( $wgOut, array( 'delete', 'move' ), $this->mTitle
,
2201 'conds' => array( "log_action != 'revision'" ),
2202 'showIfEmpty' => false,
2203 'msgKey' => array( 'recreate-moveddeleted-warn' )
2210 * Attempt to show a custom editing introduction, if supplied
2214 protected function showCustomIntro() {
2215 if ( $this->editintro
) {
2216 $title = Title
::newFromText( $this->editintro
);
2217 if ( $title instanceof Title
&& $title->exists() && $title->userCan( 'read' ) ) {
2219 // Added using template syntax, to take <noinclude>'s into account.
2220 $wgOut->addWikiTextTitleTidy(
2221 '<div class="mw-editintro">{{:' . $title->getFullText() . '}}</div>',
2231 * Gets an editable textual representation of $content.
2232 * The textual representation can be turned by into a Content object by the
2233 * toEditContent() method.
2235 * If $content is null or false or a string, $content is returned unchanged.
2237 * If the given Content object is not of a type that can be edited using
2238 * the text base EditPage, an exception will be raised. Set
2239 * $this->allowNonTextContent to true to allow editing of non-textual
2242 * @param Content|null|bool|string $content
2243 * @return string The editable text form of the content.
2245 * @throws MWException If $content is not an instance of TextContent and
2246 * $this->allowNonTextContent is not true.
2248 protected function toEditText( $content ) {
2249 if ( $content === null ||
$content === false ||
is_string( $content ) ) {
2253 if ( !$this->isSupportedContentModel( $content->getModel() ) ) {
2254 throw new MWException( 'This content model is not supported: '
2255 . ContentHandler
::getLocalizedName( $content->getModel() ) );
2258 return $content->serialize( $this->contentFormat
);
2262 * Turns the given text into a Content object by unserializing it.
2264 * If the resulting Content object is not of a type that can be edited using
2265 * the text base EditPage, an exception will be raised. Set
2266 * $this->allowNonTextContent to true to allow editing of non-textual
2269 * @param string|null|bool $text Text to unserialize
2270 * @return Content The content object created from $text. If $text was false
2271 * or null, false resp. null will be returned instead.
2273 * @throws MWException If unserializing the text results in a Content
2274 * object that is not an instance of TextContent and
2275 * $this->allowNonTextContent is not true.
2277 protected function toEditContent( $text ) {
2278 if ( $text === false ||
$text === null ) {
2282 $content = ContentHandler
::makeContent( $text, $this->getTitle(),
2283 $this->contentModel
, $this->contentFormat
);
2285 if ( !$this->isSupportedContentModel( $content->getModel() ) ) {
2286 throw new MWException( 'This content model is not supported: '
2287 . ContentHandler
::getLocalizedName( $content->getModel() ) );
2294 * Send the edit form and related headers to $wgOut
2295 * @param callable|null $formCallback That takes an OutputPage parameter; will be called
2296 * during form output near the top, for captchas and the like.
2298 * The $formCallback parameter is deprecated since MediaWiki 1.25. Please
2299 * use the EditPage::showEditForm:fields hook instead.
2301 function showEditForm( $formCallback = null ) {
2302 global $wgOut, $wgUser;
2304 # need to parse the preview early so that we know which templates are used,
2305 # otherwise users with "show preview after edit box" will get a blank list
2306 # we parse this near the beginning so that setHeaders can do the title
2307 # setting work instead of leaving it in getPreviewText
2308 $previewOutput = '';
2309 if ( $this->formtype
== 'preview' ) {
2310 $previewOutput = $this->getPreviewText();
2313 Hooks
::run( 'EditPage::showEditForm:initial', array( &$this, &$wgOut ) );
2315 $this->setHeaders();
2317 if ( $this->showHeader() === false ) {
2321 $wgOut->addHTML( $this->editFormPageTop
);
2323 if ( $wgUser->getOption( 'previewontop' ) ) {
2324 $this->displayPreviewArea( $previewOutput, true );
2327 $wgOut->addHTML( $this->editFormTextTop
);
2329 $showToolbar = true;
2330 if ( $this->wasDeletedSinceLastEdit() ) {
2331 if ( $this->formtype
== 'save' ) {
2332 // Hide the toolbar and edit area, user can click preview to get it back
2333 // Add an confirmation checkbox and explanation.
2334 $showToolbar = false;
2336 $wgOut->wrapWikiMsg( "<div class='error mw-deleted-while-editing'>\n$1\n</div>",
2337 'deletedwhileediting' );
2341 // @todo add EditForm plugin interface and use it here!
2342 // search for textarea1 and textares2, and allow EditForm to override all uses.
2343 $wgOut->addHTML( Html
::openElement(
2346 'id' => self
::EDITFORM_ID
,
2347 'name' => self
::EDITFORM_ID
,
2349 'action' => $this->getActionURL( $this->getContextTitle() ),
2350 'enctype' => 'multipart/form-data'
2354 if ( is_callable( $formCallback ) ) {
2355 wfWarn( 'The $formCallback parameter to ' . __METHOD__
. 'is deprecated' );
2356 call_user_func_array( $formCallback, array( &$wgOut ) );
2359 // Add an empty field to trip up spambots
2361 Xml
::openElement( 'div', array( 'id' => 'antispam-container', 'style' => 'display: none;' ) )
2364 array( 'for' => 'wpAntiSpam' ),
2365 wfMessage( 'simpleantispam-label' )->parse()
2371 'name' => 'wpAntispam',
2372 'id' => 'wpAntispam',
2376 . Xml
::closeElement( 'div' )
2379 Hooks
::run( 'EditPage::showEditForm:fields', array( &$this, &$wgOut ) );
2381 // Put these up at the top to ensure they aren't lost on early form submission
2382 $this->showFormBeforeText();
2384 if ( $this->wasDeletedSinceLastEdit() && 'save' == $this->formtype
) {
2385 $username = $this->lastDelete
->user_name
;
2386 $comment = $this->lastDelete
->log_comment
;
2388 // It is better to not parse the comment at all than to have templates expanded in the middle
2389 // TODO: can the checkLabel be moved outside of the div so that wrapWikiMsg could be used?
2390 $key = $comment === ''
2391 ?
'confirmrecreate-noreason'
2392 : 'confirmrecreate';
2394 '<div class="mw-confirm-recreate">' .
2395 wfMessage( $key, $username, "<nowiki>$comment</nowiki>" )->parse() .
2396 Xml
::checkLabel( wfMessage( 'recreate' )->text(), 'wpRecreate', 'wpRecreate', false,
2397 array( 'title' => Linker
::titleAttrib( 'recreate' ), 'tabindex' => 1, 'id' => 'wpRecreate' )
2403 # When the summary is hidden, also hide them on preview/show changes
2404 if ( $this->nosummary
) {
2405 $wgOut->addHTML( Html
::hidden( 'nosummary', true ) );
2408 # If a blank edit summary was previously provided, and the appropriate
2409 # user preference is active, pass a hidden tag as wpIgnoreBlankSummary. This will stop the
2410 # user being bounced back more than once in the event that a summary
2413 # For a bit more sophisticated detection of blank summaries, hash the
2414 # automatic one and pass that in the hidden field wpAutoSummary.
2415 if ( $this->missingSummary ||
( $this->section
== 'new' && $this->nosummary
) ) {
2416 $wgOut->addHTML( Html
::hidden( 'wpIgnoreBlankSummary', true ) );
2419 if ( $this->undidRev
) {
2420 $wgOut->addHTML( Html
::hidden( 'wpUndidRevision', $this->undidRev
) );
2423 if ( $this->selfRedirect
) {
2424 $wgOut->addHTML( Html
::hidden( 'wpIgnoreSelfRedirect', true ) );
2427 if ( $this->hasPresetSummary
) {
2428 // If a summary has been preset using &summary= we don't want to prompt for
2429 // a different summary. Only prompt for a summary if the summary is blanked.
2431 $this->autoSumm
= md5( '' );
2434 $autosumm = $this->autoSumm ?
$this->autoSumm
: md5( $this->summary
);
2435 $wgOut->addHTML( Html
::hidden( 'wpAutoSummary', $autosumm ) );
2437 $wgOut->addHTML( Html
::hidden( 'oldid', $this->oldid
) );
2438 $wgOut->addHTML( Html
::hidden( 'parentRevId',
2439 $this->parentRevId ?
: $this->mArticle
->getRevIdFetched() ) );
2441 $wgOut->addHTML( Html
::hidden( 'format', $this->contentFormat
) );
2442 $wgOut->addHTML( Html
::hidden( 'model', $this->contentModel
) );
2444 if ( $this->section
== 'new' ) {
2445 $this->showSummaryInput( true, $this->summary
);
2446 $wgOut->addHTML( $this->getSummaryPreview( true, $this->summary
) );
2449 $wgOut->addHTML( $this->editFormTextBeforeContent
);
2451 if ( !$this->isCssJsSubpage
&& $showToolbar && $wgUser->getOption( 'showtoolbar' ) ) {
2452 $wgOut->addHTML( EditPage
::getEditToolbar() );
2455 if ( $this->blankArticle
) {
2456 $wgOut->addHTML( Html
::hidden( 'wpIgnoreBlankArticle', true ) );
2459 if ( $this->isConflict
) {
2460 // In an edit conflict bypass the overridable content form method
2461 // and fallback to the raw wpTextbox1 since editconflicts can't be
2462 // resolved between page source edits and custom ui edits using the
2464 $this->textbox2
= $this->textbox1
;
2466 $content = $this->getCurrentContent();
2467 $this->textbox1
= $this->toEditText( $content );
2469 $this->showTextbox1();
2471 $this->showContentForm();
2474 $wgOut->addHTML( $this->editFormTextAfterContent
);
2476 $this->showStandardInputs();
2478 $this->showFormAfterText();
2480 $this->showTosSummary();
2482 $this->showEditTools();
2484 $wgOut->addHTML( $this->editFormTextAfterTools
. "\n" );
2486 $wgOut->addHTML( Html
::rawElement( 'div', array( 'class' => 'templatesUsed' ),
2487 Linker
::formatTemplates( $this->getTemplates(), $this->preview
, $this->section
!= '' ) ) );
2489 $wgOut->addHTML( Html
::rawElement( 'div', array( 'class' => 'hiddencats' ),
2490 Linker
::formatHiddenCategories( $this->mArticle
->getHiddenCategories() ) ) );
2492 $wgOut->addHTML( Html
::rawElement( 'div', array( 'class' => 'limitreport' ),
2493 self
::getPreviewLimitReport( $this->mParserOutput
) ) );
2495 $wgOut->addModules( 'mediawiki.action.edit.collapsibleFooter' );
2497 if ( $this->isConflict
) {
2499 $this->showConflict();
2500 } catch ( MWContentSerializationException
$ex ) {
2501 // this can't really happen, but be nice if it does.
2503 'content-failed-to-parse',
2504 $this->contentModel
,
2505 $this->contentFormat
,
2508 $wgOut->addWikiText( '<div class="error">' . $msg->text() . '</div>' );
2512 // Marker for detecting truncated form data. This must be the last
2513 // parameter sent in order to be of use, so do not move me.
2514 $wgOut->addHTML( Html
::hidden( 'wpUltimateParam', true ) );
2515 $wgOut->addHTML( $this->editFormTextBottom
. "\n</form>\n" );
2517 if ( !$wgUser->getOption( 'previewontop' ) ) {
2518 $this->displayPreviewArea( $previewOutput, false );
2524 * Extract the section title from current section text, if any.
2526 * @param string $text
2527 * @return string|bool String or false
2529 public static function extractSectionTitle( $text ) {
2530 preg_match( "/^(=+)(.+)\\1\\s*(\n|$)/i", $text, $matches );
2531 if ( !empty( $matches[2] ) ) {
2533 return $wgParser->stripSectionName( trim( $matches[2] ) );
2542 protected function showHeader() {
2543 global $wgOut, $wgUser, $wgMaxArticleSize, $wgLang;
2544 global $wgAllowUserCss, $wgAllowUserJs;
2546 if ( $this->mTitle
->isTalkPage() ) {
2547 $wgOut->addWikiMsg( 'talkpagetext' );
2551 $editNotices = $this->mTitle
->getEditNotices( $this->oldid
);
2552 if ( count( $editNotices ) ) {
2553 $wgOut->addHTML( implode( "\n", $editNotices ) );
2555 $msg = wfMessage( 'editnotice-notext' );
2556 if ( !$msg->isDisabled() ) {
2558 '<div class="mw-editnotice-notext">'
2559 . $msg->parseAsBlock()
2565 if ( $this->isConflict
) {
2566 $wgOut->wrapWikiMsg( "<div class='mw-explainconflict'>\n$1\n</div>", 'explainconflict' );
2567 $this->edittime
= $this->mArticle
->getTimestamp();
2569 if ( $this->section
!= '' && !$this->isSectionEditSupported() ) {
2570 // We use $this->section to much before this and getVal('wgSection') directly in other places
2571 // at this point we can't reset $this->section to '' to fallback to non-section editing.
2572 // Someone is welcome to try refactoring though
2573 $wgOut->showErrorPage( 'sectioneditnotsupported-title', 'sectioneditnotsupported-text' );
2577 if ( $this->section
!= '' && $this->section
!= 'new' ) {
2578 if ( !$this->summary
&& !$this->preview
&& !$this->diff
) {
2579 $sectionTitle = self
::extractSectionTitle( $this->textbox1
); //FIXME: use Content object
2580 if ( $sectionTitle !== false ) {
2581 $this->summary
= "/* $sectionTitle */ ";
2586 if ( $this->missingComment
) {
2587 $wgOut->wrapWikiMsg( "<div id='mw-missingcommenttext'>\n$1\n</div>", 'missingcommenttext' );
2590 if ( $this->missingSummary
&& $this->section
!= 'new' ) {
2591 $wgOut->wrapWikiMsg( "<div id='mw-missingsummary'>\n$1\n</div>", 'missingsummary' );
2594 if ( $this->missingSummary
&& $this->section
== 'new' ) {
2595 $wgOut->wrapWikiMsg( "<div id='mw-missingcommentheader'>\n$1\n</div>", 'missingcommentheader' );
2598 if ( $this->blankArticle
) {
2599 $wgOut->wrapWikiMsg( "<div id='mw-blankarticle'>\n$1\n</div>", 'blankarticle' );
2602 if ( $this->selfRedirect
) {
2603 $wgOut->wrapWikiMsg( "<div id='mw-selfredirect'>\n$1\n</div>", 'selfredirect' );
2606 if ( $this->hookError
!== '' ) {
2607 $wgOut->addWikiText( $this->hookError
);
2610 if ( !$this->checkUnicodeCompliantBrowser() ) {
2611 $wgOut->addWikiMsg( 'nonunicodebrowser' );
2614 if ( $this->section
!= 'new' ) {
2615 $revision = $this->mArticle
->getRevisionFetched();
2617 // Let sysop know that this will make private content public if saved
2619 if ( !$revision->userCan( Revision
::DELETED_TEXT
, $wgUser ) ) {
2620 $wgOut->wrapWikiMsg(
2621 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
2622 'rev-deleted-text-permission'
2624 } elseif ( $revision->isDeleted( Revision
::DELETED_TEXT
) ) {
2625 $wgOut->wrapWikiMsg(
2626 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
2627 'rev-deleted-text-view'
2631 if ( !$revision->isCurrent() ) {
2632 $this->mArticle
->setOldSubtitle( $revision->getId() );
2633 $wgOut->addWikiMsg( 'editingold' );
2635 } elseif ( $this->mTitle
->exists() ) {
2636 // Something went wrong
2638 $wgOut->wrapWikiMsg( "<div class='errorbox'>\n$1\n</div>\n",
2639 array( 'missing-revision', $this->oldid
) );
2644 if ( wfReadOnly() ) {
2645 $wgOut->wrapWikiMsg(
2646 "<div id=\"mw-read-only-warning\">\n$1\n</div>",
2647 array( 'readonlywarning', wfReadOnlyReason() )
2649 } elseif ( $wgUser->isAnon() ) {
2650 if ( $this->formtype
!= 'preview' ) {
2651 $wgOut->wrapWikiMsg(
2652 "<div id='mw-anon-edit-warning'>\n$1\n</div>",
2653 array( 'anoneditwarning',
2655 '{{fullurl:Special:UserLogin|returnto={{FULLPAGENAMEE}}}}',
2657 '{{fullurl:Special:UserLogin/signup|returnto={{FULLPAGENAMEE}}}}' )
2660 $wgOut->wrapWikiMsg( "<div id=\"mw-anon-preview-warning\">\n$1</div>",
2661 'anonpreviewwarning'
2665 if ( $this->isCssJsSubpage
) {
2666 # Check the skin exists
2667 if ( $this->isWrongCaseCssJsPage
) {
2668 $wgOut->wrapWikiMsg(
2669 "<div class='error' id='mw-userinvalidcssjstitle'>\n$1\n</div>",
2670 array( 'userinvalidcssjstitle', $this->mTitle
->getSkinFromCssJsSubpage() )
2673 if ( $this->formtype
!== 'preview' ) {
2674 if ( $this->isCssSubpage
&& $wgAllowUserCss ) {
2675 $wgOut->wrapWikiMsg(
2676 "<div id='mw-usercssyoucanpreview'>\n$1\n</div>",
2677 array( 'usercssyoucanpreview' )
2681 if ( $this->isJsSubpage
&& $wgAllowUserJs ) {
2682 $wgOut->wrapWikiMsg(
2683 "<div id='mw-userjsyoucanpreview'>\n$1\n</div>",
2684 array( 'userjsyoucanpreview' )
2691 if ( $this->mTitle
->isProtected( 'edit' ) &&
2692 MWNamespace
::getRestrictionLevels( $this->mTitle
->getNamespace() ) !== array( '' )
2694 # Is the title semi-protected?
2695 if ( $this->mTitle
->isSemiProtected() ) {
2696 $noticeMsg = 'semiprotectedpagewarning';
2698 # Then it must be protected based on static groups (regular)
2699 $noticeMsg = 'protectedpagewarning';
2701 LogEventsList
::showLogExtract( $wgOut, 'protect', $this->mTitle
, '',
2702 array( 'lim' => 1, 'msgKey' => array( $noticeMsg ) ) );
2704 if ( $this->mTitle
->isCascadeProtected() ) {
2705 # Is this page under cascading protection from some source pages?
2706 list( $cascadeSources, /* $restrictions */ ) = $this->mTitle
->getCascadeProtectionSources();
2707 $notice = "<div class='mw-cascadeprotectedwarning'>\n$1\n";
2708 $cascadeSourcesCount = count( $cascadeSources );
2709 if ( $cascadeSourcesCount > 0 ) {
2710 # Explain, and list the titles responsible
2711 foreach ( $cascadeSources as $page ) {
2712 $notice .= '* [[:' . $page->getPrefixedText() . "]]\n";
2715 $notice .= '</div>';
2716 $wgOut->wrapWikiMsg( $notice, array( 'cascadeprotectedwarning', $cascadeSourcesCount ) );
2718 if ( !$this->mTitle
->exists() && $this->mTitle
->getRestrictions( 'create' ) ) {
2719 LogEventsList
::showLogExtract( $wgOut, 'protect', $this->mTitle
, '',
2721 'showIfEmpty' => false,
2722 'msgKey' => array( 'titleprotectedwarning' ),
2723 'wrap' => "<div class=\"mw-titleprotectedwarning\">\n$1</div>" ) );
2726 if ( $this->kblength
=== false ) {
2727 $this->kblength
= (int)( strlen( $this->textbox1
) / 1024 );
2730 if ( $this->tooBig ||
$this->kblength
> $wgMaxArticleSize ) {
2731 $wgOut->wrapWikiMsg( "<div class='error' id='mw-edit-longpageerror'>\n$1\n</div>",
2734 $wgLang->formatNum( $this->kblength
),
2735 $wgLang->formatNum( $wgMaxArticleSize )
2739 if ( !wfMessage( 'longpage-hint' )->isDisabled() ) {
2740 $wgOut->wrapWikiMsg( "<div id='mw-edit-longpage-hint'>\n$1\n</div>",
2743 $wgLang->formatSize( strlen( $this->textbox1
) ),
2744 strlen( $this->textbox1
)
2749 # Add header copyright warning
2750 $this->showHeaderCopyrightWarning();
2756 * Standard summary input and label (wgSummary), abstracted so EditPage
2757 * subclasses may reorganize the form.
2758 * Note that you do not need to worry about the label's for=, it will be
2759 * inferred by the id given to the input. You can remove them both by
2760 * passing array( 'id' => false ) to $userInputAttrs.
2762 * @param string $summary The value of the summary input
2763 * @param string $labelText The html to place inside the label
2764 * @param array $inputAttrs Array of attrs to use on the input
2765 * @param array $spanLabelAttrs Array of attrs to use on the span inside the label
2767 * @return array An array in the format array( $label, $input )
2769 function getSummaryInput( $summary = "", $labelText = null,
2770 $inputAttrs = null, $spanLabelAttrs = null
2772 // Note: the maxlength is overridden in JS to 255 and to make it use UTF-8 bytes, not characters.
2773 $inputAttrs = ( is_array( $inputAttrs ) ?
$inputAttrs : array() ) +
array(
2774 'id' => 'wpSummary',
2775 'maxlength' => '200',
2778 'spellcheck' => 'true',
2779 ) + Linker
::tooltipAndAccesskeyAttribs( 'summary' );
2781 $spanLabelAttrs = ( is_array( $spanLabelAttrs ) ?
$spanLabelAttrs : array() ) +
array(
2782 'class' => $this->missingSummary ?
'mw-summarymissed' : 'mw-summary',
2783 'id' => "wpSummaryLabel"
2790 $inputAttrs['id'] ?
array( 'for' => $inputAttrs['id'] ) : null,
2793 $label = Xml
::tags( 'span', $spanLabelAttrs, $label );
2796 $input = Html
::input( 'wpSummary', $summary, 'text', $inputAttrs );
2798 return array( $label, $input );
2802 * @param bool $isSubjectPreview True if this is the section subject/title
2803 * up top, or false if this is the comment summary
2804 * down below the textarea
2805 * @param string $summary The text of the summary to display
2807 protected function showSummaryInput( $isSubjectPreview, $summary = "" ) {
2808 global $wgOut, $wgContLang;
2809 # Add a class if 'missingsummary' is triggered to allow styling of the summary line
2810 $summaryClass = $this->missingSummary ?
'mw-summarymissed' : 'mw-summary';
2811 if ( $isSubjectPreview ) {
2812 if ( $this->nosummary
) {
2816 if ( !$this->mShowSummaryField
) {
2820 $summary = $wgContLang->recodeForEdit( $summary );
2821 $labelText = wfMessage( $isSubjectPreview ?
'subject' : 'summary' )->parse();
2822 list( $label, $input ) = $this->getSummaryInput(
2825 array( 'class' => $summaryClass ),
2828 $wgOut->addHTML( "{$label} {$input}" );
2832 * @param bool $isSubjectPreview True if this is the section subject/title
2833 * up top, or false if this is the comment summary
2834 * down below the textarea
2835 * @param string $summary The text of the summary to display
2838 protected function getSummaryPreview( $isSubjectPreview, $summary = "" ) {
2839 // avoid spaces in preview, gets always trimmed on save
2840 $summary = trim( $summary );
2841 if ( !$summary ||
( !$this->preview
&& !$this->diff
) ) {
2847 if ( $isSubjectPreview ) {
2848 $summary = wfMessage( 'newsectionsummary' )->rawParams( $wgParser->stripSectionName( $summary ) )
2849 ->inContentLanguage()->text();
2852 $message = $isSubjectPreview ?
'subject-preview' : 'summary-preview';
2854 $summary = wfMessage( $message )->parse()
2855 . Linker
::commentBlock( $summary, $this->mTitle
, $isSubjectPreview );
2856 return Xml
::tags( 'div', array( 'class' => 'mw-summary-preview' ), $summary );
2859 protected function showFormBeforeText() {
2861 $section = htmlspecialchars( $this->section
);
2862 $wgOut->addHTML( <<<HTML
2863 <input type='hidden' value="{$section}" name="wpSection"/>
2864 <input type='hidden' value="{$this->starttime}" name="wpStarttime" />
2865 <input type='hidden' value="{$this->edittime}" name="wpEdittime" />
2866 <input type='hidden' value="{$this->scrolltop}" name="wpScrolltop" id="wpScrolltop" />
2870 if ( !$this->checkUnicodeCompliantBrowser() ) {
2871 $wgOut->addHTML( Html
::hidden( 'safemode', '1' ) );
2875 protected function showFormAfterText() {
2876 global $wgOut, $wgUser;
2878 * To make it harder for someone to slip a user a page
2879 * which submits an edit form to the wiki without their
2880 * knowledge, a random token is associated with the login
2881 * session. If it's not passed back with the submission,
2882 * we won't save the page, or render user JavaScript and
2885 * For anon editors, who may not have a session, we just
2886 * include the constant suffix to prevent editing from
2887 * broken text-mangling proxies.
2889 $wgOut->addHTML( "\n" . Html
::hidden( "wpEditToken", $wgUser->getEditToken() ) . "\n" );
2893 * Subpage overridable method for printing the form for page content editing
2894 * By default this simply outputs wpTextbox1
2895 * Subclasses can override this to provide a custom UI for editing;
2896 * be it a form, or simply wpTextbox1 with a modified content that will be
2897 * reverse modified when extracted from the post data.
2898 * Note that this is basically the inverse for importContentFormData
2900 protected function showContentForm() {
2901 $this->showTextbox1();
2905 * Method to output wpTextbox1
2906 * The $textoverride method can be used by subclasses overriding showContentForm
2907 * to pass back to this method.
2909 * @param array $customAttribs Array of html attributes to use in the textarea
2910 * @param string $textoverride Optional text to override $this->textarea1 with
2912 protected function showTextbox1( $customAttribs = null, $textoverride = null ) {
2913 if ( $this->wasDeletedSinceLastEdit() && $this->formtype
== 'save' ) {
2914 $attribs = array( 'style' => 'display:none;' );
2916 $classes = array(); // Textarea CSS
2917 if ( $this->mTitle
->isProtected( 'edit' ) &&
2918 MWNamespace
::getRestrictionLevels( $this->mTitle
->getNamespace() ) !== array( '' )
2920 # Is the title semi-protected?
2921 if ( $this->mTitle
->isSemiProtected() ) {
2922 $classes[] = 'mw-textarea-sprotected';
2924 # Then it must be protected based on static groups (regular)
2925 $classes[] = 'mw-textarea-protected';
2927 # Is the title cascade-protected?
2928 if ( $this->mTitle
->isCascadeProtected() ) {
2929 $classes[] = 'mw-textarea-cprotected';
2933 $attribs = array( 'tabindex' => 1 );
2935 if ( is_array( $customAttribs ) ) {
2936 $attribs +
= $customAttribs;
2939 if ( count( $classes ) ) {
2940 if ( isset( $attribs['class'] ) ) {
2941 $classes[] = $attribs['class'];
2943 $attribs['class'] = implode( ' ', $classes );
2948 $textoverride !== null ?
$textoverride : $this->textbox1
,
2954 protected function showTextbox2() {
2955 $this->showTextbox( $this->textbox2
, 'wpTextbox2', array( 'tabindex' => 6, 'readonly' ) );
2958 protected function showTextbox( $text, $name, $customAttribs = array() ) {
2959 global $wgOut, $wgUser;
2961 $wikitext = $this->safeUnicodeOutput( $text );
2962 if ( strval( $wikitext ) !== '' ) {
2963 // Ensure there's a newline at the end, otherwise adding lines
2965 // But don't add a newline if the ext is empty, or Firefox in XHTML
2966 // mode will show an extra newline. A bit annoying.
2970 $attribs = $customAttribs +
array(
2973 'cols' => $wgUser->getIntOption( 'cols' ),
2974 'rows' => $wgUser->getIntOption( 'rows' ),
2975 // Avoid PHP notices when appending preferences
2976 // (appending allows customAttribs['style'] to still work).
2980 $pageLang = $this->mTitle
->getPageLanguage();
2981 $attribs['lang'] = $pageLang->getHtmlCode();
2982 $attribs['dir'] = $pageLang->getDir();
2984 $wgOut->addHTML( Html
::textarea( $name, $wikitext, $attribs ) );
2987 protected function displayPreviewArea( $previewOutput, $isOnTop = false ) {
2991 $classes[] = 'ontop';
2994 $attribs = array( 'id' => 'wikiPreview', 'class' => implode( ' ', $classes ) );
2996 if ( $this->formtype
!= 'preview' ) {
2997 $attribs['style'] = 'display: none;';
3000 $wgOut->addHTML( Xml
::openElement( 'div', $attribs ) );
3002 if ( $this->formtype
== 'preview' ) {
3003 $this->showPreview( $previewOutput );
3005 // Empty content container for LivePreview
3006 $pageViewLang = $this->mTitle
->getPageViewLanguage();
3007 $attribs = array( 'lang' => $pageViewLang->getHtmlCode(), 'dir' => $pageViewLang->getDir(),
3008 'class' => 'mw-content-' . $pageViewLang->getDir() );
3009 $wgOut->addHTML( Html
::rawElement( 'div', $attribs ) );
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 Hooks
::run( '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 Hooks
::run( '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 Hooks
::run( '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 Hooks
::run( '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 $limitReport = Html
::rawElement( 'div', array( 'class' => 'mw-limitReportExplanation' ),
3196 wfMessage( 'limitreport-title' )->parseAsBlock()
3199 // Show/hide animation doesn't work correctly on a table, so wrap it in a div.
3200 $limitReport .= Html
::openElement( 'div', array( 'class' => 'preview-limit-report-wrapper' ) );
3202 $limitReport .= Html
::openElement( 'table', array(
3203 'class' => 'preview-limit-report wikitable'
3205 Html
::openElement( 'tbody' );
3207 foreach ( $output->getLimitReportData() as $key => $value ) {
3208 if ( Hooks
::run( 'ParserLimitReportFormat',
3209 array( $key, &$value, &$limitReport, true, true )
3211 $keyMsg = wfMessage( $key );
3212 $valueMsg = wfMessage( array( "$key-value-html", "$key-value" ) );
3213 if ( !$valueMsg->exists() ) {
3214 $valueMsg = new RawMessage( '$1' );
3216 if ( !$keyMsg->isDisabled() && !$valueMsg->isDisabled() ) {
3217 $limitReport .= Html
::openElement( 'tr' ) .
3218 Html
::rawElement( 'th', null, $keyMsg->parse() ) .
3219 Html
::rawElement( 'td', null, $valueMsg->params( $value )->parse() ) .
3220 Html
::closeElement( 'tr' );
3225 $limitReport .= Html
::closeElement( 'tbody' ) .
3226 Html
::closeElement( 'table' ) .
3227 Html
::closeElement( 'div' );
3229 return $limitReport;
3232 protected function showStandardInputs( &$tabindex = 2 ) {
3234 $wgOut->addHTML( "<div class='editOptions'>\n" );
3236 if ( $this->section
!= 'new' ) {
3237 $this->showSummaryInput( false, $this->summary
);
3238 $wgOut->addHTML( $this->getSummaryPreview( false, $this->summary
) );
3241 $checkboxes = $this->getCheckboxes( $tabindex,
3242 array( 'minor' => $this->minoredit
, 'watch' => $this->watchthis
) );
3243 $wgOut->addHTML( "<div class='editCheckboxes'>" . implode( $checkboxes, "\n" ) . "</div>\n" );
3245 // Show copyright warning.
3246 $wgOut->addWikiText( $this->getCopywarn() );
3247 $wgOut->addHTML( $this->editFormTextAfterWarn
);
3249 $wgOut->addHTML( "<div class='editButtons'>\n" );
3250 $wgOut->addHTML( implode( $this->getEditButtons( $tabindex ), "\n" ) . "\n" );
3252 $cancel = $this->getCancelLink();
3253 if ( $cancel !== '' ) {
3254 $cancel .= Html
::element( 'span',
3255 array( 'class' => 'mw-editButtons-pipe-separator' ),
3256 wfMessage( 'pipe-separator' )->text() );
3259 $message = wfMessage( 'edithelppage' )->inContentLanguage()->text();
3260 $edithelpurl = Skin
::makeInternalOrExternalUrl( $message );
3262 'target' => 'helpwindow',
3263 'href' => $edithelpurl,
3265 $edithelp = Html
::linkButton( wfMessage( 'edithelp' )->text(),
3266 $attrs, array( 'mw-ui-quiet' ) ) .
3267 wfMessage( 'word-separator' )->escaped() .
3268 wfMessage( 'newwindow' )->parse();
3270 $wgOut->addHTML( " <span class='cancelLink'>{$cancel}</span>\n" );
3271 $wgOut->addHTML( " <span class='editHelp'>{$edithelp}</span>\n" );
3272 $wgOut->addHTML( "</div><!-- editButtons -->\n" );
3274 Hooks
::run( 'EditPage::showStandardInputs:options', array( $this, $wgOut, &$tabindex ) );
3276 $wgOut->addHTML( "</div><!-- editOptions -->\n" );
3280 * Show an edit conflict. textbox1 is already shown in showEditForm().
3281 * If you want to use another entry point to this function, be careful.
3283 protected function showConflict() {
3286 if ( Hooks
::run( 'EditPageBeforeConflictDiff', array( &$this, &$wgOut ) ) ) {
3287 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
3289 $content1 = $this->toEditContent( $this->textbox1
);
3290 $content2 = $this->toEditContent( $this->textbox2
);
3292 $handler = ContentHandler
::getForModelID( $this->contentModel
);
3293 $de = $handler->createDifferenceEngine( $this->mArticle
->getContext() );
3294 $de->setContent( $content2, $content1 );
3296 wfMessage( 'yourtext' )->parse(),
3297 wfMessage( 'storedversion' )->text()
3300 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
3301 $this->showTextbox2();
3308 public function getCancelLink() {
3309 $cancelParams = array();
3310 if ( !$this->isConflict
&& $this->oldid
> 0 ) {
3311 $cancelParams['oldid'] = $this->oldid
;
3313 $attrs = array( 'id' => 'mw-editform-cancel' );
3315 return Linker
::linkKnown(
3316 $this->getContextTitle(),
3317 wfMessage( 'cancel' )->parse(),
3318 Html
::buttonAttributes( $attrs, array( 'mw-ui-quiet' ) ),
3324 * Returns the URL to use in the form's action attribute.
3325 * This is used by EditPage subclasses when simply customizing the action
3326 * variable in the constructor is not enough. This can be used when the
3327 * EditPage lives inside of a Special page rather than a custom page action.
3329 * @param Title $title Title object for which is being edited (where we go to for &action= links)
3332 protected function getActionURL( Title
$title ) {
3333 return $title->getLocalURL( array( 'action' => $this->action
) );
3337 * Check if a page was deleted while the user was editing it, before submit.
3338 * Note that we rely on the logging table, which hasn't been always there,
3339 * but that doesn't matter, because this only applies to brand new
3343 protected function wasDeletedSinceLastEdit() {
3344 if ( $this->deletedSinceEdit
!== null ) {
3345 return $this->deletedSinceEdit
;
3348 $this->deletedSinceEdit
= false;
3350 if ( $this->mTitle
->isDeletedQuick() ) {
3351 $this->lastDelete
= $this->getLastDelete();
3352 if ( $this->lastDelete
) {
3353 $deleteTime = wfTimestamp( TS_MW
, $this->lastDelete
->log_timestamp
);
3354 if ( $deleteTime > $this->starttime
) {
3355 $this->deletedSinceEdit
= true;
3360 return $this->deletedSinceEdit
;
3364 * @return bool|stdClass
3366 protected function getLastDelete() {
3367 $dbr = wfGetDB( DB_SLAVE
);
3368 $data = $dbr->selectRow(
3369 array( 'logging', 'user' ),
3382 'log_namespace' => $this->mTitle
->getNamespace(),
3383 'log_title' => $this->mTitle
->getDBkey(),
3384 'log_type' => 'delete',
3385 'log_action' => 'delete',
3389 array( 'LIMIT' => 1, 'ORDER BY' => 'log_timestamp DESC' )
3391 // Quick paranoid permission checks...
3392 if ( is_object( $data ) ) {
3393 if ( $data->log_deleted
& LogPage
::DELETED_USER
) {
3394 $data->user_name
= wfMessage( 'rev-deleted-user' )->escaped();
3397 if ( $data->log_deleted
& LogPage
::DELETED_COMMENT
) {
3398 $data->log_comment
= wfMessage( 'rev-deleted-comment' )->escaped();
3406 * Get the rendered text for previewing.
3407 * @throws MWException
3410 function getPreviewText() {
3411 global $wgOut, $wgUser, $wgRawHtml, $wgLang;
3412 global $wgAllowUserCss, $wgAllowUserJs;
3414 if ( $wgRawHtml && !$this->mTokenOk
) {
3415 // Could be an offsite preview attempt. This is very unsafe if
3416 // HTML is enabled, as it could be an attack.
3418 if ( $this->textbox1
!== '' ) {
3419 // Do not put big scary notice, if previewing the empty
3420 // string, which happens when you initially edit
3421 // a category page, due to automatic preview-on-open.
3422 $parsedNote = $wgOut->parse( "<div class='previewnote'>" .
3423 wfMessage( 'session_fail_preview_html' )->text() . "</div>", true, /* interface */true );
3431 $content = $this->toEditContent( $this->textbox1
);
3435 'AlternateEditPreview',
3436 array( $this, &$content, &$previewHTML, &$this->mParserOutput
) )
3438 return $previewHTML;
3441 # provide a anchor link to the editform
3442 $continueEditing = '<span class="mw-continue-editing">' .
3443 '[[#' . self
::EDITFORM_ID
. '|' . $wgLang->getArrow() . ' ' .
3444 wfMessage( 'continue-editing' )->text() . ']]</span>';
3445 if ( $this->mTriedSave
&& !$this->mTokenOk
) {
3446 if ( $this->mTokenOkExceptSuffix
) {
3447 $note = wfMessage( 'token_suffix_mismatch' )->plain();
3449 $note = wfMessage( 'session_fail_preview' )->plain();
3451 } elseif ( $this->incompleteForm
) {
3452 $note = wfMessage( 'edit_form_incomplete' )->plain();
3454 $note = wfMessage( 'previewnote' )->plain() . ' ' . $continueEditing;
3457 $parserOptions = $this->mArticle
->makeParserOptions( $this->mArticle
->getContext() );
3458 $parserOptions->setIsPreview( true );
3459 $parserOptions->setIsSectionPreview( !is_null( $this->section
) && $this->section
!== '' );
3461 # don't parse non-wikitext pages, show message about preview
3462 if ( $this->mTitle
->isCssJsSubpage() ||
$this->mTitle
->isCssOrJsPage() ) {
3463 if ( $this->mTitle
->isCssJsSubpage() ) {
3465 } elseif ( $this->mTitle
->isCssOrJsPage() ) {
3471 if ( $content->getModel() == CONTENT_MODEL_CSS
) {
3473 if ( $level === 'user' && !$wgAllowUserCss ) {
3476 } elseif ( $content->getModel() == CONTENT_MODEL_JAVASCRIPT
) {
3478 if ( $level === 'user' && !$wgAllowUserJs ) {
3485 # Used messages to make sure grep find them:
3486 # Messages: usercsspreview, userjspreview, sitecsspreview, sitejspreview
3487 if ( $level && $format ) {
3488 $note = "<div id='mw-{$level}{$format}preview'>" .
3489 wfMessage( "{$level}{$format}preview" )->text() .
3490 ' ' . $continueEditing . "</div>";
3494 # If we're adding a comment, we need to show the
3495 # summary as the headline
3496 if ( $this->section
=== "new" && $this->summary
!== "" ) {
3497 $content = $content->addSectionHeader( $this->summary
);
3500 $hook_args = array( $this, &$content );
3501 ContentHandler
::runLegacyHooks( 'EditPageGetPreviewText', $hook_args );
3502 Hooks
::run( 'EditPageGetPreviewContent', $hook_args );
3504 $parserOptions->enableLimitReport();
3506 # For CSS/JS pages, we should have called the ShowRawCssJs hook here.
3507 # But it's now deprecated, so never mind
3509 $pstContent = $content->preSaveTransform( $this->mTitle
, $wgUser, $parserOptions );
3510 $scopedCallback = $parserOptions->setupFakeRevision(
3511 $this->mTitle
, $pstContent, $wgUser );
3512 $parserOutput = $pstContent->getParserOutput( $this->mTitle
, null, $parserOptions );
3514 # Try to stash the edit for the final submission step
3515 # @todo: different date format preferences cause cache misses
3516 ApiStashEdit
::stashEditFromPreview(
3517 $this->getArticle(), $content, $pstContent,
3518 $parserOutput, $parserOptions, $parserOptions, wfTimestampNow()
3521 $parserOutput->setEditSectionTokens( false ); // no section edit links
3522 $previewHTML = $parserOutput->getText();
3523 $this->mParserOutput
= $parserOutput;
3524 $wgOut->addParserOutputMetadata( $parserOutput );
3526 if ( count( $parserOutput->getWarnings() ) ) {
3527 $note .= "\n\n" . implode( "\n\n", $parserOutput->getWarnings() );
3529 } catch ( MWContentSerializationException
$ex ) {
3531 'content-failed-to-parse',
3532 $this->contentModel
,
3533 $this->contentFormat
,
3536 $note .= "\n\n" . $m->parse();
3540 if ( $this->isConflict
) {
3541 $conflict = '<h2 id="mw-previewconflict">'
3542 . wfMessage( 'previewconflict' )->escaped() . "</h2>\n";
3544 $conflict = '<hr />';
3547 $previewhead = "<div class='previewnote'>\n" .
3548 '<h2 id="mw-previewheader">' . wfMessage( 'preview' )->escaped() . "</h2>" .
3549 $wgOut->parse( $note, true, /* interface */true ) . $conflict . "</div>\n";
3551 $pageViewLang = $this->mTitle
->getPageViewLanguage();
3552 $attribs = array( 'lang' => $pageViewLang->getHtmlCode(), 'dir' => $pageViewLang->getDir(),
3553 'class' => 'mw-content-' . $pageViewLang->getDir() );
3554 $previewHTML = Html
::rawElement( 'div', $attribs, $previewHTML );
3556 return $previewhead . $previewHTML . $this->previewTextAfterContent
;
3562 function getTemplates() {
3563 if ( $this->preview ||
$this->section
!= '' ) {
3564 $templates = array();
3565 if ( !isset( $this->mParserOutput
) ) {
3568 foreach ( $this->mParserOutput
->getTemplates() as $ns => $template ) {
3569 foreach ( array_keys( $template ) as $dbk ) {
3570 $templates[] = Title
::makeTitle( $ns, $dbk );
3575 return $this->mTitle
->getTemplateLinksFrom();
3580 * Shows a bulletin board style toolbar for common editing functions.
3581 * It can be disabled in the user preferences.
3585 static function getEditToolbar() {
3586 global $wgContLang, $wgOut;
3587 global $wgEnableUploads, $wgForeignFileRepos;
3589 $imagesAvailable = $wgEnableUploads ||
count( $wgForeignFileRepos );
3592 * $toolarray is an array of arrays each of which includes the
3593 * opening tag, the closing tag, optionally a sample text that is
3594 * inserted between the two when no selection is highlighted
3595 * and. The tip text is shown when the user moves the mouse
3598 * Images are defined in ResourceLoaderEditToolbarModule.
3602 'id' => 'mw-editbutton-bold',
3604 'close' => '\'\'\'',
3605 'sample' => wfMessage( 'bold_sample' )->text(),
3606 'tip' => wfMessage( 'bold_tip' )->text(),
3609 'id' => 'mw-editbutton-italic',
3612 'sample' => wfMessage( 'italic_sample' )->text(),
3613 'tip' => wfMessage( 'italic_tip' )->text(),
3616 'id' => 'mw-editbutton-link',
3619 'sample' => wfMessage( 'link_sample' )->text(),
3620 'tip' => wfMessage( 'link_tip' )->text(),
3623 'id' => 'mw-editbutton-extlink',
3626 'sample' => wfMessage( 'extlink_sample' )->text(),
3627 'tip' => wfMessage( 'extlink_tip' )->text(),
3630 'id' => 'mw-editbutton-headline',
3633 'sample' => wfMessage( 'headline_sample' )->text(),
3634 'tip' => wfMessage( 'headline_tip' )->text(),
3636 $imagesAvailable ?
array(
3637 'id' => 'mw-editbutton-image',
3638 'open' => '[[' . $wgContLang->getNsText( NS_FILE
) . ':',
3640 'sample' => wfMessage( 'image_sample' )->text(),
3641 'tip' => wfMessage( 'image_tip' )->text(),
3643 $imagesAvailable ?
array(
3644 'id' => 'mw-editbutton-media',
3645 'open' => '[[' . $wgContLang->getNsText( NS_MEDIA
) . ':',
3647 'sample' => wfMessage( 'media_sample' )->text(),
3648 'tip' => wfMessage( 'media_tip' )->text(),
3651 'id' => 'mw-editbutton-nowiki',
3652 'open' => "<nowiki>",
3653 'close' => "</nowiki>",
3654 'sample' => wfMessage( 'nowiki_sample' )->text(),
3655 'tip' => wfMessage( 'nowiki_tip' )->text(),
3658 'id' => 'mw-editbutton-signature',
3662 'tip' => wfMessage( 'sig_tip' )->text(),
3665 'id' => 'mw-editbutton-hr',
3666 'open' => "\n----\n",
3669 'tip' => wfMessage( 'hr_tip' )->text(),
3673 $script = 'mw.loader.using("mediawiki.toolbar", function () {';
3674 foreach ( $toolarray as $tool ) {
3680 // Images are defined in ResourceLoaderEditToolbarModule
3682 // Note that we use the tip both for the ALT tag and the TITLE tag of the image.
3683 // Older browsers show a "speedtip" type message only for ALT.
3684 // Ideally these should be different, realistically they
3685 // probably don't need to be.
3693 $script .= Xml
::encodeJsCall(
3694 'mw.toolbar.addButton',
3696 ResourceLoader
::inDebugMode()
3701 $wgOut->addScript( Html
::inlineScript( ResourceLoader
::makeLoaderConditionalScript( $script ) ) );
3703 $toolbar = '<div id="toolbar"></div>';
3705 Hooks
::run( '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 Hooks
::run( '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 Hooks
::run( 'EditPageBeforeEditButtons', array( &$this, &$buttons, &$tabindex ) );
3818 * Creates a basic error page which informs the user that
3819 * they have attempted to edit a nonexistent section.
3821 function noSuchSectionPage() {
3824 $wgOut->prepareErrorPage( wfMessage( 'nosuchsectiontitle' ) );
3826 $res = wfMessage( 'nosuchsectiontext', $this->section
)->parseAsBlock();
3827 Hooks
::run( 'EditPageNoSuchSection', array( &$this, &$res ) );
3828 $wgOut->addHTML( $res );
3830 $wgOut->returnToMain( false, $this->mTitle
);
3834 * Show "your edit contains spam" page with your diff and text
3836 * @param string|array|bool $match Text (or array of texts) which triggered one or more filters
3838 public function spamPageWithContent( $match = false ) {
3839 global $wgOut, $wgLang;
3840 $this->textbox2
= $this->textbox1
;
3842 if ( is_array( $match ) ) {
3843 $match = $wgLang->listToText( $match );
3845 $wgOut->prepareErrorPage( wfMessage( 'spamprotectiontitle' ) );
3847 $wgOut->addHTML( '<div id="spamprotected">' );
3848 $wgOut->addWikiMsg( 'spamprotectiontext' );
3850 $wgOut->addWikiMsg( 'spamprotectionmatch', wfEscapeWikiText( $match ) );
3852 $wgOut->addHTML( '</div>' );
3854 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
3857 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
3858 $this->showTextbox2();
3860 $wgOut->addReturnTo( $this->getContextTitle(), array( 'action' => 'edit' ) );
3864 * Check if the browser is on a blacklist of user-agents known to
3865 * mangle UTF-8 data on form submission. Returns true if Unicode
3866 * should make it through, false if it's known to be a problem.
3869 private function checkUnicodeCompliantBrowser() {
3870 global $wgBrowserBlackList, $wgRequest;
3872 $currentbrowser = $wgRequest->getHeader( 'User-Agent' );
3873 if ( $currentbrowser === false ) {
3874 // No User-Agent header sent? Trust it by default...
3878 foreach ( $wgBrowserBlackList as $browser ) {
3879 if ( preg_match( $browser, $currentbrowser ) ) {
3887 * Filter an input field through a Unicode de-armoring process if it
3888 * came from an old browser with known broken Unicode editing issues.
3890 * @param WebRequest $request
3891 * @param string $field
3894 protected function safeUnicodeInput( $request, $field ) {
3895 $text = rtrim( $request->getText( $field ) );
3896 return $request->getBool( 'safemode' )
3897 ?
$this->unmakeSafe( $text )
3902 * Filter an output field through a Unicode armoring process if it is
3903 * going to an old browser with known broken Unicode editing issues.
3905 * @param string $text
3908 protected function safeUnicodeOutput( $text ) {
3910 $codedText = $wgContLang->recodeForEdit( $text );
3911 return $this->checkUnicodeCompliantBrowser()
3913 : $this->makeSafe( $codedText );
3917 * A number of web browsers are known to corrupt non-ASCII characters
3918 * in a UTF-8 text editing environment. To protect against this,
3919 * detected browsers will be served an armored version of the text,
3920 * with non-ASCII chars converted to numeric HTML character references.
3922 * Preexisting such character references will have a 0 added to them
3923 * to ensure that round-trips do not alter the original data.
3925 * @param string $invalue
3928 private function makeSafe( $invalue ) {
3929 // Armor existing references for reversibility.
3930 $invalue = strtr( $invalue, array( "&#x" => "�" ) );
3935 $valueLength = strlen( $invalue );
3936 for ( $i = 0; $i < $valueLength; $i++
) {
3937 $bytevalue = ord( $invalue[$i] );
3938 if ( $bytevalue <= 0x7F ) { // 0xxx xxxx
3939 $result .= chr( $bytevalue );
3941 } elseif ( $bytevalue <= 0xBF ) { // 10xx xxxx
3942 $working = $working << 6;
3943 $working +
= ( $bytevalue & 0x3F );
3945 if ( $bytesleft <= 0 ) {
3946 $result .= "&#x" . strtoupper( dechex( $working ) ) . ";";
3948 } elseif ( $bytevalue <= 0xDF ) { // 110x xxxx
3949 $working = $bytevalue & 0x1F;
3951 } elseif ( $bytevalue <= 0xEF ) { // 1110 xxxx
3952 $working = $bytevalue & 0x0F;
3954 } else { // 1111 0xxx
3955 $working = $bytevalue & 0x07;
3963 * Reverse the previously applied transliteration of non-ASCII characters
3964 * back to UTF-8. Used to protect data from corruption by broken web browsers
3965 * as listed in $wgBrowserBlackList.
3967 * @param string $invalue
3970 private function unmakeSafe( $invalue ) {
3972 $valueLength = strlen( $invalue );
3973 for ( $i = 0; $i < $valueLength; $i++
) {
3974 if ( ( substr( $invalue, $i, 3 ) == "&#x" ) && ( $invalue[$i +
3] != '0' ) ) {
3978 $hexstring .= $invalue[$i];
3980 } while ( ctype_xdigit( $invalue[$i] ) && ( $i < strlen( $invalue ) ) );
3982 // Do some sanity checks. These aren't needed for reversibility,
3983 // but should help keep the breakage down if the editor
3984 // breaks one of the entities whilst editing.
3985 if ( ( substr( $invalue, $i, 1 ) == ";" ) && ( strlen( $hexstring ) <= 6 ) ) {
3986 $codepoint = hexdec( $hexstring );
3987 $result .= UtfNormal\Utils
::codepointToUtf8( $codepoint );
3989 $result .= "&#x" . $hexstring . substr( $invalue, $i, 1 );
3992 $result .= substr( $invalue, $i, 1 );
3995 // reverse the transform that we made for reversibility reasons.
3996 return strtr( $result, array( "�" => "&#x" ) );