3 * Page edition user interface.
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.
41 * Status: Article successfully updated
43 const AS_SUCCESS_UPDATE
= 200;
46 * Status: Article successfully created
48 const AS_SUCCESS_NEW_ARTICLE
= 201;
51 * Status: Article update aborted by a hook function
53 const AS_HOOK_ERROR
= 210;
56 * Status: A hook function returned an error
58 const AS_HOOK_ERROR_EXPECTED
= 212;
61 * Status: User is blocked from editing this page
63 const AS_BLOCKED_PAGE_FOR_USER
= 215;
66 * Status: Content too big (> $wgMaxArticleSize)
68 const AS_CONTENT_TOO_BIG
= 216;
71 * Status: User cannot edit? (not used)
73 const AS_USER_CANNOT_EDIT
= 217;
76 * Status: this anonymous user is not allowed to edit this page
78 const AS_READ_ONLY_PAGE_ANON
= 218;
81 * Status: this logged in user is not allowed to edit this page
83 const AS_READ_ONLY_PAGE_LOGGED
= 219;
86 * Status: wiki is in readonly mode (wfReadOnly() == true)
88 const AS_READ_ONLY_PAGE
= 220;
91 * Status: rate limiter for action 'edit' was tripped
93 const AS_RATE_LIMITED
= 221;
96 * Status: article was deleted while editing and param wpRecreate == false or form
99 const AS_ARTICLE_WAS_DELETED
= 222;
102 * Status: user tried to create this page, but is not allowed to do that
103 * ( Title->userCan('create') == false )
105 const AS_NO_CREATE_PERMISSION
= 223;
108 * Status: user tried to create a blank page
110 const AS_BLANK_ARTICLE
= 224;
113 * Status: (non-resolvable) edit conflict
115 const AS_CONFLICT_DETECTED
= 225;
118 * Status: no edit summary given and the user has forceeditsummary set and the user is not
119 * editing in his own userspace or talkspace and wpIgnoreBlankSummary == false
121 const AS_SUMMARY_NEEDED
= 226;
124 * Status: user tried to create a new section without content
126 const AS_TEXTBOX_EMPTY
= 228;
129 * Status: article is too big (> $wgMaxArticleSize), after merging in the new section
131 const AS_MAX_ARTICLE_SIZE_EXCEEDED
= 229;
139 * Status: WikiPage::doEdit() was unsuccessful
144 * Status: summary contained spam according to one of the regexes in $wgSummarySpamRegex
146 const AS_SPAM_ERROR
= 232;
149 * Status: anonymous user is not allowed to upload (User::isAllowed('upload') == false)
151 const AS_IMAGE_REDIRECT_ANON
= 233;
154 * Status: logged in user is not allowed to upload (User::isAllowed('upload') == false)
156 const AS_IMAGE_REDIRECT_LOGGED
= 234;
159 * Status: can't parse content
161 const AS_PARSE_ERROR
= 240;
164 * HTML id and name for the beginning of the edit form.
166 const EDITFORM_ID
= 'editform';
169 * Prefix of key for cookie used to pass post-edit state.
170 * The revision id edited is added after this
172 const POST_EDIT_COOKIE_KEY_PREFIX
= 'PostEditRevision';
175 * Duration of PostEdit cookie, in seconds.
176 * The cookie will be removed instantly if the JavaScript runs.
178 * Otherwise, though, we don't want the cookies to accumulate.
179 * RFC 2109 ( https://www.ietf.org/rfc/rfc2109.txt ) specifies a possible limit of only 20 cookies per domain.
180 * This still applies at least to some versions of IE without full updates:
181 * https://blogs.msdn.com/b/ieinternals/archive/2009/08/20/wininet-ie-cookie-internals-faq.aspx
183 * A value of 20 minutes should be enough to take into account slow loads and minor
184 * clock skew while still avoiding cookie accumulation when JavaScript is turned off.
186 const POST_EDIT_COOKIE_DURATION
= 1200;
197 private $mContextTitle = null;
198 var $action = 'submit';
199 var $isConflict = false;
200 var $isCssJsSubpage = false;
201 var $isCssSubpage = false;
202 var $isJsSubpage = false;
203 var $isWrongCaseCssJsPage = false;
204 var $isNew = false; // new page or new section
205 var $deletedSinceEdit;
209 var $mTokenOk = false;
210 var $mTokenOkExceptSuffix = false;
211 var $mTriedSave = false;
212 var $incompleteForm = false;
214 var $kblength = false;
215 var $missingComment = false;
216 var $missingSummary = false;
217 var $allowBlankSummary = false;
220 #var $mPreviewTemplates;
228 * Has a summary been preset using GET parameter &summary= ?
231 var $hasPresetSummary = false;
233 var $mBaseRevision = false;
234 var $mShowSummaryField = true;
237 var $save = false, $preview = false, $diff = false;
238 var $minoredit = false, $watchthis = false, $recreate = false;
239 var $textbox1 = '', $textbox2 = '', $summary = '', $nosummary = false;
240 var $edittime = '', $section = '', $sectiontitle = '', $starttime = '';
241 var $oldid = 0, $editintro = '', $scrolltop = null, $bot = true;
242 var $contentModel = null, $contentFormat = null;
244 # Placeholders for text injection by hooks (must be HTML)
245 # extensions should take care to _append_ to the present value
246 public $editFormPageTop = ''; // Before even the preview
247 public $editFormTextTop = '';
248 public $editFormTextBeforeContent = '';
249 public $editFormTextAfterWarn = '';
250 public $editFormTextAfterTools = '';
251 public $editFormTextBottom = '';
252 public $editFormTextAfterContent = '';
253 public $previewTextAfterContent = '';
254 public $mPreloadContent = null;
256 /* $didSave should be set to true whenever an article was successfully altered. */
257 public $didSave = false;
258 public $undidRev = 0;
260 public $suppressIntro = false;
263 * Set to true to allow editing of non-text content types.
267 public $allowNonTextContent = false;
270 * @param $article Article
272 public function __construct( Article
$article ) {
273 $this->mArticle
= $article;
274 $this->mTitle
= $article->getTitle();
276 $this->contentModel
= $this->mTitle
->getContentModel();
278 $handler = ContentHandler
::getForModelID( $this->contentModel
);
279 $this->contentFormat
= $handler->getDefaultFormat();
285 public function getArticle() {
286 return $this->mArticle
;
293 public function getTitle() {
294 return $this->mTitle
;
298 * Set the context Title object
300 * @param $title Title object or null
302 public function setContextTitle( $title ) {
303 $this->mContextTitle
= $title;
307 * Get the context title object.
308 * If not set, $wgTitle will be returned. This behavior might change in
309 * the future to return $this->mTitle instead.
311 * @return Title object
313 public function getContextTitle() {
314 if ( is_null( $this->mContextTitle
) ) {
318 return $this->mContextTitle
;
323 * Returns if the given content model is editable.
325 * @param string $modelId The ID of the content model to test. Use CONTENT_MODEL_XXX constants.
327 * @throws MWException if $modelId has no known handler
329 public function isSupportedContentModel( $modelId ) {
330 return $this->allowNonTextContent ||
331 ContentHandler
::getForModelID( $modelId ) instanceof TextContentHandler
;
339 * This is the function that gets called for "action=edit". It
340 * sets up various member variables, then passes execution to
341 * another function, usually showEditForm()
343 * The edit form is self-submitting, so that when things like
344 * preview and edit conflicts occur, we get the same form back
345 * with the extra stuff added. Only when the final submission
346 * is made and all is well do we actually save and redirect to
347 * the newly-edited page.
350 global $wgOut, $wgRequest, $wgUser;
351 // Allow extensions to modify/prevent this form or submission
352 if ( !wfRunHooks( 'AlternateEdit', array( $this ) ) ) {
356 wfProfileIn( __METHOD__
);
357 wfDebug( __METHOD__
. ": enter\n" );
359 // If they used redlink=1 and the page exists, redirect to the main article
360 if ( $wgRequest->getBool( 'redlink' ) && $this->mTitle
->exists() ) {
361 $wgOut->redirect( $this->mTitle
->getFullURL() );
362 wfProfileOut( __METHOD__
);
366 $this->importFormData( $wgRequest );
367 $this->firsttime
= false;
370 $this->livePreview();
371 wfProfileOut( __METHOD__
);
375 if ( wfReadOnly() && $this->save
) {
378 $this->preview
= true;
382 $this->formtype
= 'save';
383 } elseif ( $this->preview
) {
384 $this->formtype
= 'preview';
385 } elseif ( $this->diff
) {
386 $this->formtype
= 'diff';
387 } else { # First time through
388 $this->firsttime
= true;
389 if ( $this->previewOnOpen() ) {
390 $this->formtype
= 'preview';
392 $this->formtype
= 'initial';
396 $permErrors = $this->getEditPermissionErrors();
398 wfDebug( __METHOD__
. ": User can't edit\n" );
399 // Auto-block user's IP if the account was "hard" blocked
400 $wgUser->spreadAnyEditBlock();
402 $this->displayPermissionsError( $permErrors );
404 wfProfileOut( __METHOD__
);
408 wfProfileIn( __METHOD__
. "-business-end" );
410 $this->isConflict
= false;
411 // css / js subpages of user pages get a special treatment
412 $this->isCssJsSubpage
= $this->mTitle
->isCssJsSubpage();
413 $this->isCssSubpage
= $this->mTitle
->isCssSubpage();
414 $this->isJsSubpage
= $this->mTitle
->isJsSubpage();
415 $this->isWrongCaseCssJsPage
= $this->isWrongCaseCssJsPage();
417 # Show applicable editing introductions
418 if ( $this->formtype
== 'initial' ||
$this->firsttime
) {
422 # Attempt submission here. This will check for edit conflicts,
423 # and redundantly check for locked database, blocked IPs, etc.
424 # that edit() already checked just in case someone tries to sneak
425 # in the back door with a hand-edited submission URL.
427 if ( 'save' == $this->formtype
) {
428 if ( !$this->attemptSave() ) {
429 wfProfileOut( __METHOD__
. "-business-end" );
430 wfProfileOut( __METHOD__
);
435 # First time through: get contents, set time for conflict
437 if ( 'initial' == $this->formtype ||
$this->firsttime
) {
438 if ( $this->initialiseForm() === false ) {
439 $this->noSuchSectionPage();
440 wfProfileOut( __METHOD__
. "-business-end" );
441 wfProfileOut( __METHOD__
);
445 if ( !$this->mTitle
->getArticleID() ) {
446 wfRunHooks( 'EditFormPreloadText', array( &$this->textbox1
, &$this->mTitle
) );
448 wfRunHooks( 'EditFormInitialText', array( $this ) );
453 $this->showEditForm();
454 wfProfileOut( __METHOD__
. "-business-end" );
455 wfProfileOut( __METHOD__
);
461 protected function getEditPermissionErrors() {
463 $permErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $wgUser );
464 # Can this title be created?
465 if ( !$this->mTitle
->exists() ) {
466 $permErrors = array_merge( $permErrors,
467 wfArrayDiff2( $this->mTitle
->getUserPermissionsErrors( 'create', $wgUser ), $permErrors ) );
469 # Ignore some permissions errors when a user is just previewing/viewing diffs
471 foreach ( $permErrors as $error ) {
472 if ( ( $this->preview ||
$this->diff
)
473 && ( $error[0] == 'blockedtext' ||
$error[0] == 'autoblockedtext' )
478 $permErrors = wfArrayDiff2( $permErrors, $remove );
483 * Display a permissions error page, like OutputPage::showPermissionsErrorPage(),
484 * but with the following differences:
485 * - If redlink=1, the user will be redirected to the page
486 * - If there is content to display or the error occurs while either saving,
487 * previewing or showing the difference, it will be a
488 * "View source for ..." page displaying the source code after the error message.
491 * @param array $permErrors of permissions errors, as returned by
492 * Title::getUserPermissionsErrors().
493 * @throws PermissionsError
495 protected function displayPermissionsError( array $permErrors ) {
496 global $wgRequest, $wgOut;
498 if ( $wgRequest->getBool( 'redlink' ) ) {
499 // The edit page was reached via a red link.
500 // Redirect to the article page and let them click the edit tab if
501 // they really want a permission error.
502 $wgOut->redirect( $this->mTitle
->getFullURL() );
506 $content = $this->getContentObject();
508 # Use the normal message if there's nothing to display
509 if ( $this->firsttime
&& ( !$content ||
$content->isEmpty() ) ) {
510 $action = $this->mTitle
->exists() ?
'edit' :
511 ( $this->mTitle
->isTalkPage() ?
'createtalk' : 'createpage' );
512 throw new PermissionsError( $action, $permErrors );
515 $wgOut->setRobotPolicy( 'noindex,nofollow' );
516 $wgOut->setPageTitle( wfMessage( 'viewsource-title', $this->getContextTitle()->getPrefixedText() ) );
517 $wgOut->addBacklinkSubtitle( $this->getContextTitle() );
518 $wgOut->addWikiText( $wgOut->formatPermissionsErrorMessage( $permErrors, 'edit' ) );
519 $wgOut->addHTML( "<hr />\n" );
521 # If the user made changes, preserve them when showing the markup
522 # (This happens when a user is blocked during edit, for instance)
523 if ( !$this->firsttime
) {
524 $text = $this->textbox1
;
525 $wgOut->addWikiMsg( 'viewyourtext' );
527 $text = $this->toEditText( $content );
528 $wgOut->addWikiMsg( 'viewsourcetext' );
531 $this->showTextbox( $text, 'wpTextbox1', array( 'readonly' ) );
533 $wgOut->addHTML( Html
::rawElement( 'div', array( 'class' => 'templatesUsed' ),
534 Linker
::formatTemplates( $this->getTemplates() ) ) );
536 $wgOut->addModules( 'mediawiki.action.edit.collapsibleFooter' );
538 if ( $this->mTitle
->exists() ) {
539 $wgOut->returnToMain( null, $this->mTitle
);
544 * Show a read-only error
545 * Parameters are the same as OutputPage:readOnlyPage()
546 * Redirect to the article page if redlink=1
547 * @deprecated in 1.19; use displayPermissionsError() instead
549 function readOnlyPage( $source = null, $protected = false, $reasons = array(), $action = null ) {
550 wfDeprecated( __METHOD__
, '1.19' );
552 global $wgRequest, $wgOut;
553 if ( $wgRequest->getBool( 'redlink' ) ) {
554 // The edit page was reached via a red link.
555 // Redirect to the article page and let them click the edit tab if
556 // they really want a permission error.
557 $wgOut->redirect( $this->mTitle
->getFullURL() );
559 $wgOut->readOnlyPage( $source, $protected, $reasons, $action );
564 * Should we show a preview when the edit form is first shown?
568 protected function previewOnOpen() {
569 global $wgRequest, $wgUser, $wgPreviewOnOpenNamespaces;
570 if ( $wgRequest->getVal( 'preview' ) == 'yes' ) {
571 // Explicit override from request
573 } elseif ( $wgRequest->getVal( 'preview' ) == 'no' ) {
574 // Explicit override from request
576 } elseif ( $this->section
== 'new' ) {
577 // Nothing *to* preview for new sections
579 } elseif ( ( $wgRequest->getVal( 'preload' ) !== null ||
$this->mTitle
->exists() ) && $wgUser->getOption( 'previewonfirst' ) ) {
580 // Standard preference behavior
582 } elseif ( !$this->mTitle
->exists()
583 && isset( $wgPreviewOnOpenNamespaces[$this->mTitle
->getNamespace()] )
584 && $wgPreviewOnOpenNamespaces[$this->mTitle
->getNamespace()]
586 // Categories are special
594 * Checks whether the user entered a skin name in uppercase,
595 * e.g. "User:Example/Monobook.css" instead of "monobook.css"
599 protected function isWrongCaseCssJsPage() {
600 if ( $this->mTitle
->isCssJsSubpage() ) {
601 $name = $this->mTitle
->getSkinFromCssJsSubpage();
602 $skins = array_merge(
603 array_keys( Skin
::getSkinNames() ),
606 return !in_array( $name, $skins )
607 && in_array( strtolower( $name ), $skins );
614 * Returns whether section editing is supported for the current page.
615 * Subclasses may override this to replace the default behavior, which is
616 * to check ContentHandler::supportsSections.
618 * @return bool true if this edit page supports sections, false otherwise.
620 protected function isSectionEditSupported() {
621 $contentHandler = ContentHandler
::getForTitle( $this->mTitle
);
622 return $contentHandler->supportsSections();
626 * This function collects the form data and uses it to populate various member variables.
627 * @param $request WebRequest
628 * @throws ErrorPageError
630 function importFormData( &$request ) {
631 global $wgContLang, $wgUser;
633 wfProfileIn( __METHOD__
);
635 # Section edit can come from either the form or a link
636 $this->section
= $request->getVal( 'wpSection', $request->getVal( 'section' ) );
638 if ( $this->section
!== null && $this->section
!== '' && !$this->isSectionEditSupported() ) {
639 wfProfileOut( __METHOD__
);
640 throw new ErrorPageError( 'sectioneditnotsupported-title', 'sectioneditnotsupported-text' );
643 $this->isNew
= !$this->mTitle
->exists() ||
$this->section
== 'new';
645 if ( $request->wasPosted() ) {
646 # These fields need to be checked for encoding.
647 # Also remove trailing whitespace, but don't remove _initial_
648 # whitespace from the text boxes. This may be significant formatting.
649 $this->textbox1
= $this->safeUnicodeInput( $request, 'wpTextbox1' );
650 if ( !$request->getCheck( 'wpTextbox2' ) ) {
651 // Skip this if wpTextbox2 has input, it indicates that we came
652 // from a conflict page with raw page text, not a custom form
653 // modified by subclasses
654 wfProfileIn( get_class( $this ) . "::importContentFormData" );
655 $textbox1 = $this->importContentFormData( $request );
656 if ( $textbox1 !== null ) {
657 $this->textbox1
= $textbox1;
660 wfProfileOut( get_class( $this ) . "::importContentFormData" );
663 # Truncate for whole multibyte characters
664 $this->summary
= $wgContLang->truncate( $request->getText( 'wpSummary' ), 255 );
666 # If the summary consists of a heading, e.g. '==Foobar==', extract the title from the
667 # header syntax, e.g. 'Foobar'. This is mainly an issue when we are using wpSummary for
669 $this->summary
= preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->summary
);
671 # Treat sectiontitle the same way as summary.
672 # Note that wpSectionTitle is not yet a part of the actual edit form, as wpSummary is
673 # currently doing double duty as both edit summary and section title. Right now this
674 # is just to allow API edits to work around this limitation, but this should be
675 # incorporated into the actual edit form when EditPage is rewritten (Bugs 18654, 26312).
676 $this->sectiontitle
= $wgContLang->truncate( $request->getText( 'wpSectionTitle' ), 255 );
677 $this->sectiontitle
= preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->sectiontitle
);
679 $this->edittime
= $request->getVal( 'wpEdittime' );
680 $this->starttime
= $request->getVal( 'wpStarttime' );
682 $undidRev = $request->getInt( 'wpUndidRevision' );
684 $this->undidRev
= $undidRev;
687 $this->scrolltop
= $request->getIntOrNull( 'wpScrolltop' );
689 if ( $this->textbox1
=== '' && $request->getVal( 'wpTextbox1' ) === null ) {
690 // wpTextbox1 field is missing, possibly due to being "too big"
691 // according to some filter rules such as Suhosin's setting for
692 // suhosin.request.max_value_length (d'oh)
693 $this->incompleteForm
= true;
695 // edittime should be one of our last fields; if it's missing,
696 // the submission probably broke somewhere in the middle.
697 $this->incompleteForm
= is_null( $this->edittime
);
699 if ( $this->incompleteForm
) {
700 # If the form is incomplete, force to preview.
701 wfDebug( __METHOD__
. ": Form data appears to be incomplete\n" );
702 wfDebug( "POST DATA: " . var_export( $_POST, true ) . "\n" );
703 $this->preview
= true;
705 /* Fallback for live preview */
706 $this->preview
= $request->getCheck( 'wpPreview' ) ||
$request->getCheck( 'wpLivePreview' );
707 $this->diff
= $request->getCheck( 'wpDiff' );
709 // Remember whether a save was requested, so we can indicate
710 // if we forced preview due to session failure.
711 $this->mTriedSave
= !$this->preview
;
713 if ( $this->tokenOk( $request ) ) {
714 # Some browsers will not report any submit button
715 # if the user hits enter in the comment box.
716 # The unmarked state will be assumed to be a save,
717 # if the form seems otherwise complete.
718 wfDebug( __METHOD__
. ": Passed token check.\n" );
719 } elseif ( $this->diff
) {
720 # Failed token check, but only requested "Show Changes".
721 wfDebug( __METHOD__
. ": Failed token check; Show Changes requested.\n" );
723 # Page might be a hack attempt posted from
724 # an external site. Preview instead of saving.
725 wfDebug( __METHOD__
. ": Failed token check; forcing preview\n" );
726 $this->preview
= true;
729 $this->save
= !$this->preview
&& !$this->diff
;
730 if ( !preg_match( '/^\d{14}$/', $this->edittime
) ) {
731 $this->edittime
= null;
734 if ( !preg_match( '/^\d{14}$/', $this->starttime
) ) {
735 $this->starttime
= null;
738 $this->recreate
= $request->getCheck( 'wpRecreate' );
740 $this->minoredit
= $request->getCheck( 'wpMinoredit' );
741 $this->watchthis
= $request->getCheck( 'wpWatchthis' );
743 # Don't force edit summaries when a user is editing their own user or talk page
744 if ( ( $this->mTitle
->mNamespace
== NS_USER ||
$this->mTitle
->mNamespace
== NS_USER_TALK
)
745 && $this->mTitle
->getText() == $wgUser->getName()
747 $this->allowBlankSummary
= true;
749 $this->allowBlankSummary
= $request->getBool( 'wpIgnoreBlankSummary' ) ||
!$wgUser->getOption( 'forceeditsummary' );
752 $this->autoSumm
= $request->getText( 'wpAutoSummary' );
754 # Not a posted form? Start with nothing.
755 wfDebug( __METHOD__
. ": Not a posted form.\n" );
756 $this->textbox1
= '';
758 $this->sectiontitle
= '';
759 $this->edittime
= '';
760 $this->starttime
= wfTimestampNow();
762 $this->preview
= false;
765 $this->minoredit
= false;
766 $this->watchthis
= $request->getBool( 'watchthis', false ); // Watch may be overridden by request parameters
767 $this->recreate
= false;
769 // When creating a new section, we can preload a section title by passing it as the
770 // preloadtitle parameter in the URL (Bug 13100)
771 if ( $this->section
== 'new' && $request->getVal( 'preloadtitle' ) ) {
772 $this->sectiontitle
= $request->getVal( 'preloadtitle' );
773 // Once wpSummary isn't being use for setting section titles, we should delete this.
774 $this->summary
= $request->getVal( 'preloadtitle' );
775 } elseif ( $this->section
!= 'new' && $request->getVal( 'summary' ) ) {
776 $this->summary
= $request->getText( 'summary' );
777 if ( $this->summary
!== '' ) {
778 $this->hasPresetSummary
= true;
782 if ( $request->getVal( 'minor' ) ) {
783 $this->minoredit
= true;
787 $this->oldid
= $request->getInt( 'oldid' );
789 $this->bot
= $request->getBool( 'bot', true );
790 $this->nosummary
= $request->getBool( 'nosummary' );
792 $this->contentModel
= $request->getText( 'model', $this->contentModel
); #may be overridden by revision
793 $this->contentFormat
= $request->getText( 'format', $this->contentFormat
); #may be overridden by revision
795 if ( !ContentHandler
::getForModelID( $this->contentModel
)->isSupportedFormat( $this->contentFormat
) ) {
796 throw new ErrorPageError(
797 'editpage-notsupportedcontentformat-title',
798 'editpage-notsupportedcontentformat-text',
799 array( $this->contentFormat
, ContentHandler
::getLocalizedName( $this->contentModel
) )
802 #TODO: check if the desired model is allowed in this namespace, and if a transition from the page's current model to the new model is allowed
804 $this->live
= $request->getCheck( 'live' );
805 $this->editintro
= $request->getText( 'editintro',
806 // Custom edit intro for new sections
807 $this->section
=== 'new' ?
'MediaWiki:addsection-editintro' : '' );
809 // Allow extensions to modify form data
810 wfRunHooks( 'EditPage::importFormData', array( $this, $request ) );
812 wfProfileOut( __METHOD__
);
816 * Subpage overridable method for extracting the page content data from the
817 * posted form to be placed in $this->textbox1, if using customized input
818 * this method should be overridden and return the page text that will be used
819 * for saving, preview parsing and so on...
821 * @param $request WebRequest
823 protected function importContentFormData( &$request ) {
824 return; // Don't do anything, EditPage already extracted wpTextbox1
828 * Initialise form fields in the object
829 * Called on the first invocation, e.g. when a user clicks an edit link
830 * @return bool -- if the requested section is valid
832 function initialiseForm() {
834 $this->edittime
= $this->mArticle
->getTimestamp();
836 $content = $this->getContentObject( false ); #TODO: track content object?!
837 if ( $content === false ) {
840 $this->textbox1
= $this->toEditText( $content );
842 // activate checkboxes if user wants them to be always active
843 # Sort out the "watch" checkbox
844 if ( $wgUser->getOption( 'watchdefault' ) ) {
846 $this->watchthis
= true;
847 } elseif ( $wgUser->getOption( 'watchcreations' ) && !$this->mTitle
->exists() ) {
849 $this->watchthis
= true;
850 } elseif ( $wgUser->isWatched( $this->mTitle
) ) {
852 $this->watchthis
= true;
854 if ( $wgUser->getOption( 'minordefault' ) && !$this->isNew
) {
855 $this->minoredit
= true;
857 if ( $this->textbox1
=== false ) {
864 * Fetch initial editing page content.
866 * @param $def_text string|bool
867 * @return mixed string on success, $def_text for invalid sections
869 * @deprecated since 1.21, get WikiPage::getContent() instead.
871 function getContent( $def_text = false ) {
872 ContentHandler
::deprecated( __METHOD__
, '1.21' );
874 if ( $def_text !== null && $def_text !== false && $def_text !== '' ) {
875 $def_content = $this->toEditContent( $def_text );
877 $def_content = false;
880 $content = $this->getContentObject( $def_content );
882 // Note: EditPage should only be used with text based content anyway.
883 return $this->toEditText( $content );
887 * @param Content|null $def_content The default value to return
889 * @return mixed Content on success, $def_content for invalid sections
893 protected function getContentObject( $def_content = null ) {
894 global $wgOut, $wgRequest, $wgUser, $wgContLang;
896 wfProfileIn( __METHOD__
);
900 // For message page not locally set, use the i18n message.
901 // For other non-existent articles, use preload text if any.
902 if ( !$this->mTitle
->exists() ||
$this->section
== 'new' ) {
903 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
&& $this->section
!= 'new' ) {
904 # If this is a system message, get the default text.
905 $msg = $this->mTitle
->getDefaultMessageText();
907 $content = $this->toEditContent( $msg );
909 if ( $content === false ) {
910 # If requested, preload some text.
911 $preload = $wgRequest->getVal( 'preload',
912 // Custom preload text for new sections
913 $this->section
=== 'new' ?
'MediaWiki:addsection-preload' : '' );
915 $content = $this->getPreloadedContent( $preload );
917 // For existing pages, get text based on "undo" or section parameters.
919 if ( $this->section
!= '' ) {
920 // Get section edit text (returns $def_text for invalid sections)
921 $orig = $this->getOriginalContent();
922 $content = $orig ?
$orig->getSection( $this->section
) : null;
925 $content = $def_content;
928 $undoafter = $wgRequest->getInt( 'undoafter' );
929 $undo = $wgRequest->getInt( 'undo' );
931 if ( $undo > 0 && $undoafter > 0 ) {
933 $undorev = Revision
::newFromId( $undo );
934 $oldrev = Revision
::newFromId( $undoafter );
936 # Sanity check, make sure it's the right page,
937 # the revisions exist and they were not deleted.
938 # Otherwise, $content will be left as-is.
939 if ( !is_null( $undorev ) && !is_null( $oldrev ) &&
940 !$undorev->isDeleted( Revision
::DELETED_TEXT
) &&
941 !$oldrev->isDeleted( Revision
::DELETED_TEXT
) ) {
943 $content = $this->mArticle
->getUndoContent( $undorev, $oldrev );
945 if ( $content === false ) {
946 # Warn the user that something went wrong
947 $undoMsg = 'failure';
949 $oldContent = $this->mArticle
->getPage()->getContent( Revision
::RAW
);
950 $popts = ParserOptions
::newFromUserAndLang( $wgUser, $wgContLang );
951 $newContent = $content->preSaveTransform( $this->mTitle
, $wgUser, $popts );
953 if ( $newContent->equals( $oldContent ) ) {
954 # Tell the user that the undo results in no change,
955 # i.e. the revisions were already undone.
956 $undoMsg = 'nochange';
959 # Inform the user of our success and set an automatic edit summary
960 $undoMsg = 'success';
962 # If we just undid one rev, use an autosummary
963 $firstrev = $oldrev->getNext();
964 if ( $firstrev && $firstrev->getId() == $undo ) {
965 $userText = $undorev->getUserText();
966 if ( $userText === '' ) {
967 $undoSummary = wfMessage(
968 'undo-summary-username-hidden',
970 )->inContentLanguage()->text();
972 $undoSummary = wfMessage(
976 )->inContentLanguage()->text();
978 if ( $this->summary
=== '' ) {
979 $this->summary
= $undoSummary;
981 $this->summary
= $undoSummary . wfMessage( 'colon-separator' )
982 ->inContentLanguage()->text() . $this->summary
;
984 $this->undidRev
= $undo;
986 $this->formtype
= 'diff';
990 // Failed basic sanity checks.
991 // Older revisions may have been removed since the link
992 // was created, or we may simply have got bogus input.
996 // Messages: undo-success, undo-failure, undo-norev, undo-nochange
997 $class = ( $undoMsg == 'success' ?
'' : 'error ' ) . "mw-undo-{$undoMsg}";
998 $this->editFormPageTop
.= $wgOut->parse( "<div class=\"{$class}\">" .
999 wfMessage( 'undo-' . $undoMsg )->plain() . '</div>', true, /* interface */true );
1002 if ( $content === false ) {
1003 $content = $this->getOriginalContent();
1008 wfProfileOut( __METHOD__
);
1013 * Get the content of the wanted revision, without section extraction.
1015 * The result of this function can be used to compare user's input with
1016 * section replaced in its context (using WikiPage::replaceSection())
1017 * to the original text of the edit.
1019 * This differs from Article::getContent() that when a missing revision is
1020 * encountered the result will be null and not the
1021 * 'missing-revision' message.
1024 * @return Content|null
1026 private function getOriginalContent() {
1027 if ( $this->section
== 'new' ) {
1028 return $this->getCurrentContent();
1030 $revision = $this->mArticle
->getRevisionFetched();
1031 if ( $revision === null ) {
1032 if ( !$this->contentModel
) {
1033 $this->contentModel
= $this->getTitle()->getContentModel();
1035 $handler = ContentHandler
::getForModelID( $this->contentModel
);
1037 return $handler->makeEmptyContent();
1039 $content = $revision->getContent();
1044 * Get the current content of the page. This is basically similar to
1045 * WikiPage::getContent( Revision::RAW ) except that when the page doesn't exist an empty
1046 * content object is returned instead of null.
1051 protected function getCurrentContent() {
1052 $rev = $this->mArticle
->getRevision();
1053 $content = $rev ?
$rev->getContent( Revision
::RAW
) : null;
1055 if ( $content === false ||
$content === null ) {
1056 if ( !$this->contentModel
) {
1057 $this->contentModel
= $this->getTitle()->getContentModel();
1059 $handler = ContentHandler
::getForModelID( $this->contentModel
);
1061 return $handler->makeEmptyContent();
1063 # nasty side-effect, but needed for consistency
1064 $this->contentModel
= $rev->getContentModel();
1065 $this->contentFormat
= $rev->getContentFormat();
1072 * Use this method before edit() to preload some text into the edit box
1074 * @param $text string
1075 * @deprecated since 1.21, use setPreloadedContent() instead.
1077 public function setPreloadedText( $text ) {
1078 ContentHandler
::deprecated( __METHOD__
, "1.21" );
1080 $content = $this->toEditContent( $text );
1082 $this->setPreloadedContent( $content );
1086 * Use this method before edit() to preload some content into the edit box
1088 * @param $content Content
1092 public function setPreloadedContent( Content
$content ) {
1093 $this->mPreloadContent
= $content;
1097 * Get the contents to be preloaded into the box, either set by
1098 * an earlier setPreloadText() or by loading the given page.
1100 * @param string $preload representing the title to preload from.
1104 * @deprecated since 1.21, use getPreloadedContent() instead
1106 protected function getPreloadedText( $preload ) {
1107 ContentHandler
::deprecated( __METHOD__
, "1.21" );
1109 $content = $this->getPreloadedContent( $preload );
1110 $text = $this->toEditText( $content );
1116 * Get the contents to be preloaded into the box, either set by
1117 * an earlier setPreloadText() or by loading the given page.
1119 * @param string $preload representing the title to preload from.
1125 protected function getPreloadedContent( $preload ) {
1128 if ( !empty( $this->mPreloadContent
) ) {
1129 return $this->mPreloadContent
;
1132 $handler = ContentHandler
::getForTitle( $this->getTitle() );
1134 if ( $preload === '' ) {
1135 return $handler->makeEmptyContent();
1138 $title = Title
::newFromText( $preload );
1139 # Check for existence to avoid getting MediaWiki:Noarticletext
1140 if ( $title === null ||
!$title->exists() ||
!$title->userCan( 'read', $wgUser ) ) {
1141 //TODO: somehow show a warning to the user!
1142 return $handler->makeEmptyContent();
1145 $page = WikiPage
::factory( $title );
1146 if ( $page->isRedirect() ) {
1147 $title = $page->getRedirectTarget();
1149 if ( $title === null ||
!$title->exists() ||
!$title->userCan( 'read', $wgUser ) ) {
1150 //TODO: somehow show a warning to the user!
1151 return $handler->makeEmptyContent();
1153 $page = WikiPage
::factory( $title );
1156 $parserOptions = ParserOptions
::newFromUser( $wgUser );
1157 $content = $page->getContent( Revision
::RAW
);
1160 //TODO: somehow show a warning to the user!
1161 return $handler->makeEmptyContent();
1164 if ( $content->getModel() !== $handler->getModelID() ) {
1165 $converted = $content->convert( $handler->getModelID() );
1167 if ( !$converted ) {
1168 //TODO: somehow show a warning to the user!
1169 wfDebug( "Attempt to preload incompatible content: "
1170 . "can't convert " . $content->getModel()
1171 . " to " . $handler->getModelID() );
1173 return $handler->makeEmptyContent();
1176 $content = $converted;
1179 return $content->preloadTransform( $title, $parserOptions );
1183 * Make sure the form isn't faking a user's credentials.
1185 * @param $request WebRequest
1189 function tokenOk( &$request ) {
1191 $token = $request->getVal( 'wpEditToken' );
1192 $this->mTokenOk
= $wgUser->matchEditToken( $token );
1193 $this->mTokenOkExceptSuffix
= $wgUser->matchEditTokenNoSuffix( $token );
1194 return $this->mTokenOk
;
1198 * Sets post-edit cookie indicating the user just saved a particular revision.
1200 * This uses a temporary cookie for each revision ID so separate saves will never
1201 * interfere with each other.
1203 * The cookie is deleted in the mediawiki.action.view.postEdit JS module after
1204 * the redirect. It must be clearable by JavaScript code, so it must not be
1205 * marked HttpOnly. The JavaScript code converts the cookie to a wgPostEdit config
1208 * We use a path of '/' since wgCookiePath is not exposed to JS
1210 * If the variable were set on the server, it would be cached, which is unwanted
1211 * since the post-edit state should only apply to the load right after the save.
1213 protected function setPostEditCookie() {
1214 $revisionId = $this->mArticle
->getLatest();
1215 $postEditKey = self
::POST_EDIT_COOKIE_KEY_PREFIX
. $revisionId;
1217 $response = RequestContext
::getMain()->getRequest()->response();
1218 $response->setcookie( $postEditKey, '1', time() + self
::POST_EDIT_COOKIE_DURATION
, array(
1220 'httpOnly' => false,
1225 * Attempt submission
1226 * @throws UserBlockedError|ReadOnlyError|ThrottledError|PermissionsError
1227 * @return bool false if output is done, true if the rest of the form should be displayed
1229 public function attemptSave() {
1232 $resultDetails = false;
1233 # Allow bots to exempt some edits from bot flagging
1234 $bot = $wgUser->isAllowed( 'bot' ) && $this->bot
;
1235 $status = $this->internalAttemptSave( $resultDetails, $bot );
1237 return $this->handleStatus( $status, $resultDetails );
1241 * Handle status, such as after attempt save
1243 * @param Status $status
1244 * @param array|bool $resultDetails
1246 * @throws ErrorPageError
1247 * return bool false, if output is done, true if rest of the form should be displayed
1249 private function handleStatus( Status
$status, $resultDetails ) {
1250 global $wgUser, $wgOut;
1252 // FIXME: once the interface for internalAttemptSave() is made nicer, this should use the message in $status
1253 if ( $status->value
== self
::AS_SUCCESS_UPDATE ||
$status->value
== self
::AS_SUCCESS_NEW_ARTICLE
) {
1254 $this->didSave
= true;
1255 if ( !$resultDetails['nullEdit'] ) {
1256 $this->setPostEditCookie();
1260 switch ( $status->value
) {
1261 case self
::AS_HOOK_ERROR_EXPECTED
:
1262 case self
::AS_CONTENT_TOO_BIG
:
1263 case self
::AS_ARTICLE_WAS_DELETED
:
1264 case self
::AS_CONFLICT_DETECTED
:
1265 case self
::AS_SUMMARY_NEEDED
:
1266 case self
::AS_TEXTBOX_EMPTY
:
1267 case self
::AS_MAX_ARTICLE_SIZE_EXCEEDED
:
1271 case self
::AS_HOOK_ERROR
:
1274 case self
::AS_PARSE_ERROR
:
1275 $wgOut->addWikiText( '<div class="error">' . $status->getWikiText() . '</div>' );
1278 case self
::AS_SUCCESS_NEW_ARTICLE
:
1279 $query = $resultDetails['redirect'] ?
'redirect=no' : '';
1280 $anchor = isset( $resultDetails['sectionanchor'] ) ?
$resultDetails['sectionanchor'] : '';
1281 $wgOut->redirect( $this->mTitle
->getFullURL( $query ) . $anchor );
1284 case self
::AS_SUCCESS_UPDATE
:
1286 $sectionanchor = $resultDetails['sectionanchor'];
1288 // Give extensions a chance to modify URL query on update
1289 wfRunHooks( 'ArticleUpdateBeforeRedirect', array( $this->mArticle
, &$sectionanchor, &$extraQuery ) );
1291 if ( $resultDetails['redirect'] ) {
1292 if ( $extraQuery == '' ) {
1293 $extraQuery = 'redirect=no';
1295 $extraQuery = 'redirect=no&' . $extraQuery;
1298 $wgOut->redirect( $this->mTitle
->getFullURL( $extraQuery ) . $sectionanchor );
1301 case self
::AS_BLANK_ARTICLE
:
1302 $wgOut->redirect( $this->getContextTitle()->getFullURL() );
1305 case self
::AS_SPAM_ERROR
:
1306 $this->spamPageWithContent( $resultDetails['spam'] );
1309 case self
::AS_BLOCKED_PAGE_FOR_USER
:
1310 throw new UserBlockedError( $wgUser->getBlock() );
1312 case self
::AS_IMAGE_REDIRECT_ANON
:
1313 case self
::AS_IMAGE_REDIRECT_LOGGED
:
1314 throw new PermissionsError( 'upload' );
1316 case self
::AS_READ_ONLY_PAGE_ANON
:
1317 case self
::AS_READ_ONLY_PAGE_LOGGED
:
1318 throw new PermissionsError( 'edit' );
1320 case self
::AS_READ_ONLY_PAGE
:
1321 throw new ReadOnlyError
;
1323 case self
::AS_RATE_LIMITED
:
1324 throw new ThrottledError();
1326 case self
::AS_NO_CREATE_PERMISSION
:
1327 $permission = $this->mTitle
->isTalkPage() ?
'createtalk' : 'createpage';
1328 throw new PermissionsError( $permission );
1331 // We don't recognize $status->value. The only way that can happen
1332 // is if an extension hook aborted from inside ArticleSave.
1333 // Render the status object into $this->hookError
1334 // FIXME this sucks, we should just use the Status object throughout
1335 $this->hookError
= '<div class="error">' . $status->getWikitext() .
1342 * Run hooks that can filter edits just before they get saved.
1344 * @param Content $content the Content to filter.
1345 * @param Status $status for reporting the outcome to the caller
1346 * @param User $user the user performing the edit
1350 protected function runPostMergeFilters( Content
$content, Status
$status, User
$user ) {
1351 // Run old style post-section-merge edit filter
1352 if ( !ContentHandler
::runLegacyHooks( 'EditFilterMerged',
1353 array( $this, $content, &$this->hookError
, $this->summary
) ) ) {
1355 # Error messages etc. could be handled within the hook...
1356 $status->fatal( 'hookaborted' );
1357 $status->value
= self
::AS_HOOK_ERROR
;
1359 } elseif ( $this->hookError
!= '' ) {
1360 # ...or the hook could be expecting us to produce an error
1361 $status->fatal( 'hookaborted' );
1362 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1366 // Run new style post-section-merge edit filter
1367 if ( !wfRunHooks( 'EditFilterMergedContent',
1368 array( $this->mArticle
->getContext(), $content, $status, $this->summary
,
1369 $user, $this->minoredit
) ) ) {
1371 # Error messages etc. could be handled within the hook...
1372 // XXX: $status->value may already be something informative...
1373 $this->hookError
= $status->getWikiText();
1374 $status->fatal( 'hookaborted' );
1375 $status->value
= self
::AS_HOOK_ERROR
;
1377 } elseif ( !$status->isOK() ) {
1378 # ...or the hook could be expecting us to produce an error
1379 // FIXME this sucks, we should just use the Status object throughout
1380 $this->hookError
= $status->getWikiText();
1381 $status->fatal( 'hookaborted' );
1382 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1390 * Attempt submission (no UI)
1392 * @param array $result array to add statuses to, currently with the possible keys:
1393 * spam - string - Spam string from content if any spam is detected by matchSpamRegex
1394 * sectionanchor - string - Section anchor for a section save
1395 * nullEdit - boolean - Set if doEditContent is OK. True if null edit, false otherwise.
1396 * redirect - boolean - Set if doEditContent is OK. True if resulting revision is a redirect
1397 * @param bool $bot True if edit is being made under the bot right.
1399 * @return Status object, possibly with a message, but always with one of the AS_* constants in $status->value,
1401 * FIXME: This interface is TERRIBLE, but hard to get rid of due to various error display idiosyncrasies. There are
1402 * also lots of cases where error metadata is set in the object and retrieved later instead of being returned, e.g.
1403 * AS_CONTENT_TOO_BIG and AS_BLOCKED_PAGE_FOR_USER. All that stuff needs to be cleaned up some time.
1405 function internalAttemptSave( &$result, $bot = false ) {
1406 global $wgUser, $wgRequest, $wgParser, $wgMaxArticleSize;
1408 $status = Status
::newGood();
1410 wfProfileIn( __METHOD__
);
1411 wfProfileIn( __METHOD__
. '-checks' );
1413 if ( !wfRunHooks( 'EditPage::attemptSave', array( $this ) ) ) {
1414 wfDebug( "Hook 'EditPage::attemptSave' aborted article saving\n" );
1415 $status->fatal( 'hookaborted' );
1416 $status->value
= self
::AS_HOOK_ERROR
;
1417 wfProfileOut( __METHOD__
. '-checks' );
1418 wfProfileOut( __METHOD__
);
1422 $spam = $wgRequest->getText( 'wpAntispam' );
1423 if ( $spam !== '' ) {
1426 $wgUser->getName() .
1428 $this->mTitle
->getPrefixedText() .
1429 '" submitted bogus field "' .
1433 $status->fatal( 'spamprotectionmatch', false );
1434 $status->value
= self
::AS_SPAM_ERROR
;
1435 wfProfileOut( __METHOD__
. '-checks' );
1436 wfProfileOut( __METHOD__
);
1441 # Construct Content object
1442 $textbox_content = $this->toEditContent( $this->textbox1
);
1443 } catch ( MWContentSerializationException
$ex ) {
1444 $status->fatal( 'content-failed-to-parse', $this->contentModel
, $this->contentFormat
, $ex->getMessage() );
1445 $status->value
= self
::AS_PARSE_ERROR
;
1446 wfProfileOut( __METHOD__
. '-checks' );
1447 wfProfileOut( __METHOD__
);
1451 # Check image redirect
1452 if ( $this->mTitle
->getNamespace() == NS_FILE
&&
1453 $textbox_content->isRedirect() &&
1454 !$wgUser->isAllowed( 'upload' ) ) {
1455 $code = $wgUser->isAnon() ? self
::AS_IMAGE_REDIRECT_ANON
: self
::AS_IMAGE_REDIRECT_LOGGED
;
1456 $status->setResult( false, $code );
1458 wfProfileOut( __METHOD__
. '-checks' );
1459 wfProfileOut( __METHOD__
);
1465 $match = self
::matchSummarySpamRegex( $this->summary
);
1466 if ( $match === false && $this->section
== 'new' ) {
1467 # $wgSpamRegex is enforced on this new heading/summary because, unlike
1468 # regular summaries, it is added to the actual wikitext.
1469 if ( $this->sectiontitle
!== '' ) {
1470 # This branch is taken when the API is used with the 'sectiontitle' parameter.
1471 $match = self
::matchSpamRegex( $this->sectiontitle
);
1473 # This branch is taken when the "Add Topic" user interface is used, or the API
1474 # is used with the 'summary' parameter.
1475 $match = self
::matchSpamRegex( $this->summary
);
1478 if ( $match === false ) {
1479 $match = self
::matchSpamRegex( $this->textbox1
);
1481 if ( $match !== false ) {
1482 $result['spam'] = $match;
1483 $ip = $wgRequest->getIP();
1484 $pdbk = $this->mTitle
->getPrefixedDBkey();
1485 $match = str_replace( "\n", '', $match );
1486 wfDebugLog( 'SpamRegex', "$ip spam regex hit [[$pdbk]]: \"$match\"" );
1487 $status->fatal( 'spamprotectionmatch', $match );
1488 $status->value
= self
::AS_SPAM_ERROR
;
1489 wfProfileOut( __METHOD__
. '-checks' );
1490 wfProfileOut( __METHOD__
);
1493 if ( !wfRunHooks( 'EditFilter', array( $this, $this->textbox1
, $this->section
, &$this->hookError
, $this->summary
) ) ) {
1494 # Error messages etc. could be handled within the hook...
1495 $status->fatal( 'hookaborted' );
1496 $status->value
= self
::AS_HOOK_ERROR
;
1497 wfProfileOut( __METHOD__
. '-checks' );
1498 wfProfileOut( __METHOD__
);
1500 } elseif ( $this->hookError
!= '' ) {
1501 # ...or the hook could be expecting us to produce an error
1502 $status->fatal( 'hookaborted' );
1503 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1504 wfProfileOut( __METHOD__
. '-checks' );
1505 wfProfileOut( __METHOD__
);
1509 if ( $wgUser->isBlockedFrom( $this->mTitle
, false ) ) {
1510 // Auto-block user's IP if the account was "hard" blocked
1511 $wgUser->spreadAnyEditBlock();
1512 # Check block state against master, thus 'false'.
1513 $status->setResult( false, self
::AS_BLOCKED_PAGE_FOR_USER
);
1514 wfProfileOut( __METHOD__
. '-checks' );
1515 wfProfileOut( __METHOD__
);
1519 $this->kblength
= (int)( strlen( $this->textbox1
) / 1024 );
1520 if ( $this->kblength
> $wgMaxArticleSize ) {
1521 // Error will be displayed by showEditForm()
1522 $this->tooBig
= true;
1523 $status->setResult( false, self
::AS_CONTENT_TOO_BIG
);
1524 wfProfileOut( __METHOD__
. '-checks' );
1525 wfProfileOut( __METHOD__
);
1529 if ( !$wgUser->isAllowed( 'edit' ) ) {
1530 if ( $wgUser->isAnon() ) {
1531 $status->setResult( false, self
::AS_READ_ONLY_PAGE_ANON
);
1532 wfProfileOut( __METHOD__
. '-checks' );
1533 wfProfileOut( __METHOD__
);
1536 $status->fatal( 'readonlytext' );
1537 $status->value
= self
::AS_READ_ONLY_PAGE_LOGGED
;
1538 wfProfileOut( __METHOD__
. '-checks' );
1539 wfProfileOut( __METHOD__
);
1544 if ( wfReadOnly() ) {
1545 $status->fatal( 'readonlytext' );
1546 $status->value
= self
::AS_READ_ONLY_PAGE
;
1547 wfProfileOut( __METHOD__
. '-checks' );
1548 wfProfileOut( __METHOD__
);
1551 if ( $wgUser->pingLimiter() ||
$wgUser->pingLimiter( 'linkpurge', 0 ) ) {
1552 $status->fatal( 'actionthrottledtext' );
1553 $status->value
= self
::AS_RATE_LIMITED
;
1554 wfProfileOut( __METHOD__
. '-checks' );
1555 wfProfileOut( __METHOD__
);
1559 # If the article has been deleted while editing, don't save it without
1561 if ( $this->wasDeletedSinceLastEdit() && !$this->recreate
) {
1562 $status->setResult( false, self
::AS_ARTICLE_WAS_DELETED
);
1563 wfProfileOut( __METHOD__
. '-checks' );
1564 wfProfileOut( __METHOD__
);
1568 wfProfileOut( __METHOD__
. '-checks' );
1570 # Load the page data from the master. If anything changes in the meantime,
1571 # we detect it by using page_latest like a token in a 1 try compare-and-swap.
1572 $this->mArticle
->loadPageData( 'fromdbmaster' );
1573 $new = !$this->mArticle
->exists();
1576 // Late check for create permission, just in case *PARANOIA*
1577 if ( !$this->mTitle
->userCan( 'create', $wgUser ) ) {
1578 $status->fatal( 'nocreatetext' );
1579 $status->value
= self
::AS_NO_CREATE_PERMISSION
;
1580 wfDebug( __METHOD__
. ": no create permission\n" );
1581 wfProfileOut( __METHOD__
);
1585 // Don't save a new page if it's blank or if it's a MediaWiki:
1586 // message with content equivalent to default (allow empty pages
1587 // in this case to disable messages, see bug 50124)
1588 $defaultMessageText = $this->mTitle
->getDefaultMessageText();
1589 if ( $this->mTitle
->getNamespace() === NS_MEDIAWIKI
&& $defaultMessageText !== false ) {
1590 $defaultText = $defaultMessageText;
1595 if ( $this->textbox1
=== $defaultText ) {
1596 $status->setResult( false, self
::AS_BLANK_ARTICLE
);
1597 wfProfileOut( __METHOD__
);
1601 if ( !$this->runPostMergeFilters( $textbox_content, $status, $wgUser ) ) {
1602 wfProfileOut( __METHOD__
);
1606 $content = $textbox_content;
1608 $result['sectionanchor'] = '';
1609 if ( $this->section
== 'new' ) {
1610 if ( $this->sectiontitle
!== '' ) {
1611 // Insert the section title above the content.
1612 $content = $content->addSectionHeader( $this->sectiontitle
);
1614 // Jump to the new section
1615 $result['sectionanchor'] = $wgParser->guessLegacySectionNameFromWikiText( $this->sectiontitle
);
1617 // If no edit summary was specified, create one automatically from the section
1618 // title and have it link to the new section. Otherwise, respect the summary as
1620 if ( $this->summary
=== '' ) {
1621 $cleanSectionTitle = $wgParser->stripSectionName( $this->sectiontitle
);
1622 $this->summary
= wfMessage( 'newsectionsummary' )
1623 ->rawParams( $cleanSectionTitle )->inContentLanguage()->text();
1625 } elseif ( $this->summary
!== '' ) {
1626 // Insert the section title above the content.
1627 $content = $content->addSectionHeader( $this->summary
);
1629 // Jump to the new section
1630 $result['sectionanchor'] = $wgParser->guessLegacySectionNameFromWikiText( $this->summary
);
1632 // Create a link to the new section from the edit summary.
1633 $cleanSummary = $wgParser->stripSectionName( $this->summary
);
1634 $this->summary
= wfMessage( 'newsectionsummary' )
1635 ->rawParams( $cleanSummary )->inContentLanguage()->text();
1639 $status->value
= self
::AS_SUCCESS_NEW_ARTICLE
;
1643 # Article exists. Check for edit conflict.
1645 $this->mArticle
->clear(); # Force reload of dates, etc.
1646 $timestamp = $this->mArticle
->getTimestamp();
1648 wfDebug( "timestamp: {$timestamp}, edittime: {$this->edittime}\n" );
1650 if ( $timestamp != $this->edittime
) {
1651 $this->isConflict
= true;
1652 if ( $this->section
== 'new' ) {
1653 if ( $this->mArticle
->getUserText() == $wgUser->getName() &&
1654 $this->mArticle
->getComment() == $this->summary
) {
1655 // Probably a duplicate submission of a new comment.
1656 // This can happen when squid resends a request after
1657 // a timeout but the first one actually went through.
1658 wfDebug( __METHOD__
. ": duplicate new section submission; trigger edit conflict!\n" );
1660 // New comment; suppress conflict.
1661 $this->isConflict
= false;
1662 wfDebug( __METHOD__
. ": conflict suppressed; new section\n" );
1664 } elseif ( $this->section
== '' && Revision
::userWasLastToEdit( DB_MASTER
, $this->mTitle
->getArticleID(),
1665 $wgUser->getId(), $this->edittime
) ) {
1666 # Suppress edit conflict with self, except for section edits where merging is required.
1667 wfDebug( __METHOD__
. ": Suppressing edit conflict, same user.\n" );
1668 $this->isConflict
= false;
1672 // If sectiontitle is set, use it, otherwise use the summary as the section title.
1673 if ( $this->sectiontitle
!== '' ) {
1674 $sectionTitle = $this->sectiontitle
;
1676 $sectionTitle = $this->summary
;
1681 if ( $this->isConflict
) {
1682 wfDebug( __METHOD__
. ": conflict! getting section '{$this->section}' for time '{$this->edittime}'"
1683 . " (article time '{$timestamp}')\n" );
1685 $content = $this->mArticle
->replaceSectionContent( $this->section
, $textbox_content, $sectionTitle, $this->edittime
);
1687 wfDebug( __METHOD__
. ": getting section '{$this->section}'\n" );
1688 $content = $this->mArticle
->replaceSectionContent( $this->section
, $textbox_content, $sectionTitle );
1691 if ( is_null( $content ) ) {
1692 wfDebug( __METHOD__
. ": activating conflict; section replace failed.\n" );
1693 $this->isConflict
= true;
1694 $content = $textbox_content; // do not try to merge here!
1695 } elseif ( $this->isConflict
) {
1697 if ( $this->mergeChangesIntoContent( $content ) ) {
1698 // Successful merge! Maybe we should tell the user the good news?
1699 $this->isConflict
= false;
1700 wfDebug( __METHOD__
. ": Suppressing edit conflict, successful merge.\n" );
1702 $this->section
= '';
1703 $this->textbox1
= ContentHandler
::getContentText( $content );
1704 wfDebug( __METHOD__
. ": Keeping edit conflict, failed merge.\n" );
1708 if ( $this->isConflict
) {
1709 $status->setResult( false, self
::AS_CONFLICT_DETECTED
);
1710 wfProfileOut( __METHOD__
);
1714 if ( !$this->runPostMergeFilters( $content, $status, $wgUser ) ) {
1715 wfProfileOut( __METHOD__
);
1719 if ( $this->section
== 'new' ) {
1720 // Handle the user preference to force summaries here
1721 if ( !$this->allowBlankSummary
&& trim( $this->summary
) == '' ) {
1722 $this->missingSummary
= true;
1723 $status->fatal( 'missingsummary' ); // or 'missingcommentheader' if $section == 'new'. Blegh
1724 $status->value
= self
::AS_SUMMARY_NEEDED
;
1725 wfProfileOut( __METHOD__
);
1729 // Do not allow the user to post an empty comment
1730 if ( $this->textbox1
== '' ) {
1731 $this->missingComment
= true;
1732 $status->fatal( 'missingcommenttext' );
1733 $status->value
= self
::AS_TEXTBOX_EMPTY
;
1734 wfProfileOut( __METHOD__
);
1737 } elseif ( !$this->allowBlankSummary
1738 && !$content->equals( $this->getOriginalContent() )
1739 && !$content->isRedirect()
1740 && md5( $this->summary
) == $this->autoSumm
1742 $this->missingSummary
= true;
1743 $status->fatal( 'missingsummary' );
1744 $status->value
= self
::AS_SUMMARY_NEEDED
;
1745 wfProfileOut( __METHOD__
);
1750 wfProfileIn( __METHOD__
. '-sectionanchor' );
1751 $sectionanchor = '';
1752 if ( $this->section
== 'new' ) {
1753 if ( $this->sectiontitle
!== '' ) {
1754 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $this->sectiontitle
);
1755 // If no edit summary was specified, create one automatically from the section
1756 // title and have it link to the new section. Otherwise, respect the summary as
1758 if ( $this->summary
=== '' ) {
1759 $cleanSectionTitle = $wgParser->stripSectionName( $this->sectiontitle
);
1760 $this->summary
= wfMessage( 'newsectionsummary' )
1761 ->rawParams( $cleanSectionTitle )->inContentLanguage()->text();
1763 } elseif ( $this->summary
!== '' ) {
1764 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $this->summary
);
1765 # This is a new section, so create a link to the new section
1766 # in the revision summary.
1767 $cleanSummary = $wgParser->stripSectionName( $this->summary
);
1768 $this->summary
= wfMessage( 'newsectionsummary' )
1769 ->rawParams( $cleanSummary )->inContentLanguage()->text();
1771 } elseif ( $this->section
!= '' ) {
1772 # Try to get a section anchor from the section source, redirect to edited section if header found
1773 # XXX: might be better to integrate this into Article::replaceSection
1774 # for duplicate heading checking and maybe parsing
1775 $hasmatch = preg_match( "/^ *([=]{1,6})(.*?)(\\1) *\\n/i", $this->textbox1
, $matches );
1776 # we can't deal with anchors, includes, html etc in the header for now,
1777 # headline would need to be parsed to improve this
1778 if ( $hasmatch && strlen( $matches[2] ) > 0 ) {
1779 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $matches[2] );
1782 $result['sectionanchor'] = $sectionanchor;
1783 wfProfileOut( __METHOD__
. '-sectionanchor' );
1785 // Save errors may fall down to the edit form, but we've now
1786 // merged the section into full text. Clear the section field
1787 // so that later submission of conflict forms won't try to
1788 // replace that into a duplicated mess.
1789 $this->textbox1
= $this->toEditText( $content );
1790 $this->section
= '';
1792 $status->value
= self
::AS_SUCCESS_UPDATE
;
1795 // Check for length errors again now that the section is merged in
1796 $this->kblength
= (int)( strlen( $this->toEditText( $content ) ) / 1024 );
1797 if ( $this->kblength
> $wgMaxArticleSize ) {
1798 $this->tooBig
= true;
1799 $status->setResult( false, self
::AS_MAX_ARTICLE_SIZE_EXCEEDED
);
1800 wfProfileOut( __METHOD__
);
1804 $flags = EDIT_DEFER_UPDATES | EDIT_AUTOSUMMARY |
1805 ( $new ? EDIT_NEW
: EDIT_UPDATE
) |
1806 ( ( $this->minoredit
&& !$this->isNew
) ? EDIT_MINOR
: 0 ) |
1807 ( $bot ? EDIT_FORCE_BOT
: 0 );
1809 $doEditStatus = $this->mArticle
->doEditContent( $content, $this->summary
, $flags,
1810 false, null, $this->contentFormat
);
1812 if ( !$doEditStatus->isOK() ) {
1813 // Failure from doEdit()
1814 // Show the edit conflict page for certain recognized errors from doEdit(),
1815 // but don't show it for errors from extension hooks
1816 $errors = $doEditStatus->getErrorsArray();
1817 if ( in_array( $errors[0][0],
1818 array( 'edit-gone-missing', 'edit-conflict', 'edit-already-exists' ) )
1820 $this->isConflict
= true;
1821 // Destroys data doEdit() put in $status->value but who cares
1822 $doEditStatus->value
= self
::AS_END
;
1824 wfProfileOut( __METHOD__
);
1825 return $doEditStatus;
1828 $result['nullEdit'] = $doEditStatus->hasMessage( 'edit-no-change' );
1829 if ( $result['nullEdit'] ) {
1830 // We don't know if it was a null edit until now, so increment here
1831 $wgUser->pingLimiter( 'linkpurge' );
1833 $result['redirect'] = $content->isRedirect();
1834 $this->updateWatchlist();
1835 wfProfileOut( __METHOD__
);
1840 * Register the change of watch status
1842 protected function updateWatchlist() {
1845 if ( $wgUser->isLoggedIn()
1846 && $this->watchthis
!= $wgUser->isWatched( $this->mTitle
, WatchedItem
::IGNORE_USER_RIGHTS
)
1848 $fname = __METHOD__
;
1849 $title = $this->mTitle
;
1850 $watch = $this->watchthis
;
1852 // Do this in its own transaction to reduce contention...
1853 $dbw = wfGetDB( DB_MASTER
);
1854 $dbw->onTransactionIdle( function() use ( $dbw, $title, $watch, $wgUser, $fname ) {
1855 $dbw->begin( $fname );
1856 WatchAction
::doWatchOrUnwatch( $watch, $title, $wgUser );
1857 $dbw->commit( $fname );
1863 * Attempts to merge text content with base and current revisions
1865 * @param $editText string
1868 * @deprecated since 1.21, use mergeChangesIntoContent() instead
1870 function mergeChangesInto( &$editText ) {
1871 ContentHandler
::deprecated( __METHOD__
, "1.21" );
1873 $editContent = $this->toEditContent( $editText );
1875 $ok = $this->mergeChangesIntoContent( $editContent );
1878 $editText = $this->toEditText( $editContent );
1885 * Attempts to do 3-way merge of edit content with a base revision
1886 * and current content, in case of edit conflict, in whichever way appropriate
1887 * for the content type.
1891 * @param $editContent
1895 private function mergeChangesIntoContent( &$editContent ) {
1896 wfProfileIn( __METHOD__
);
1898 $db = wfGetDB( DB_MASTER
);
1900 // This is the revision the editor started from
1901 $baseRevision = $this->getBaseRevision();
1902 $baseContent = $baseRevision ?
$baseRevision->getContent() : null;
1904 if ( is_null( $baseContent ) ) {
1905 wfProfileOut( __METHOD__
);
1909 // The current state, we want to merge updates into it
1910 $currentRevision = Revision
::loadFromTitle( $db, $this->mTitle
);
1911 $currentContent = $currentRevision ?
$currentRevision->getContent() : null;
1913 if ( is_null( $currentContent ) ) {
1914 wfProfileOut( __METHOD__
);
1918 $handler = ContentHandler
::getForModelID( $baseContent->getModel() );
1920 $result = $handler->merge3( $baseContent, $editContent, $currentContent );
1923 $editContent = $result;
1924 wfProfileOut( __METHOD__
);
1928 wfProfileOut( __METHOD__
);
1935 function getBaseRevision() {
1936 if ( !$this->mBaseRevision
) {
1937 $db = wfGetDB( DB_MASTER
);
1938 $this->mBaseRevision
= Revision
::loadFromTimestamp(
1939 $db, $this->mTitle
, $this->edittime
);
1941 return $this->mBaseRevision
;
1945 * Check given input text against $wgSpamRegex, and return the text of the first match.
1947 * @param $text string
1949 * @return string|bool matching string or false
1951 public static function matchSpamRegex( $text ) {
1952 global $wgSpamRegex;
1953 // For back compatibility, $wgSpamRegex may be a single string or an array of regexes.
1954 $regexes = (array)$wgSpamRegex;
1955 return self
::matchSpamRegexInternal( $text, $regexes );
1959 * Check given input text against $wgSummarySpamRegex, and return the text of the first match.
1961 * @param $text string
1963 * @return string|bool matching string or false
1965 public static function matchSummarySpamRegex( $text ) {
1966 global $wgSummarySpamRegex;
1967 $regexes = (array)$wgSummarySpamRegex;
1968 return self
::matchSpamRegexInternal( $text, $regexes );
1972 * @param $text string
1973 * @param $regexes array
1974 * @return bool|string
1976 protected static function matchSpamRegexInternal( $text, $regexes ) {
1977 foreach ( $regexes as $regex ) {
1979 if ( preg_match( $regex, $text, $matches ) ) {
1986 function setHeaders() {
1987 global $wgOut, $wgUser;
1989 $wgOut->addModules( 'mediawiki.action.edit' );
1990 $wgOut->addModuleStyles( 'mediawiki.action.edit.styles' );
1992 if ( $wgUser->getOption( 'uselivepreview', false ) ) {
1993 $wgOut->addModules( 'mediawiki.action.edit.preview' );
1996 if ( $wgUser->getOption( 'useeditwarning', false ) ) {
1997 $wgOut->addModules( 'mediawiki.action.edit.editWarning' );
2000 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2002 # Enabled article-related sidebar, toplinks, etc.
2003 $wgOut->setArticleRelated( true );
2005 $contextTitle = $this->getContextTitle();
2006 if ( $this->isConflict
) {
2007 $msg = 'editconflict';
2008 } elseif ( $contextTitle->exists() && $this->section
!= '' ) {
2009 $msg = $this->section
== 'new' ?
'editingcomment' : 'editingsection';
2011 $msg = $contextTitle->exists() ||
( $contextTitle->getNamespace() == NS_MEDIAWIKI
&& $contextTitle->getDefaultMessageText() !== false ) ?
2012 'editing' : 'creating';
2014 # Use the title defined by DISPLAYTITLE magic word when present
2015 $displayTitle = isset( $this->mParserOutput
) ?
$this->mParserOutput
->getDisplayTitle() : false;
2016 if ( $displayTitle === false ) {
2017 $displayTitle = $contextTitle->getPrefixedText();
2019 $wgOut->setPageTitle( wfMessage( $msg, $displayTitle ) );
2023 * Show all applicable editing introductions
2025 protected function showIntro() {
2026 global $wgOut, $wgUser;
2027 if ( $this->suppressIntro
) {
2031 $namespace = $this->mTitle
->getNamespace();
2033 if ( $namespace == NS_MEDIAWIKI
) {
2034 # Show a warning if editing an interface message
2035 $wgOut->wrapWikiMsg( "<div class='mw-editinginterface'>\n$1\n</div>", 'editinginterface' );
2036 } elseif ( $namespace == NS_FILE
) {
2037 # Show a hint to shared repo
2038 $file = wfFindFile( $this->mTitle
);
2039 if ( $file && !$file->isLocal() ) {
2040 $descUrl = $file->getDescriptionUrl();
2041 # there must be a description url to show a hint to shared repo
2043 if ( !$this->mTitle
->exists() ) {
2044 $wgOut->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-create\">\n$1\n</div>", array(
2045 'sharedupload-desc-create', $file->getRepo()->getDisplayName(), $descUrl
2048 $wgOut->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-edit\">\n$1\n</div>", array(
2049 'sharedupload-desc-edit', $file->getRepo()->getDisplayName(), $descUrl
2056 # Show a warning message when someone creates/edits a user (talk) page but the user does not exist
2057 # Show log extract when the user is currently blocked
2058 if ( $namespace == NS_USER ||
$namespace == NS_USER_TALK
) {
2059 $parts = explode( '/', $this->mTitle
->getText(), 2 );
2060 $username = $parts[0];
2061 $user = User
::newFromName( $username, false /* allow IP users*/ );
2062 $ip = User
::isIP( $username );
2063 if ( !( $user && $user->isLoggedIn() ) && !$ip ) { # User does not exist
2064 $wgOut->wrapWikiMsg( "<div class=\"mw-userpage-userdoesnotexist error\">\n$1\n</div>",
2065 array( 'userpage-userdoesnotexist', wfEscapeWikiText( $username ) ) );
2066 } elseif ( $user->isBlocked() ) { # Show log extract if the user is currently blocked
2067 LogEventsList
::showLogExtract(
2070 $user->getUserPage(),
2074 'showIfEmpty' => false,
2076 'blocked-notice-logextract',
2077 $user->getName() # Support GENDER in notice
2083 # Try to add a custom edit intro, or use the standard one if this is not possible.
2084 if ( !$this->showCustomIntro() && !$this->mTitle
->exists() ) {
2085 if ( $wgUser->isLoggedIn() ) {
2086 $wgOut->wrapWikiMsg( "<div class=\"mw-newarticletext\">\n$1\n</div>", 'newarticletext' );
2088 $wgOut->wrapWikiMsg( "<div class=\"mw-newarticletextanon\">\n$1\n</div>", 'newarticletextanon' );
2091 # Give a notice if the user is editing a deleted/moved page...
2092 if ( !$this->mTitle
->exists() ) {
2093 LogEventsList
::showLogExtract( $wgOut, array( 'delete', 'move' ), $this->mTitle
,
2097 'conds' => array( "log_action != 'revision'" ),
2098 'showIfEmpty' => false,
2099 'msgKey' => array( 'recreate-moveddeleted-warn' )
2106 * Attempt to show a custom editing introduction, if supplied
2110 protected function showCustomIntro() {
2111 if ( $this->editintro
) {
2112 $title = Title
::newFromText( $this->editintro
);
2113 if ( $title instanceof Title
&& $title->exists() && $title->userCan( 'read' ) ) {
2115 // Added using template syntax, to take <noinclude>'s into account.
2116 $wgOut->addWikiTextTitleTidy( '{{:' . $title->getFullText() . '}}', $this->mTitle
);
2124 * Gets an editable textual representation of $content.
2125 * The textual representation can be turned by into a Content object by the
2126 * toEditContent() method.
2128 * If $content is null or false or a string, $content is returned unchanged.
2130 * If the given Content object is not of a type that can be edited using the text base EditPage,
2131 * an exception will be raised. Set $this->allowNonTextContent to true to allow editing of non-textual
2134 * @param Content|null|bool|string $content
2135 * @return String the editable text form of the content.
2137 * @throws MWException if $content is not an instance of TextContent and $this->allowNonTextContent is not true.
2139 protected function toEditText( $content ) {
2140 if ( $content === null ||
$content === false ) {
2144 if ( is_string( $content ) ) {
2148 if ( !$this->isSupportedContentModel( $content->getModel() ) ) {
2149 throw new MWException( 'This content model is not supported: '
2150 . ContentHandler
::getLocalizedName( $content->getModel() ) );
2153 return $content->serialize( $this->contentFormat
);
2157 * Turns the given text into a Content object by unserializing it.
2159 * If the resulting Content object is not of a type that can be edited using the text base EditPage,
2160 * an exception will be raised. Set $this->allowNonTextContent to true to allow editing of non-textual
2163 * @param string|null|bool $text Text to unserialize
2164 * @return Content The content object created from $text. If $text was false or null, false resp. null will be
2167 * @throws MWException if unserializing the text results in a Content object that is not an instance of TextContent
2168 * and $this->allowNonTextContent is not true.
2170 protected function toEditContent( $text ) {
2171 if ( $text === false ||
$text === null ) {
2175 $content = ContentHandler
::makeContent( $text, $this->getTitle(),
2176 $this->contentModel
, $this->contentFormat
);
2178 if ( !$this->isSupportedContentModel( $content->getModel() ) ) {
2179 throw new MWException( 'This content model is not supported: '
2180 . ContentHandler
::getLocalizedName( $content->getModel() ) );
2187 * Send the edit form and related headers to $wgOut
2188 * @param $formCallback Callback|null that takes an OutputPage parameter; will be called
2189 * during form output near the top, for captchas and the like.
2191 function showEditForm( $formCallback = null ) {
2192 global $wgOut, $wgUser;
2194 wfProfileIn( __METHOD__
);
2196 # need to parse the preview early so that we know which templates are used,
2197 # otherwise users with "show preview after edit box" will get a blank list
2198 # we parse this near the beginning so that setHeaders can do the title
2199 # setting work instead of leaving it in getPreviewText
2200 $previewOutput = '';
2201 if ( $this->formtype
== 'preview' ) {
2202 $previewOutput = $this->getPreviewText();
2205 wfRunHooks( 'EditPage::showEditForm:initial', array( &$this, &$wgOut ) );
2207 $this->setHeaders();
2209 if ( $this->showHeader() === false ) {
2210 wfProfileOut( __METHOD__
);
2214 $wgOut->addHTML( $this->editFormPageTop
);
2216 if ( $wgUser->getOption( 'previewontop' ) ) {
2217 $this->displayPreviewArea( $previewOutput, true );
2220 $wgOut->addHTML( $this->editFormTextTop
);
2222 $showToolbar = true;
2223 if ( $this->wasDeletedSinceLastEdit() ) {
2224 if ( $this->formtype
== 'save' ) {
2225 // Hide the toolbar and edit area, user can click preview to get it back
2226 // Add an confirmation checkbox and explanation.
2227 $showToolbar = false;
2229 $wgOut->wrapWikiMsg( "<div class='error mw-deleted-while-editing'>\n$1\n</div>",
2230 'deletedwhileediting' );
2234 // @todo add EditForm plugin interface and use it here!
2235 // search for textarea1 and textares2, and allow EditForm to override all uses.
2236 $wgOut->addHTML( Html
::openElement( 'form', array( 'id' => self
::EDITFORM_ID
, 'name' => self
::EDITFORM_ID
,
2237 'method' => 'post', 'action' => $this->getActionURL( $this->getContextTitle() ),
2238 'enctype' => 'multipart/form-data' ) ) );
2240 if ( is_callable( $formCallback ) ) {
2241 call_user_func_array( $formCallback, array( &$wgOut ) );
2244 // Add an empty field to trip up spambots
2246 Xml
::openElement( 'div', array( 'id' => 'antispam-container', 'style' => 'display: none;' ) )
2247 . Html
::rawElement( 'label', array( 'for' => 'wpAntiSpam' ), wfMessage( 'simpleantispam-label' )->parse() )
2248 . Xml
::element( 'input', array( 'type' => 'text', 'name' => 'wpAntispam', 'id' => 'wpAntispam', 'value' => '' ) )
2249 . Xml
::closeElement( 'div' )
2252 wfRunHooks( 'EditPage::showEditForm:fields', array( &$this, &$wgOut ) );
2254 // Put these up at the top to ensure they aren't lost on early form submission
2255 $this->showFormBeforeText();
2257 if ( $this->wasDeletedSinceLastEdit() && 'save' == $this->formtype
) {
2258 $username = $this->lastDelete
->user_name
;
2259 $comment = $this->lastDelete
->log_comment
;
2261 // It is better to not parse the comment at all than to have templates expanded in the middle
2262 // TODO: can the checkLabel be moved outside of the div so that wrapWikiMsg could be used?
2263 $key = $comment === ''
2264 ?
'confirmrecreate-noreason'
2265 : 'confirmrecreate';
2267 '<div class="mw-confirm-recreate">' .
2268 wfMessage( $key, $username, "<nowiki>$comment</nowiki>" )->parse() .
2269 Xml
::checkLabel( wfMessage( 'recreate' )->text(), 'wpRecreate', 'wpRecreate', false,
2270 array( 'title' => Linker
::titleAttrib( 'recreate' ), 'tabindex' => 1, 'id' => 'wpRecreate' )
2276 # When the summary is hidden, also hide them on preview/show changes
2277 if ( $this->nosummary
) {
2278 $wgOut->addHTML( Html
::hidden( 'nosummary', true ) );
2281 # If a blank edit summary was previously provided, and the appropriate
2282 # user preference is active, pass a hidden tag as wpIgnoreBlankSummary. This will stop the
2283 # user being bounced back more than once in the event that a summary
2286 # For a bit more sophisticated detection of blank summaries, hash the
2287 # automatic one and pass that in the hidden field wpAutoSummary.
2288 if ( $this->missingSummary ||
( $this->section
== 'new' && $this->nosummary
) ) {
2289 $wgOut->addHTML( Html
::hidden( 'wpIgnoreBlankSummary', true ) );
2292 if ( $this->undidRev
) {
2293 $wgOut->addHTML( Html
::hidden( 'wpUndidRevision', $this->undidRev
) );
2296 if ( $this->hasPresetSummary
) {
2297 // If a summary has been preset using &summary= we don't want to prompt for
2298 // a different summary. Only prompt for a summary if the summary is blanked.
2300 $this->autoSumm
= md5( '' );
2303 $autosumm = $this->autoSumm ?
$this->autoSumm
: md5( $this->summary
);
2304 $wgOut->addHTML( Html
::hidden( 'wpAutoSummary', $autosumm ) );
2306 $wgOut->addHTML( Html
::hidden( 'oldid', $this->oldid
) );
2308 $wgOut->addHTML( Html
::hidden( 'format', $this->contentFormat
) );
2309 $wgOut->addHTML( Html
::hidden( 'model', $this->contentModel
) );
2311 if ( $this->section
== 'new' ) {
2312 $this->showSummaryInput( true, $this->summary
);
2313 $wgOut->addHTML( $this->getSummaryPreview( true, $this->summary
) );
2316 $wgOut->addHTML( $this->editFormTextBeforeContent
);
2318 if ( !$this->isCssJsSubpage
&& $showToolbar && $wgUser->getOption( 'showtoolbar' ) ) {
2319 $wgOut->addHTML( EditPage
::getEditToolbar() );
2322 if ( $this->isConflict
) {
2323 // In an edit conflict bypass the overridable content form method
2324 // and fallback to the raw wpTextbox1 since editconflicts can't be
2325 // resolved between page source edits and custom ui edits using the
2327 $this->textbox2
= $this->textbox1
;
2329 $content = $this->getCurrentContent();
2330 $this->textbox1
= $this->toEditText( $content );
2332 $this->showTextbox1();
2334 $this->showContentForm();
2337 $wgOut->addHTML( $this->editFormTextAfterContent
);
2339 $this->showStandardInputs();
2341 $this->showFormAfterText();
2343 $this->showTosSummary();
2345 $this->showEditTools();
2347 $wgOut->addHTML( $this->editFormTextAfterTools
. "\n" );
2349 $wgOut->addHTML( Html
::rawElement( 'div', array( 'class' => 'templatesUsed' ),
2350 Linker
::formatTemplates( $this->getTemplates(), $this->preview
, $this->section
!= '' ) ) );
2352 $wgOut->addHTML( Html
::rawElement( 'div', array( 'class' => 'hiddencats' ),
2353 Linker
::formatHiddenCategories( $this->mArticle
->getHiddenCategories() ) ) );
2355 $wgOut->addHTML( Html
::rawElement( 'div', array( 'class' => 'limitreport' ),
2356 self
::getPreviewLimitReport( $this->mParserOutput
) ) );
2358 $wgOut->addModules( 'mediawiki.action.edit.collapsibleFooter' );
2360 if ( $this->isConflict
) {
2362 $this->showConflict();
2363 } catch ( MWContentSerializationException
$ex ) {
2364 // this can't really happen, but be nice if it does.
2365 $msg = wfMessage( 'content-failed-to-parse', $this->contentModel
, $this->contentFormat
, $ex->getMessage() );
2366 $wgOut->addWikiText( '<div class="error">' . $msg->text() . '</div>' );
2370 $wgOut->addHTML( $this->editFormTextBottom
. "\n</form>\n" );
2372 if ( !$wgUser->getOption( 'previewontop' ) ) {
2373 $this->displayPreviewArea( $previewOutput, false );
2376 wfProfileOut( __METHOD__
);
2380 * Extract the section title from current section text, if any.
2382 * @param string $text
2383 * @return Mixed|string or false
2385 public static function extractSectionTitle( $text ) {
2386 preg_match( "/^(=+)(.+)\\1\\s*(\n|$)/i", $text, $matches );
2387 if ( !empty( $matches[2] ) ) {
2389 return $wgParser->stripSectionName( trim( $matches[2] ) );
2395 protected function showHeader() {
2396 global $wgOut, $wgUser, $wgMaxArticleSize, $wgLang;
2398 if ( $this->mTitle
->isTalkPage() ) {
2399 $wgOut->addWikiMsg( 'talkpagetext' );
2403 $wgOut->addHTML( implode( "\n", $this->mTitle
->getEditNotices( $this->oldid
) ) );
2405 if ( $this->isConflict
) {
2406 $wgOut->wrapWikiMsg( "<div class='mw-explainconflict'>\n$1\n</div>", 'explainconflict' );
2407 $this->edittime
= $this->mArticle
->getTimestamp();
2409 if ( $this->section
!= '' && !$this->isSectionEditSupported() ) {
2410 // We use $this->section to much before this and getVal('wgSection') directly in other places
2411 // at this point we can't reset $this->section to '' to fallback to non-section editing.
2412 // Someone is welcome to try refactoring though
2413 $wgOut->showErrorPage( 'sectioneditnotsupported-title', 'sectioneditnotsupported-text' );
2417 if ( $this->section
!= '' && $this->section
!= 'new' ) {
2418 if ( !$this->summary
&& !$this->preview
&& !$this->diff
) {
2419 $sectionTitle = self
::extractSectionTitle( $this->textbox1
); //FIXME: use Content object
2420 if ( $sectionTitle !== false ) {
2421 $this->summary
= "/* $sectionTitle */ ";
2426 if ( $this->missingComment
) {
2427 $wgOut->wrapWikiMsg( "<div id='mw-missingcommenttext'>\n$1\n</div>", 'missingcommenttext' );
2430 if ( $this->missingSummary
&& $this->section
!= 'new' ) {
2431 $wgOut->wrapWikiMsg( "<div id='mw-missingsummary'>\n$1\n</div>", 'missingsummary' );
2434 if ( $this->missingSummary
&& $this->section
== 'new' ) {
2435 $wgOut->wrapWikiMsg( "<div id='mw-missingcommentheader'>\n$1\n</div>", 'missingcommentheader' );
2438 if ( $this->hookError
!== '' ) {
2439 $wgOut->addWikiText( $this->hookError
);
2442 if ( !$this->checkUnicodeCompliantBrowser() ) {
2443 $wgOut->addWikiMsg( 'nonunicodebrowser' );
2446 if ( $this->section
!= 'new' ) {
2447 $revision = $this->mArticle
->getRevisionFetched();
2449 // Let sysop know that this will make private content public if saved
2451 if ( !$revision->userCan( Revision
::DELETED_TEXT
, $wgUser ) ) {
2452 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n", 'rev-deleted-text-permission' );
2453 } elseif ( $revision->isDeleted( Revision
::DELETED_TEXT
) ) {
2454 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n", 'rev-deleted-text-view' );
2457 if ( !$revision->isCurrent() ) {
2458 $this->mArticle
->setOldSubtitle( $revision->getId() );
2459 $wgOut->addWikiMsg( 'editingold' );
2461 } elseif ( $this->mTitle
->exists() ) {
2462 // Something went wrong
2464 $wgOut->wrapWikiMsg( "<div class='errorbox'>\n$1\n</div>\n",
2465 array( 'missing-revision', $this->oldid
) );
2470 if ( wfReadOnly() ) {
2471 $wgOut->wrapWikiMsg( "<div id=\"mw-read-only-warning\">\n$1\n</div>", array( 'readonlywarning', wfReadOnlyReason() ) );
2472 } elseif ( $wgUser->isAnon() ) {
2473 if ( $this->formtype
!= 'preview' ) {
2474 $wgOut->wrapWikiMsg( "<div id=\"mw-anon-edit-warning\">\n$1</div>", 'anoneditwarning' );
2476 $wgOut->wrapWikiMsg( "<div id=\"mw-anon-preview-warning\">\n$1</div>", 'anonpreviewwarning' );
2479 if ( $this->isCssJsSubpage
) {
2480 # Check the skin exists
2481 if ( $this->isWrongCaseCssJsPage
) {
2482 $wgOut->wrapWikiMsg( "<div class='error' id='mw-userinvalidcssjstitle'>\n$1\n</div>", array( 'userinvalidcssjstitle', $this->mTitle
->getSkinFromCssJsSubpage() ) );
2484 if ( $this->formtype
!== 'preview' ) {
2485 if ( $this->isCssSubpage
) {
2486 $wgOut->wrapWikiMsg( "<div id='mw-usercssyoucanpreview'>\n$1\n</div>", array( 'usercssyoucanpreview' ) );
2489 if ( $this->isJsSubpage
) {
2490 $wgOut->wrapWikiMsg( "<div id='mw-userjsyoucanpreview'>\n$1\n</div>", array( 'userjsyoucanpreview' ) );
2496 if ( $this->mTitle
->isProtected( 'edit' ) &&
2497 MWNamespace
::getRestrictionLevels( $this->mTitle
->getNamespace() ) !== array( '' )
2499 # Is the title semi-protected?
2500 if ( $this->mTitle
->isSemiProtected() ) {
2501 $noticeMsg = 'semiprotectedpagewarning';
2503 # Then it must be protected based on static groups (regular)
2504 $noticeMsg = 'protectedpagewarning';
2506 LogEventsList
::showLogExtract( $wgOut, 'protect', $this->mTitle
, '',
2507 array( 'lim' => 1, 'msgKey' => array( $noticeMsg ) ) );
2509 if ( $this->mTitle
->isCascadeProtected() ) {
2510 # Is this page under cascading protection from some source pages?
2511 list( $cascadeSources, /* $restrictions */ ) = $this->mTitle
->getCascadeProtectionSources();
2512 $notice = "<div class='mw-cascadeprotectedwarning'>\n$1\n";
2513 $cascadeSourcesCount = count( $cascadeSources );
2514 if ( $cascadeSourcesCount > 0 ) {
2515 # Explain, and list the titles responsible
2516 foreach ( $cascadeSources as $page ) {
2517 $notice .= '* [[:' . $page->getPrefixedText() . "]]\n";
2520 $notice .= '</div>';
2521 $wgOut->wrapWikiMsg( $notice, array( 'cascadeprotectedwarning', $cascadeSourcesCount ) );
2523 if ( !$this->mTitle
->exists() && $this->mTitle
->getRestrictions( 'create' ) ) {
2524 LogEventsList
::showLogExtract( $wgOut, 'protect', $this->mTitle
, '',
2526 'showIfEmpty' => false,
2527 'msgKey' => array( 'titleprotectedwarning' ),
2528 'wrap' => "<div class=\"mw-titleprotectedwarning\">\n$1</div>" ) );
2531 if ( $this->kblength
=== false ) {
2532 $this->kblength
= (int)( strlen( $this->textbox1
) / 1024 );
2535 if ( $this->tooBig ||
$this->kblength
> $wgMaxArticleSize ) {
2536 $wgOut->wrapWikiMsg( "<div class='error' id='mw-edit-longpageerror'>\n$1\n</div>",
2537 array( 'longpageerror', $wgLang->formatNum( $this->kblength
), $wgLang->formatNum( $wgMaxArticleSize ) ) );
2539 if ( !wfMessage( 'longpage-hint' )->isDisabled() ) {
2540 $wgOut->wrapWikiMsg( "<div id='mw-edit-longpage-hint'>\n$1\n</div>",
2541 array( 'longpage-hint', $wgLang->formatSize( strlen( $this->textbox1
) ), strlen( $this->textbox1
) )
2545 # Add header copyright warning
2546 $this->showHeaderCopyrightWarning();
2550 * Standard summary input and label (wgSummary), abstracted so EditPage
2551 * subclasses may reorganize the form.
2552 * Note that you do not need to worry about the label's for=, it will be
2553 * inferred by the id given to the input. You can remove them both by
2554 * passing array( 'id' => false ) to $userInputAttrs.
2556 * @param string $summary The value of the summary input
2557 * @param string $labelText The html to place inside the label
2558 * @param array $inputAttrs of attrs to use on the input
2559 * @param array $spanLabelAttrs of attrs to use on the span inside the label
2561 * @return array An array in the format array( $label, $input )
2563 function getSummaryInput( $summary = "", $labelText = null, $inputAttrs = null, $spanLabelAttrs = null ) {
2564 // Note: the maxlength is overridden in JS to 255 and to make it use UTF-8 bytes, not characters.
2565 $inputAttrs = ( is_array( $inputAttrs ) ?
$inputAttrs : array() ) +
array(
2566 'id' => 'wpSummary',
2567 'maxlength' => '200',
2570 'spellcheck' => 'true',
2571 ) + Linker
::tooltipAndAccesskeyAttribs( 'summary' );
2573 $spanLabelAttrs = ( is_array( $spanLabelAttrs ) ?
$spanLabelAttrs : array() ) +
array(
2574 'class' => $this->missingSummary ?
'mw-summarymissed' : 'mw-summary',
2575 'id' => "wpSummaryLabel"
2580 $label = Xml
::tags( 'label', $inputAttrs['id'] ?
array( 'for' => $inputAttrs['id'] ) : null, $labelText );
2581 $label = Xml
::tags( 'span', $spanLabelAttrs, $label );
2584 $input = Html
::input( 'wpSummary', $summary, 'text', $inputAttrs );
2586 return array( $label, $input );
2590 * @param $isSubjectPreview Boolean: true if this is the section subject/title
2591 * up top, or false if this is the comment summary
2592 * down below the textarea
2593 * @param string $summary The text of the summary to display
2596 protected function showSummaryInput( $isSubjectPreview, $summary = "" ) {
2597 global $wgOut, $wgContLang;
2598 # Add a class if 'missingsummary' is triggered to allow styling of the summary line
2599 $summaryClass = $this->missingSummary ?
'mw-summarymissed' : 'mw-summary';
2600 if ( $isSubjectPreview ) {
2601 if ( $this->nosummary
) {
2605 if ( !$this->mShowSummaryField
) {
2609 $summary = $wgContLang->recodeForEdit( $summary );
2610 $labelText = wfMessage( $isSubjectPreview ?
'subject' : 'summary' )->parse();
2611 list( $label, $input ) = $this->getSummaryInput( $summary, $labelText, array( 'class' => $summaryClass ), array() );
2612 $wgOut->addHTML( "{$label} {$input}" );
2616 * @param $isSubjectPreview Boolean: true if this is the section subject/title
2617 * up top, or false if this is the comment summary
2618 * down below the textarea
2619 * @param string $summary the text of the summary to display
2622 protected function getSummaryPreview( $isSubjectPreview, $summary = "" ) {
2623 // avoid spaces in preview, gets always trimmed on save
2624 $summary = trim( $summary );
2625 if ( !$summary ||
( !$this->preview
&& !$this->diff
) ) {
2631 if ( $isSubjectPreview ) {
2632 $summary = wfMessage( 'newsectionsummary' )->rawParams( $wgParser->stripSectionName( $summary ) )
2633 ->inContentLanguage()->text();
2636 $message = $isSubjectPreview ?
'subject-preview' : 'summary-preview';
2638 $summary = wfMessage( $message )->parse() . Linker
::commentBlock( $summary, $this->mTitle
, $isSubjectPreview );
2639 return Xml
::tags( 'div', array( 'class' => 'mw-summary-preview' ), $summary );
2642 protected function showFormBeforeText() {
2644 $section = htmlspecialchars( $this->section
);
2645 $wgOut->addHTML( <<<HTML
2646 <input type='hidden' value="{$section}" name="wpSection" />
2647 <input type='hidden' value="{$this->starttime}" name="wpStarttime" />
2648 <input type='hidden' value="{$this->edittime}" name="wpEdittime" />
2649 <input type='hidden' value="{$this->scrolltop}" name="wpScrolltop" id="wpScrolltop" />
2653 if ( !$this->checkUnicodeCompliantBrowser() ) {
2654 $wgOut->addHTML( Html
::hidden( 'safemode', '1' ) );
2658 protected function showFormAfterText() {
2659 global $wgOut, $wgUser;
2661 * To make it harder for someone to slip a user a page
2662 * which submits an edit form to the wiki without their
2663 * knowledge, a random token is associated with the login
2664 * session. If it's not passed back with the submission,
2665 * we won't save the page, or render user JavaScript and
2668 * For anon editors, who may not have a session, we just
2669 * include the constant suffix to prevent editing from
2670 * broken text-mangling proxies.
2672 $wgOut->addHTML( "\n" . Html
::hidden( "wpEditToken", $wgUser->getEditToken() ) . "\n" );
2676 * Subpage overridable method for printing the form for page content editing
2677 * By default this simply outputs wpTextbox1
2678 * Subclasses can override this to provide a custom UI for editing;
2679 * be it a form, or simply wpTextbox1 with a modified content that will be
2680 * reverse modified when extracted from the post data.
2681 * Note that this is basically the inverse for importContentFormData
2683 protected function showContentForm() {
2684 $this->showTextbox1();
2688 * Method to output wpTextbox1
2689 * The $textoverride method can be used by subclasses overriding showContentForm
2690 * to pass back to this method.
2692 * @param array $customAttribs of html attributes to use in the textarea
2693 * @param string $textoverride optional text to override $this->textarea1 with
2695 protected function showTextbox1( $customAttribs = null, $textoverride = null ) {
2696 if ( $this->wasDeletedSinceLastEdit() && $this->formtype
== 'save' ) {
2697 $attribs = array( 'style' => 'display:none;' );
2699 $classes = array(); // Textarea CSS
2700 if ( $this->mTitle
->isProtected( 'edit' ) &&
2701 MWNamespace
::getRestrictionLevels( $this->mTitle
->getNamespace() ) !== array( '' )
2703 # Is the title semi-protected?
2704 if ( $this->mTitle
->isSemiProtected() ) {
2705 $classes[] = 'mw-textarea-sprotected';
2707 # Then it must be protected based on static groups (regular)
2708 $classes[] = 'mw-textarea-protected';
2710 # Is the title cascade-protected?
2711 if ( $this->mTitle
->isCascadeProtected() ) {
2712 $classes[] = 'mw-textarea-cprotected';
2716 $attribs = array( 'tabindex' => 1 );
2718 if ( is_array( $customAttribs ) ) {
2719 $attribs +
= $customAttribs;
2722 if ( count( $classes ) ) {
2723 if ( isset( $attribs['class'] ) ) {
2724 $classes[] = $attribs['class'];
2726 $attribs['class'] = implode( ' ', $classes );
2730 $this->showTextbox( $textoverride !== null ?
$textoverride : $this->textbox1
, 'wpTextbox1', $attribs );
2733 protected function showTextbox2() {
2734 $this->showTextbox( $this->textbox2
, 'wpTextbox2', array( 'tabindex' => 6, 'readonly' ) );
2737 protected function showTextbox( $text, $name, $customAttribs = array() ) {
2738 global $wgOut, $wgUser;
2740 $wikitext = $this->safeUnicodeOutput( $text );
2741 if ( strval( $wikitext ) !== '' ) {
2742 // Ensure there's a newline at the end, otherwise adding lines
2744 // But don't add a newline if the ext is empty, or Firefox in XHTML
2745 // mode will show an extra newline. A bit annoying.
2749 $attribs = $customAttribs +
array(
2752 'cols' => $wgUser->getIntOption( 'cols' ),
2753 'rows' => $wgUser->getIntOption( 'rows' ),
2754 'style' => '' // avoid php notices when appending preferences (appending allows customAttribs['style'] to still work
2757 $pageLang = $this->mTitle
->getPageLanguage();
2758 $attribs['lang'] = $pageLang->getCode();
2759 $attribs['dir'] = $pageLang->getDir();
2761 $wgOut->addHTML( Html
::textarea( $name, $wikitext, $attribs ) );
2764 protected function displayPreviewArea( $previewOutput, $isOnTop = false ) {
2768 $classes[] = 'ontop';
2771 $attribs = array( 'id' => 'wikiPreview', 'class' => implode( ' ', $classes ) );
2773 if ( $this->formtype
!= 'preview' ) {
2774 $attribs['style'] = 'display: none;';
2777 $wgOut->addHTML( Xml
::openElement( 'div', $attribs ) );
2779 if ( $this->formtype
== 'preview' ) {
2780 $this->showPreview( $previewOutput );
2783 $wgOut->addHTML( '</div>' );
2785 if ( $this->formtype
== 'diff' ) {
2788 } catch ( MWContentSerializationException
$ex ) {
2789 $msg = wfMessage( 'content-failed-to-parse', $this->contentModel
, $this->contentFormat
, $ex->getMessage() );
2790 $wgOut->addWikiText( '<div class="error">' . $msg->text() . '</div>' );
2796 * Append preview output to $wgOut.
2797 * Includes category rendering if this is a category page.
2799 * @param string $text the HTML to be output for the preview.
2801 protected function showPreview( $text ) {
2803 if ( $this->mTitle
->getNamespace() == NS_CATEGORY
) {
2804 $this->mArticle
->openShowCategory();
2806 # This hook seems slightly odd here, but makes things more
2807 # consistent for extensions.
2808 wfRunHooks( 'OutputPageBeforeHTML', array( &$wgOut, &$text ) );
2809 $wgOut->addHTML( $text );
2810 if ( $this->mTitle
->getNamespace() == NS_CATEGORY
) {
2811 $this->mArticle
->closeShowCategory();
2816 * Get a diff between the current contents of the edit box and the
2817 * version of the page we're editing from.
2819 * If this is a section edit, we'll replace the section as for final
2820 * save and then make a comparison.
2822 function showDiff() {
2823 global $wgUser, $wgContLang, $wgOut;
2825 $oldtitlemsg = 'currentrev';
2826 # if message does not exist, show diff against the preloaded default
2827 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
&& !$this->mTitle
->exists() ) {
2828 $oldtext = $this->mTitle
->getDefaultMessageText();
2829 if ( $oldtext !== false ) {
2830 $oldtitlemsg = 'defaultmessagetext';
2831 $oldContent = $this->toEditContent( $oldtext );
2836 $oldContent = $this->getCurrentContent();
2839 $textboxContent = $this->toEditContent( $this->textbox1
);
2841 $newContent = $this->mArticle
->replaceSectionContent(
2842 $this->section
, $textboxContent,
2843 $this->summary
, $this->edittime
);
2845 if ( $newContent ) {
2846 ContentHandler
::runLegacyHooks( 'EditPageGetDiffText', array( $this, &$newContent ) );
2847 wfRunHooks( 'EditPageGetDiffContent', array( $this, &$newContent ) );
2849 $popts = ParserOptions
::newFromUserAndLang( $wgUser, $wgContLang );
2850 $newContent = $newContent->preSaveTransform( $this->mTitle
, $wgUser, $popts );
2853 if ( ( $oldContent && !$oldContent->isEmpty() ) ||
( $newContent && !$newContent->isEmpty() ) ) {
2854 $oldtitle = wfMessage( $oldtitlemsg )->parse();
2855 $newtitle = wfMessage( 'yourtext' )->parse();
2857 if ( !$oldContent ) {
2858 $oldContent = $newContent->getContentHandler()->makeEmptyContent();
2861 if ( !$newContent ) {
2862 $newContent = $oldContent->getContentHandler()->makeEmptyContent();
2865 $de = $oldContent->getContentHandler()->createDifferenceEngine( $this->mArticle
->getContext() );
2866 $de->setContent( $oldContent, $newContent );
2868 $difftext = $de->getDiff( $oldtitle, $newtitle );
2869 $de->showDiffStyle();
2874 $wgOut->addHTML( '<div id="wikiDiff">' . $difftext . '</div>' );
2878 * Show the header copyright warning.
2880 protected function showHeaderCopyrightWarning() {
2881 $msg = 'editpage-head-copy-warn';
2882 if ( !wfMessage( $msg )->isDisabled() ) {
2884 $wgOut->wrapWikiMsg( "<div class='editpage-head-copywarn'>\n$1\n</div>",
2885 'editpage-head-copy-warn' );
2890 * Give a chance for site and per-namespace customizations of
2891 * terms of service summary link that might exist separately
2892 * from the copyright notice.
2894 * This will display between the save button and the edit tools,
2895 * so should remain short!
2897 protected function showTosSummary() {
2898 $msg = 'editpage-tos-summary';
2899 wfRunHooks( 'EditPageTosSummary', array( $this->mTitle
, &$msg ) );
2900 if ( !wfMessage( $msg )->isDisabled() ) {
2902 $wgOut->addHTML( '<div class="mw-tos-summary">' );
2903 $wgOut->addWikiMsg( $msg );
2904 $wgOut->addHTML( '</div>' );
2908 protected function showEditTools() {
2910 $wgOut->addHTML( '<div class="mw-editTools">' .
2911 wfMessage( 'edittools' )->inContentLanguage()->parse() .
2916 * Get the copyright warning
2918 * Renamed to getCopyrightWarning(), old name kept around for backwards compatibility
2920 protected function getCopywarn() {
2921 return self
::getCopyrightWarning( $this->mTitle
);
2925 * Get the copyright warning, by default returns wikitext
2927 * @param Title $title
2928 * @param string $format output format, valid values are any function of
2932 public static function getCopyrightWarning( $title, $format = 'plain' ) {
2933 global $wgRightsText;
2934 if ( $wgRightsText ) {
2935 $copywarnMsg = array( 'copyrightwarning',
2936 '[[' . wfMessage( 'copyrightpage' )->inContentLanguage()->text() . ']]',
2939 $copywarnMsg = array( 'copyrightwarning2',
2940 '[[' . wfMessage( 'copyrightpage' )->inContentLanguage()->text() . ']]' );
2942 // Allow for site and per-namespace customization of contribution/copyright notice.
2943 wfRunHooks( 'EditPageCopyrightWarning', array( $title, &$copywarnMsg ) );
2945 return "<div id=\"editpage-copywarn\">\n" .
2946 call_user_func_array( 'wfMessage', $copywarnMsg )->$format() . "\n</div>";
2950 * Get the Limit report for page previews
2953 * @param ParserOutput $output ParserOutput object from the parse
2954 * @return string HTML
2956 public static function getPreviewLimitReport( $output ) {
2957 if ( !$output ||
!$output->getLimitReportData() ) {
2961 wfProfileIn( __METHOD__
);
2963 $limitReport = Html
::rawElement( 'div', array( 'class' => 'mw-limitReportExplanation' ),
2964 wfMessage( 'limitreport-title' )->parseAsBlock()
2967 // Show/hide animation doesn't work correctly on a table, so wrap it in a div.
2968 $limitReport .= Html
::openElement( 'div', array( 'class' => 'preview-limit-report-wrapper' ) );
2970 $limitReport .= Html
::openElement( 'table', array(
2971 'class' => 'preview-limit-report wikitable'
2973 Html
::openElement( 'tbody' );
2975 foreach ( $output->getLimitReportData() as $key => $value ) {
2976 if ( wfRunHooks( 'ParserLimitReportFormat',
2977 array( $key, &$value, &$limitReport, true, true )
2979 $keyMsg = wfMessage( $key );
2980 $valueMsg = wfMessage( array( "$key-value-html", "$key-value" ) );
2981 if ( !$valueMsg->exists() ) {
2982 $valueMsg = new RawMessage( '$1' );
2984 if ( !$keyMsg->isDisabled() && !$valueMsg->isDisabled() ) {
2985 $limitReport .= Html
::openElement( 'tr' ) .
2986 Html
::rawElement( 'th', null, $keyMsg->parse() ) .
2987 Html
::rawElement( 'td', null, $valueMsg->params( $value )->parse() ) .
2988 Html
::closeElement( 'tr' );
2993 $limitReport .= Html
::closeElement( 'tbody' ) .
2994 Html
::closeElement( 'table' ) .
2995 Html
::closeElement( 'div' );
2997 wfProfileOut( __METHOD__
);
2999 return $limitReport;
3002 protected function showStandardInputs( &$tabindex = 2 ) {
3004 $wgOut->addHTML( "<div class='editOptions'>\n" );
3006 if ( $this->section
!= 'new' ) {
3007 $this->showSummaryInput( false, $this->summary
);
3008 $wgOut->addHTML( $this->getSummaryPreview( false, $this->summary
) );
3011 $checkboxes = $this->getCheckboxes( $tabindex,
3012 array( 'minor' => $this->minoredit
, 'watch' => $this->watchthis
) );
3013 $wgOut->addHTML( "<div class='editCheckboxes'>" . implode( $checkboxes, "\n" ) . "</div>\n" );
3015 // Show copyright warning.
3016 $wgOut->addWikiText( $this->getCopywarn() );
3017 $wgOut->addHTML( $this->editFormTextAfterWarn
);
3019 $wgOut->addHTML( "<div class='editButtons'>\n" );
3020 $wgOut->addHTML( implode( $this->getEditButtons( $tabindex ), "\n" ) . "\n" );
3022 $cancel = $this->getCancelLink();
3023 if ( $cancel !== '' ) {
3024 $cancel .= Html
::element( 'span',
3025 array( 'class' => 'mw-editButtons-pipe-separator' ),
3026 wfMessage( 'pipe-separator' )->text() );
3028 $edithelpurl = Skin
::makeInternalOrExternalUrl( wfMessage( 'edithelppage' )->inContentLanguage()->text() );
3029 $edithelp = '<a target="helpwindow" href="' . $edithelpurl . '">' .
3030 wfMessage( 'edithelp' )->escaped() . '</a> ' .
3031 wfMessage( 'newwindow' )->parse();
3032 $wgOut->addHTML( " <span class='cancelLink'>{$cancel}</span>\n" );
3033 $wgOut->addHTML( " <span class='editHelp'>{$edithelp}</span>\n" );
3034 $wgOut->addHTML( "</div><!-- editButtons -->\n" );
3035 wfRunHooks( 'EditPage::showStandardInputs:options', array( $this, $wgOut, &$tabindex ) );
3036 $wgOut->addHTML( "</div><!-- editOptions -->\n" );
3040 * Show an edit conflict. textbox1 is already shown in showEditForm().
3041 * If you want to use another entry point to this function, be careful.
3043 protected function showConflict() {
3046 if ( wfRunHooks( 'EditPageBeforeConflictDiff', array( &$this, &$wgOut ) ) ) {
3047 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
3049 $content1 = $this->toEditContent( $this->textbox1
);
3050 $content2 = $this->toEditContent( $this->textbox2
);
3052 $handler = ContentHandler
::getForModelID( $this->contentModel
);
3053 $de = $handler->createDifferenceEngine( $this->mArticle
->getContext() );
3054 $de->setContent( $content2, $content1 );
3056 wfMessage( 'yourtext' )->parse(),
3057 wfMessage( 'storedversion' )->text()
3060 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
3061 $this->showTextbox2();
3068 public function getCancelLink() {
3069 $cancelParams = array();
3070 if ( !$this->isConflict
&& $this->oldid
> 0 ) {
3071 $cancelParams['oldid'] = $this->oldid
;
3074 return Linker
::linkKnown(
3075 $this->getContextTitle(),
3076 wfMessage( 'cancel' )->parse(),
3077 array( 'id' => 'mw-editform-cancel' ),
3083 * Returns the URL to use in the form's action attribute.
3084 * This is used by EditPage subclasses when simply customizing the action
3085 * variable in the constructor is not enough. This can be used when the
3086 * EditPage lives inside of a Special page rather than a custom page action.
3088 * @param $title Title object for which is being edited (where we go to for &action= links)
3091 protected function getActionURL( Title
$title ) {
3092 return $title->getLocalURL( array( 'action' => $this->action
) );
3096 * Check if a page was deleted while the user was editing it, before submit.
3097 * Note that we rely on the logging table, which hasn't been always there,
3098 * but that doesn't matter, because this only applies to brand new
3101 protected function wasDeletedSinceLastEdit() {
3102 if ( $this->deletedSinceEdit
!== null ) {
3103 return $this->deletedSinceEdit
;
3106 $this->deletedSinceEdit
= false;
3108 if ( $this->mTitle
->isDeletedQuick() ) {
3109 $this->lastDelete
= $this->getLastDelete();
3110 if ( $this->lastDelete
) {
3111 $deleteTime = wfTimestamp( TS_MW
, $this->lastDelete
->log_timestamp
);
3112 if ( $deleteTime > $this->starttime
) {
3113 $this->deletedSinceEdit
= true;
3118 return $this->deletedSinceEdit
;
3121 protected function getLastDelete() {
3122 $dbr = wfGetDB( DB_SLAVE
);
3123 $data = $dbr->selectRow(
3124 array( 'logging', 'user' ),
3137 'log_namespace' => $this->mTitle
->getNamespace(),
3138 'log_title' => $this->mTitle
->getDBkey(),
3139 'log_type' => 'delete',
3140 'log_action' => 'delete',
3144 array( 'LIMIT' => 1, 'ORDER BY' => 'log_timestamp DESC' )
3146 // Quick paranoid permission checks...
3147 if ( is_object( $data ) ) {
3148 if ( $data->log_deleted
& LogPage
::DELETED_USER
) {
3149 $data->user_name
= wfMessage( 'rev-deleted-user' )->escaped();
3152 if ( $data->log_deleted
& LogPage
::DELETED_COMMENT
) {
3153 $data->log_comment
= wfMessage( 'rev-deleted-comment' )->escaped();
3160 * Get the rendered text for previewing.
3161 * @throws MWException
3164 function getPreviewText() {
3165 global $wgOut, $wgUser, $wgRawHtml, $wgLang;
3167 wfProfileIn( __METHOD__
);
3169 if ( $wgRawHtml && !$this->mTokenOk
) {
3170 // Could be an offsite preview attempt. This is very unsafe if
3171 // HTML is enabled, as it could be an attack.
3173 if ( $this->textbox1
!== '' ) {
3174 // Do not put big scary notice, if previewing the empty
3175 // string, which happens when you initially edit
3176 // a category page, due to automatic preview-on-open.
3177 $parsedNote = $wgOut->parse( "<div class='previewnote'>" .
3178 wfMessage( 'session_fail_preview_html' )->text() . "</div>", true, /* interface */true );
3180 wfProfileOut( __METHOD__
);
3187 $content = $this->toEditContent( $this->textbox1
);
3190 if ( !wfRunHooks( 'AlternateEditPreview', array( $this, &$content, &$previewHTML, &$this->mParserOutput
) ) ) {
3191 wfProfileOut( __METHOD__
);
3192 return $previewHTML;
3195 # provide a anchor link to the editform
3196 $continueEditing = '<span class="mw-continue-editing">' .
3197 '[[#' . self
::EDITFORM_ID
. '|' . $wgLang->getArrow() . ' ' .
3198 wfMessage( 'continue-editing' )->text() . ']]</span>';
3199 if ( $this->mTriedSave
&& !$this->mTokenOk
) {
3200 if ( $this->mTokenOkExceptSuffix
) {
3201 $note = wfMessage( 'token_suffix_mismatch' )->plain();
3204 $note = wfMessage( 'session_fail_preview' )->plain();
3206 } elseif ( $this->incompleteForm
) {
3207 $note = wfMessage( 'edit_form_incomplete' )->plain();
3209 $note = wfMessage( 'previewnote' )->plain() . ' ' . $continueEditing;
3212 $parserOptions = $this->mArticle
->makeParserOptions( $this->mArticle
->getContext() );
3213 $parserOptions->setEditSection( false );
3214 $parserOptions->setIsPreview( true );
3215 $parserOptions->setIsSectionPreview( !is_null( $this->section
) && $this->section
!== '' );
3217 # don't parse non-wikitext pages, show message about preview
3218 if ( $this->mTitle
->isCssJsSubpage() ||
$this->mTitle
->isCssOrJsPage() ) {
3219 if ( $this->mTitle
->isCssJsSubpage() ) {
3221 } elseif ( $this->mTitle
->isCssOrJsPage() ) {
3227 if ( $content->getModel() == CONTENT_MODEL_CSS
) {
3229 } elseif ( $content->getModel() == CONTENT_MODEL_JAVASCRIPT
) {
3235 # Used messages to make sure grep find them:
3236 # Messages: usercsspreview, userjspreview, sitecsspreview, sitejspreview
3237 if ( $level && $format ) {
3238 $note = "<div id='mw-{$level}{$format}preview'>" .
3239 wfMessage( "{$level}{$format}preview" )->text() .
3240 ' ' . $continueEditing . "</div>";
3244 # If we're adding a comment, we need to show the
3245 # summary as the headline
3246 if ( $this->section
=== "new" && $this->summary
!== "" ) {
3247 $content = $content->addSectionHeader( $this->summary
);
3250 $hook_args = array( $this, &$content );
3251 ContentHandler
::runLegacyHooks( 'EditPageGetPreviewText', $hook_args );
3252 wfRunHooks( 'EditPageGetPreviewContent', $hook_args );
3254 $parserOptions->enableLimitReport();
3256 # For CSS/JS pages, we should have called the ShowRawCssJs hook here.
3257 # But it's now deprecated, so never mind
3259 $content = $content->preSaveTransform( $this->mTitle
, $wgUser, $parserOptions );
3260 $parserOutput = $content->getParserOutput( $this->getArticle()->getTitle(), null, $parserOptions );
3262 $previewHTML = $parserOutput->getText();
3263 $this->mParserOutput
= $parserOutput;
3264 $wgOut->addParserOutputNoText( $parserOutput );
3266 if ( count( $parserOutput->getWarnings() ) ) {
3267 $note .= "\n\n" . implode( "\n\n", $parserOutput->getWarnings() );
3269 } catch ( MWContentSerializationException
$ex ) {
3270 $m = wfMessage( 'content-failed-to-parse', $this->contentModel
, $this->contentFormat
, $ex->getMessage() );
3271 $note .= "\n\n" . $m->parse();
3275 if ( $this->isConflict
) {
3276 $conflict = '<h2 id="mw-previewconflict">' . wfMessage( 'previewconflict' )->escaped() . "</h2>\n";
3278 $conflict = '<hr />';
3281 $previewhead = "<div class='previewnote'>\n" .
3282 '<h2 id="mw-previewheader">' . wfMessage( 'preview' )->escaped() . "</h2>" .
3283 $wgOut->parse( $note, true, /* interface */true ) . $conflict . "</div>\n";
3285 $pageViewLang = $this->mTitle
->getPageViewLanguage();
3286 $attribs = array( 'lang' => $pageViewLang->getHtmlCode(), 'dir' => $pageViewLang->getDir(),
3287 'class' => 'mw-content-' . $pageViewLang->getDir() );
3288 $previewHTML = Html
::rawElement( 'div', $attribs, $previewHTML );
3290 wfProfileOut( __METHOD__
);
3291 return $previewhead . $previewHTML . $this->previewTextAfterContent
;
3297 function getTemplates() {
3298 if ( $this->preview ||
$this->section
!= '' ) {
3299 $templates = array();
3300 if ( !isset( $this->mParserOutput
) ) {
3303 foreach ( $this->mParserOutput
->getTemplates() as $ns => $template ) {
3304 foreach ( array_keys( $template ) as $dbk ) {
3305 $templates[] = Title
::makeTitle( $ns, $dbk );
3310 return $this->mTitle
->getTemplateLinksFrom();
3315 * Shows a bulletin board style toolbar for common editing functions.
3316 * It can be disabled in the user preferences.
3317 * The necessary JavaScript code can be found in skins/common/edit.js.
3321 static function getEditToolbar() {
3322 global $wgStylePath, $wgContLang, $wgLang, $wgOut;
3323 global $wgEnableUploads, $wgForeignFileRepos;
3325 $imagesAvailable = $wgEnableUploads ||
count( $wgForeignFileRepos );
3328 * $toolarray is an array of arrays each of which includes the
3329 * filename of the button image (without path), the opening
3330 * tag, the closing tag, optionally a sample text that is
3331 * inserted between the two when no selection is highlighted
3332 * and. The tip text is shown when the user moves the mouse
3335 * Also here: accesskeys (key), which are not used yet until
3336 * someone can figure out a way to make them work in
3337 * IE. However, we should make sure these keys are not defined
3342 'image' => $wgLang->getImageFile( 'button-bold' ),
3343 'id' => 'mw-editbutton-bold',
3345 'close' => '\'\'\'',
3346 'sample' => wfMessage( 'bold_sample' )->text(),
3347 'tip' => wfMessage( 'bold_tip' )->text(),
3351 'image' => $wgLang->getImageFile( 'button-italic' ),
3352 'id' => 'mw-editbutton-italic',
3355 'sample' => wfMessage( 'italic_sample' )->text(),
3356 'tip' => wfMessage( 'italic_tip' )->text(),
3360 'image' => $wgLang->getImageFile( 'button-link' ),
3361 'id' => 'mw-editbutton-link',
3364 'sample' => wfMessage( 'link_sample' )->text(),
3365 'tip' => wfMessage( 'link_tip' )->text(),
3369 'image' => $wgLang->getImageFile( 'button-extlink' ),
3370 'id' => 'mw-editbutton-extlink',
3373 'sample' => wfMessage( 'extlink_sample' )->text(),
3374 'tip' => wfMessage( 'extlink_tip' )->text(),
3378 'image' => $wgLang->getImageFile( 'button-headline' ),
3379 'id' => 'mw-editbutton-headline',
3382 'sample' => wfMessage( 'headline_sample' )->text(),
3383 'tip' => wfMessage( 'headline_tip' )->text(),
3386 $imagesAvailable ?
array(
3387 'image' => $wgLang->getImageFile( 'button-image' ),
3388 'id' => 'mw-editbutton-image',
3389 'open' => '[[' . $wgContLang->getNsText( NS_FILE
) . ':',
3391 'sample' => wfMessage( 'image_sample' )->text(),
3392 'tip' => wfMessage( 'image_tip' )->text(),
3395 $imagesAvailable ?
array(
3396 'image' => $wgLang->getImageFile( 'button-media' ),
3397 'id' => 'mw-editbutton-media',
3398 'open' => '[[' . $wgContLang->getNsText( NS_MEDIA
) . ':',
3400 'sample' => wfMessage( 'media_sample' )->text(),
3401 'tip' => wfMessage( 'media_tip' )->text(),
3404 class_exists( 'MathRenderer' ) ?
array(
3405 'image' => $wgLang->getImageFile( 'button-math' ),
3406 'id' => 'mw-editbutton-math',
3408 'close' => "</math>",
3409 'sample' => wfMessage( 'math_sample' )->text(),
3410 'tip' => wfMessage( 'math_tip' )->text(),
3414 'image' => $wgLang->getImageFile( 'button-nowiki' ),
3415 'id' => 'mw-editbutton-nowiki',
3416 'open' => "<nowiki>",
3417 'close' => "</nowiki>",
3418 'sample' => wfMessage( 'nowiki_sample' )->text(),
3419 'tip' => wfMessage( 'nowiki_tip' )->text(),
3423 'image' => $wgLang->getImageFile( 'button-sig' ),
3424 'id' => 'mw-editbutton-signature',
3428 'tip' => wfMessage( 'sig_tip' )->text(),
3432 'image' => $wgLang->getImageFile( 'button-hr' ),
3433 'id' => 'mw-editbutton-hr',
3434 'open' => "\n----\n",
3437 'tip' => wfMessage( 'hr_tip' )->text(),
3442 $script = 'mw.loader.using("mediawiki.action.edit", function() {';
3443 foreach ( $toolarray as $tool ) {
3449 $image = $wgStylePath . '/common/images/' . $tool['image'],
3450 // Note that we use the tip both for the ALT tag and the TITLE tag of the image.
3451 // Older browsers show a "speedtip" type message only for ALT.
3452 // Ideally these should be different, realistically they
3453 // probably don't need to be.
3454 $tip = $tool['tip'],
3455 $open = $tool['open'],
3456 $close = $tool['close'],
3457 $sample = $tool['sample'],
3458 $cssId = $tool['id'],
3461 $script .= Xml
::encodeJsCall( 'mw.toolbar.addButton', $params );
3464 // This used to be called on DOMReady from mediawiki.action.edit, which
3465 // ended up causing race conditions with the setup code above.
3467 "// Create button bar\n" .
3468 "$(function() { mw.toolbar.init(); } );\n";
3471 $wgOut->addScript( Html
::inlineScript( ResourceLoader
::makeLoaderConditionalScript( $script ) ) );
3473 $toolbar = '<div id="toolbar"></div>';
3475 wfRunHooks( 'EditPageBeforeEditToolbar', array( &$toolbar ) );
3481 * Returns an array of html code of the following checkboxes:
3484 * @param int $tabindex Current tabindex
3485 * @param array $checked of checkbox => bool, where bool indicates the checked
3486 * status of the checkbox
3490 public function getCheckboxes( &$tabindex, $checked ) {
3493 $checkboxes = array();
3495 // don't show the minor edit checkbox if it's a new page or section
3496 if ( !$this->isNew
) {
3497 $checkboxes['minor'] = '';
3498 $minorLabel = wfMessage( 'minoredit' )->parse();
3499 if ( $wgUser->isAllowed( 'minoredit' ) ) {
3501 'tabindex' => ++
$tabindex,
3502 'accesskey' => wfMessage( 'accesskey-minoredit' )->text(),
3503 'id' => 'wpMinoredit',
3505 $checkboxes['minor'] =
3506 Xml
::check( 'wpMinoredit', $checked['minor'], $attribs ) .
3507 " <label for='wpMinoredit' id='mw-editpage-minoredit'" .
3508 Xml
::expandAttributes( array( 'title' => Linker
::titleAttrib( 'minoredit', 'withaccess' ) ) ) .
3509 ">{$minorLabel}</label>";
3513 $watchLabel = wfMessage( 'watchthis' )->parse();
3514 $checkboxes['watch'] = '';
3515 if ( $wgUser->isLoggedIn() ) {
3517 'tabindex' => ++
$tabindex,
3518 'accesskey' => wfMessage( 'accesskey-watch' )->text(),
3519 'id' => 'wpWatchthis',
3521 $checkboxes['watch'] =
3522 Xml
::check( 'wpWatchthis', $checked['watch'], $attribs ) .
3523 " <label for='wpWatchthis' id='mw-editpage-watch'" .
3524 Xml
::expandAttributes( array( 'title' => Linker
::titleAttrib( 'watch', 'withaccess' ) ) ) .
3525 ">{$watchLabel}</label>";
3527 wfRunHooks( 'EditPageBeforeEditChecks', array( &$this, &$checkboxes, &$tabindex ) );
3532 * Returns an array of html code of the following buttons:
3533 * save, diff, preview and live
3535 * @param int $tabindex Current tabindex
3539 public function getEditButtons( &$tabindex ) {
3546 'tabindex' => ++
$tabindex,
3547 'value' => wfMessage( 'savearticle' )->text(),
3548 'accesskey' => wfMessage( 'accesskey-save' )->text(),
3549 'title' => wfMessage( 'tooltip-save' )->text() . ' [' . wfMessage( 'accesskey-save' )->text() . ']',
3551 $buttons['save'] = Xml
::element( 'input', $temp, '' );
3553 ++
$tabindex; // use the same for preview and live preview
3555 'id' => 'wpPreview',
3556 'name' => 'wpPreview',
3558 'tabindex' => $tabindex,
3559 'value' => wfMessage( 'showpreview' )->text(),
3560 'accesskey' => wfMessage( 'accesskey-preview' )->text(),
3561 'title' => wfMessage( 'tooltip-preview' )->text() . ' [' . wfMessage( 'accesskey-preview' )->text() . ']',
3563 $buttons['preview'] = Xml
::element( 'input', $temp, '' );
3564 $buttons['live'] = '';
3570 'tabindex' => ++
$tabindex,
3571 'value' => wfMessage( 'showdiff' )->text(),
3572 'accesskey' => wfMessage( 'accesskey-diff' )->text(),
3573 'title' => wfMessage( 'tooltip-diff' )->text() . ' [' . wfMessage( 'accesskey-diff' )->text() . ']',
3575 $buttons['diff'] = Xml
::element( 'input', $temp, '' );
3577 wfRunHooks( 'EditPageBeforeEditButtons', array( &$this, &$buttons, &$tabindex ) );
3582 * Output preview text only. This can be sucked into the edit page
3583 * via JavaScript, and saves the server time rendering the skin as
3584 * well as theoretically being more robust on the client (doesn't
3585 * disturb the edit box's undo history, won't eat your text on
3588 * @todo This doesn't include category or interlanguage links.
3589 * Would need to enhance it a bit, "<s>maybe wrap them in XML
3590 * or something...</s>" that might also require more skin
3591 * initialization, so check whether that's a problem.
3593 function livePreview() {
3596 header( 'Content-type: text/xml; charset=utf-8' );
3597 header( 'Cache-control: no-cache' );
3599 $previewText = $this->getPreviewText();
3600 #$categories = $skin->getCategoryLinks();
3603 '<?xml version="1.0" encoding="UTF-8" ?>' . "\n" .
3604 Xml
::tags( 'livepreview', null,
3605 Xml
::element( 'preview', null, $previewText )
3606 #. Xml::element( 'category', null, $categories )
3612 * Call the stock "user is blocked" page
3614 * @deprecated in 1.19; throw an exception directly instead
3616 function blockedPage() {
3617 wfDeprecated( __METHOD__
, '1.19' );
3620 throw new UserBlockedError( $wgUser->getBlock() );
3624 * Produce the stock "please login to edit pages" page
3626 * @deprecated in 1.19; throw an exception directly instead
3628 function userNotLoggedInPage() {
3629 wfDeprecated( __METHOD__
, '1.19' );
3630 throw new PermissionsError( 'edit' );
3634 * Show an error page saying to the user that he has insufficient permissions
3635 * to create a new page
3637 * @deprecated in 1.19; throw an exception directly instead
3639 function noCreatePermission() {
3640 wfDeprecated( __METHOD__
, '1.19' );
3641 $permission = $this->mTitle
->isTalkPage() ?
'createtalk' : 'createpage';
3642 throw new PermissionsError( $permission );
3646 * Creates a basic error page which informs the user that
3647 * they have attempted to edit a nonexistent section.
3649 function noSuchSectionPage() {
3652 $wgOut->prepareErrorPage( wfMessage( 'nosuchsectiontitle' ) );
3654 $res = wfMessage( 'nosuchsectiontext', $this->section
)->parseAsBlock();
3655 wfRunHooks( 'EditPageNoSuchSection', array( &$this, &$res ) );
3656 $wgOut->addHTML( $res );
3658 $wgOut->returnToMain( false, $this->mTitle
);
3662 * Show "your edit contains spam" page with your diff and text
3664 * @param $match string|Array|bool Text (or array of texts) which triggered one or more filters
3666 public function spamPageWithContent( $match = false ) {
3667 global $wgOut, $wgLang;
3668 $this->textbox2
= $this->textbox1
;
3670 if ( is_array( $match ) ) {
3671 $match = $wgLang->listToText( $match );
3673 $wgOut->prepareErrorPage( wfMessage( 'spamprotectiontitle' ) );
3675 $wgOut->addHTML( '<div id="spamprotected">' );
3676 $wgOut->addWikiMsg( 'spamprotectiontext' );
3678 $wgOut->addWikiMsg( 'spamprotectionmatch', wfEscapeWikiText( $match ) );
3680 $wgOut->addHTML( '</div>' );
3682 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
3685 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
3686 $this->showTextbox2();
3688 $wgOut->addReturnTo( $this->getContextTitle(), array( 'action' => 'edit' ) );
3692 * Format an anchor fragment as it would appear for a given section name
3693 * @param $text String
3697 function sectionAnchor( $text ) {
3699 return $wgParser->guessSectionNameFromWikiText( $text );
3703 * Check if the browser is on a blacklist of user-agents known to
3704 * mangle UTF-8 data on form submission. Returns true if Unicode
3705 * should make it through, false if it's known to be a problem.
3709 function checkUnicodeCompliantBrowser() {
3710 global $wgBrowserBlackList, $wgRequest;
3712 $currentbrowser = $wgRequest->getHeader( 'User-Agent' );
3713 if ( $currentbrowser === false ) {
3714 // No User-Agent header sent? Trust it by default...
3718 foreach ( $wgBrowserBlackList as $browser ) {
3719 if ( preg_match( $browser, $currentbrowser ) ) {
3727 * Filter an input field through a Unicode de-armoring process if it
3728 * came from an old browser with known broken Unicode editing issues.
3730 * @param $request WebRequest
3731 * @param $field String
3735 function safeUnicodeInput( $request, $field ) {
3736 $text = rtrim( $request->getText( $field ) );
3737 return $request->getBool( 'safemode' )
3738 ?
$this->unmakesafe( $text )
3743 * @param $request WebRequest
3744 * @param $text string
3747 function safeUnicodeText( $request, $text ) {
3748 $text = rtrim( $text );
3749 return $request->getBool( 'safemode' )
3750 ?
$this->unmakesafe( $text )
3755 * Filter an output field through a Unicode armoring process if it is
3756 * going to an old browser with known broken Unicode editing issues.
3758 * @param $text String
3762 function safeUnicodeOutput( $text ) {
3764 $codedText = $wgContLang->recodeForEdit( $text );
3765 return $this->checkUnicodeCompliantBrowser()
3767 : $this->makesafe( $codedText );
3771 * A number of web browsers are known to corrupt non-ASCII characters
3772 * in a UTF-8 text editing environment. To protect against this,
3773 * detected browsers will be served an armored version of the text,
3774 * with non-ASCII chars converted to numeric HTML character references.
3776 * Preexisting such character references will have a 0 added to them
3777 * to ensure that round-trips do not alter the original data.
3779 * @param $invalue String
3783 function makesafe( $invalue ) {
3784 // Armor existing references for reversibility.
3785 $invalue = strtr( $invalue, array( "&#x" => "�" ) );
3790 for ( $i = 0; $i < strlen( $invalue ); $i++
) {
3791 $bytevalue = ord( $invalue[$i] );
3792 if ( $bytevalue <= 0x7F ) { // 0xxx xxxx
3793 $result .= chr( $bytevalue );
3795 } elseif ( $bytevalue <= 0xBF ) { // 10xx xxxx
3796 $working = $working << 6;
3797 $working +
= ( $bytevalue & 0x3F );
3799 if ( $bytesleft <= 0 ) {
3800 $result .= "&#x" . strtoupper( dechex( $working ) ) . ";";
3802 } elseif ( $bytevalue <= 0xDF ) { // 110x xxxx
3803 $working = $bytevalue & 0x1F;
3805 } elseif ( $bytevalue <= 0xEF ) { // 1110 xxxx
3806 $working = $bytevalue & 0x0F;
3808 } else { // 1111 0xxx
3809 $working = $bytevalue & 0x07;
3817 * Reverse the previously applied transliteration of non-ASCII characters
3818 * back to UTF-8. Used to protect data from corruption by broken web browsers
3819 * as listed in $wgBrowserBlackList.
3821 * @param $invalue String
3825 function unmakesafe( $invalue ) {
3827 for ( $i = 0; $i < strlen( $invalue ); $i++
) {
3828 if ( ( substr( $invalue, $i, 3 ) == "&#x" ) && ( $invalue[$i +
3] != '0' ) ) {
3832 $hexstring .= $invalue[$i];
3834 } while ( ctype_xdigit( $invalue[$i] ) && ( $i < strlen( $invalue ) ) );
3836 // Do some sanity checks. These aren't needed for reversibility,
3837 // but should help keep the breakage down if the editor
3838 // breaks one of the entities whilst editing.
3839 if ( ( substr( $invalue, $i, 1 ) == ";" ) and ( strlen( $hexstring ) <= 6 ) ) {
3840 $codepoint = hexdec( $hexstring );
3841 $result .= codepointToUtf8( $codepoint );
3843 $result .= "&#x" . $hexstring . substr( $invalue, $i, 1 );
3846 $result .= substr( $invalue, $i, 1 );
3849 // reverse the transform that we made for reversibility reasons.
3850 return strtr( $result, array( "�" => "&#x" ) );