3 * User interface for page editing.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
24 * The edit page/HTML interface (split from Article)
25 * The actual database and text munging is still in Article,
26 * but it should get easier to call those from alternate
29 * EditPage cares about two distinct titles:
30 * $this->mContextTitle is the page that forms submit to, links point to,
31 * redirects go to, etc. $this->mTitle (as well as $mArticle) is the
32 * page in the database that is actually being edited. These are
33 * usually the same, but they are now allowed to be different.
35 * Surgeon General's Warning: prolonged exposure to this class is known to cause
36 * headaches, which may be fatal.
40 * Status: Article successfully updated
42 const AS_SUCCESS_UPDATE
= 200;
45 * Status: Article successfully created
47 const AS_SUCCESS_NEW_ARTICLE
= 201;
50 * Status: Article update aborted by a hook function
52 const AS_HOOK_ERROR
= 210;
55 * Status: A hook function returned an error
57 const AS_HOOK_ERROR_EXPECTED
= 212;
60 * Status: User is blocked from editing this page
62 const AS_BLOCKED_PAGE_FOR_USER
= 215;
65 * Status: Content too big (> $wgMaxArticleSize)
67 const AS_CONTENT_TOO_BIG
= 216;
70 * Status: this anonymous user is not allowed to edit this page
72 const AS_READ_ONLY_PAGE_ANON
= 218;
75 * Status: this logged in user is not allowed to edit this page
77 const AS_READ_ONLY_PAGE_LOGGED
= 219;
80 * Status: wiki is in readonly mode (wfReadOnly() == true)
82 const AS_READ_ONLY_PAGE
= 220;
85 * Status: rate limiter for action 'edit' was tripped
87 const AS_RATE_LIMITED
= 221;
90 * Status: article was deleted while editing and param wpRecreate == false or form
93 const AS_ARTICLE_WAS_DELETED
= 222;
96 * Status: user tried to create this page, but is not allowed to do that
97 * ( Title->userCan('create') == false )
99 const AS_NO_CREATE_PERMISSION
= 223;
102 * Status: user tried to create a blank page and wpIgnoreBlankArticle == false
104 const AS_BLANK_ARTICLE
= 224;
107 * Status: (non-resolvable) edit conflict
109 const AS_CONFLICT_DETECTED
= 225;
112 * Status: no edit summary given and the user has forceeditsummary set and the user is not
113 * editing in his own userspace or talkspace and wpIgnoreBlankSummary == false
115 const AS_SUMMARY_NEEDED
= 226;
118 * Status: user tried to create a new section without content
120 const AS_TEXTBOX_EMPTY
= 228;
123 * Status: article is too big (> $wgMaxArticleSize), after merging in the new section
125 const AS_MAX_ARTICLE_SIZE_EXCEEDED
= 229;
128 * Status: WikiPage::doEdit() was unsuccessful
133 * Status: summary contained spam according to one of the regexes in $wgSummarySpamRegex
135 const AS_SPAM_ERROR
= 232;
138 * Status: anonymous user is not allowed to upload (User::isAllowed('upload') == false)
140 const AS_IMAGE_REDIRECT_ANON
= 233;
143 * Status: logged in user is not allowed to upload (User::isAllowed('upload') == false)
145 const AS_IMAGE_REDIRECT_LOGGED
= 234;
148 * Status: user tried to modify the content model, but is not allowed to do that
149 * ( User::isAllowed('editcontentmodel') == false )
151 const AS_NO_CHANGE_CONTENT_MODEL
= 235;
154 * Status: user tried to create self-redirect (redirect to the same article) and
155 * wpIgnoreSelfRedirect == false
157 const AS_SELF_REDIRECT
= 236;
160 * Status: an error relating to change tagging. Look at the message key for
163 const AS_CHANGE_TAG_ERROR
= 237;
166 * Status: can't parse content
168 const AS_PARSE_ERROR
= 240;
171 * HTML id and name for the beginning of the edit form.
173 const EDITFORM_ID
= 'editform';
176 * Prefix of key for cookie used to pass post-edit state.
177 * The revision id edited is added after this
179 const POST_EDIT_COOKIE_KEY_PREFIX
= 'PostEditRevision';
182 * Duration of PostEdit cookie, in seconds.
183 * The cookie will be removed instantly if the JavaScript runs.
185 * Otherwise, though, we don't want the cookies to accumulate.
186 * RFC 2109 ( https://www.ietf.org/rfc/rfc2109.txt ) specifies a possible
187 * limit of only 20 cookies per domain. This still applies at least to some
188 * versions of IE without full updates:
189 * https://blogs.msdn.com/b/ieinternals/archive/2009/08/20/wininet-ie-cookie-internals-faq.aspx
191 * A value of 20 minutes should be enough to take into account slow loads and minor
192 * clock skew while still avoiding cookie accumulation when JavaScript is turned off.
194 const POST_EDIT_COOKIE_DURATION
= 1200;
202 /** @var null|Title */
203 private $mContextTitle = null;
206 public $action = 'submit';
209 public $isConflict = false;
212 public $isCssJsSubpage = false;
215 public $isCssSubpage = false;
218 public $isJsSubpage = false;
221 public $isWrongCaseCssJsPage = false;
223 /** @var bool New page or new section */
224 public $isNew = false;
227 public $deletedSinceEdit;
235 /** @var bool|stdClass */
239 public $mTokenOk = false;
242 public $mTokenOkExceptSuffix = false;
245 public $mTriedSave = false;
248 public $incompleteForm = false;
251 public $tooBig = false;
254 public $kblength = false;
257 public $missingComment = false;
260 public $missingSummary = false;
263 public $allowBlankSummary = false;
266 protected $blankArticle = false;
269 protected $allowBlankArticle = false;
272 protected $selfRedirect = false;
275 protected $allowSelfRedirect = false;
278 public $autoSumm = '';
281 public $hookError = '';
283 /** @var ParserOutput */
284 public $mParserOutput;
286 /** @var bool Has a summary been preset using GET parameter &summary= ? */
287 public $hasPresetSummary = false;
290 public $mBaseRevision = false;
293 public $mShowSummaryField = true;
298 public $save = false;
301 public $preview = false;
304 public $diff = false;
307 public $minoredit = false;
310 public $watchthis = false;
313 public $recreate = false;
316 public $textbox1 = '';
319 public $textbox2 = '';
322 public $summary = '';
325 public $nosummary = false;
328 public $edittime = '';
331 public $section = '';
334 public $sectiontitle = '';
337 public $starttime = '';
343 public $parentRevId = 0;
346 public $editintro = '';
349 public $scrolltop = null;
354 /** @var null|string */
355 public $contentModel = null;
357 /** @var null|string */
358 public $contentFormat = null;
360 /** @var null|array */
361 public $changeTags = null;
363 # Placeholders for text injection by hooks (must be HTML)
364 # extensions should take care to _append_ to the present value
366 /** @var string Before even the preview */
367 public $editFormPageTop = '';
368 public $editFormTextTop = '';
369 public $editFormTextBeforeContent = '';
370 public $editFormTextAfterWarn = '';
371 public $editFormTextAfterTools = '';
372 public $editFormTextBottom = '';
373 public $editFormTextAfterContent = '';
374 public $previewTextAfterContent = '';
375 public $mPreloadContent = null;
377 /* $didSave should be set to true whenever an article was successfully altered. */
378 public $didSave = false;
379 public $undidRev = 0;
381 public $suppressIntro = false;
387 * @var bool Set in ApiEditPage, based on ContentHandler::allowsDirectApiEditing
389 private $enableApiEditOverride = false;
392 * @param Article $article
394 public function __construct( Article
$article ) {
395 $this->mArticle
= $article;
396 $this->mTitle
= $article->getTitle();
398 $this->contentModel
= $this->mTitle
->getContentModel();
400 $handler = ContentHandler
::getForModelID( $this->contentModel
);
401 $this->contentFormat
= $handler->getDefaultFormat();
407 public function getArticle() {
408 return $this->mArticle
;
415 public function getTitle() {
416 return $this->mTitle
;
420 * Set the context Title object
422 * @param Title|null $title Title object or null
424 public function setContextTitle( $title ) {
425 $this->mContextTitle
= $title;
429 * Get the context title object.
430 * If not set, $wgTitle will be returned. This behavior might change in
431 * the future to return $this->mTitle instead.
435 public function getContextTitle() {
436 if ( is_null( $this->mContextTitle
) ) {
440 return $this->mContextTitle
;
445 * Returns if the given content model is editable.
447 * @param string $modelId The ID of the content model to test. Use CONTENT_MODEL_XXX constants.
449 * @throws MWException If $modelId has no known handler
451 public function isSupportedContentModel( $modelId ) {
452 return $this->enableApiEditOverride
=== true ||
453 ContentHandler
::getForModelID( $modelId )->supportsDirectEditing();
457 * Allow editing of content that supports API direct editing, but not general
458 * direct editing. Set to false by default.
460 * @param bool $enableOverride
462 public function setApiEditOverride( $enableOverride ) {
463 $this->enableApiEditOverride
= $enableOverride;
471 * This is the function that gets called for "action=edit". It
472 * sets up various member variables, then passes execution to
473 * another function, usually showEditForm()
475 * The edit form is self-submitting, so that when things like
476 * preview and edit conflicts occur, we get the same form back
477 * with the extra stuff added. Only when the final submission
478 * is made and all is well do we actually save and redirect to
479 * the newly-edited page.
482 global $wgOut, $wgRequest, $wgUser;
483 // Allow extensions to modify/prevent this form or submission
484 if ( !Hooks
::run( 'AlternateEdit', array( $this ) ) ) {
488 wfDebug( __METHOD__
. ": enter\n" );
490 // If they used redlink=1 and the page exists, redirect to the main article
491 if ( $wgRequest->getBool( 'redlink' ) && $this->mTitle
->exists() ) {
492 $wgOut->redirect( $this->mTitle
->getFullURL() );
496 $this->importFormData( $wgRequest );
497 $this->firsttime
= false;
499 if ( wfReadOnly() && $this->save
) {
502 $this->preview
= true;
506 $this->formtype
= 'save';
507 } elseif ( $this->preview
) {
508 $this->formtype
= 'preview';
509 } elseif ( $this->diff
) {
510 $this->formtype
= 'diff';
511 } else { # First time through
512 $this->firsttime
= true;
513 if ( $this->previewOnOpen() ) {
514 $this->formtype
= 'preview';
516 $this->formtype
= 'initial';
520 $permErrors = $this->getEditPermissionErrors( $this->save ?
'secure' : 'full' );
522 wfDebug( __METHOD__
. ": User can't edit\n" );
523 // Auto-block user's IP if the account was "hard" blocked
524 $wgUser->spreadAnyEditBlock();
526 $this->displayPermissionsError( $permErrors );
531 $this->isConflict
= false;
532 // css / js subpages of user pages get a special treatment
533 $this->isCssJsSubpage
= $this->mTitle
->isCssJsSubpage();
534 $this->isCssSubpage
= $this->mTitle
->isCssSubpage();
535 $this->isJsSubpage
= $this->mTitle
->isJsSubpage();
536 // @todo FIXME: Silly assignment.
537 $this->isWrongCaseCssJsPage
= $this->isWrongCaseCssJsPage();
539 # Show applicable editing introductions
540 if ( $this->formtype
== 'initial' ||
$this->firsttime
) {
544 # Attempt submission here. This will check for edit conflicts,
545 # and redundantly check for locked database, blocked IPs, etc.
546 # that edit() already checked just in case someone tries to sneak
547 # in the back door with a hand-edited submission URL.
549 if ( 'save' == $this->formtype
) {
550 $resultDetails = null;
551 $status = $this->attemptSave( $resultDetails );
552 if ( !$this->handleStatus( $status, $resultDetails ) ) {
557 # First time through: get contents, set time for conflict
559 if ( 'initial' == $this->formtype ||
$this->firsttime
) {
560 if ( $this->initialiseForm() === false ) {
561 $this->noSuchSectionPage();
565 if ( !$this->mTitle
->getArticleID() ) {
566 Hooks
::run( 'EditFormPreloadText', array( &$this->textbox1
, &$this->mTitle
) );
568 Hooks
::run( 'EditFormInitialText', array( $this ) );
573 $this->showEditForm();
577 * @param string $rigor Same format as Title::getUserPermissionErrors()
580 protected function getEditPermissionErrors( $rigor = 'secure' ) {
583 $permErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $wgUser, $rigor );
584 # Can this title be created?
585 if ( !$this->mTitle
->exists() ) {
586 $permErrors = array_merge(
589 $this->mTitle
->getUserPermissionsErrors( 'create', $wgUser, $rigor ),
594 # Ignore some permissions errors when a user is just previewing/viewing diffs
596 foreach ( $permErrors as $error ) {
597 if ( ( $this->preview ||
$this->diff
)
598 && ( $error[0] == 'blockedtext' ||
$error[0] == 'autoblockedtext' )
603 $permErrors = wfArrayDiff2( $permErrors, $remove );
609 * Display a permissions error page, like OutputPage::showPermissionsErrorPage(),
610 * but with the following differences:
611 * - If redlink=1, the user will be redirected to the page
612 * - If there is content to display or the error occurs while either saving,
613 * previewing or showing the difference, it will be a
614 * "View source for ..." page displaying the source code after the error message.
617 * @param array $permErrors Array of permissions errors, as returned by
618 * Title::getUserPermissionsErrors().
619 * @throws PermissionsError
621 protected function displayPermissionsError( array $permErrors ) {
622 global $wgRequest, $wgOut;
624 if ( $wgRequest->getBool( 'redlink' ) ) {
625 // The edit page was reached via a red link.
626 // Redirect to the article page and let them click the edit tab if
627 // they really want a permission error.
628 $wgOut->redirect( $this->mTitle
->getFullURL() );
632 $content = $this->getContentObject();
634 # Use the normal message if there's nothing to display
635 if ( $this->firsttime
&& ( !$content ||
$content->isEmpty() ) ) {
636 $action = $this->mTitle
->exists() ?
'edit' :
637 ( $this->mTitle
->isTalkPage() ?
'createtalk' : 'createpage' );
638 throw new PermissionsError( $action, $permErrors );
641 Hooks
::run( 'EditPage::showReadOnlyForm:initial', array( $this, &$wgOut ) );
643 $wgOut->setRobotPolicy( 'noindex,nofollow' );
644 $wgOut->setPageTitle( wfMessage(
646 $this->getContextTitle()->getPrefixedText()
648 $wgOut->addBacklinkSubtitle( $this->getContextTitle() );
649 $wgOut->addWikiText( $wgOut->formatPermissionsErrorMessage( $permErrors, 'edit' ) );
650 $wgOut->addHTML( "<hr />\n" );
652 # If the user made changes, preserve them when showing the markup
653 # (This happens when a user is blocked during edit, for instance)
654 if ( !$this->firsttime
) {
655 $text = $this->textbox1
;
656 $wgOut->addWikiMsg( 'viewyourtext' );
658 $text = $this->toEditText( $content );
659 $wgOut->addWikiMsg( 'viewsourcetext' );
662 $this->showTextbox( $text, 'wpTextbox1', array( 'readonly' ) );
664 $wgOut->addHTML( Html
::rawElement( 'div', array( 'class' => 'templatesUsed' ),
665 Linker
::formatTemplates( $this->getTemplates() ) ) );
667 $wgOut->addModules( 'mediawiki.action.edit.collapsibleFooter' );
669 if ( $this->mTitle
->exists() ) {
670 $wgOut->returnToMain( null, $this->mTitle
);
675 * Should we show a preview when the edit form is first shown?
679 protected function previewOnOpen() {
680 global $wgRequest, $wgUser, $wgPreviewOnOpenNamespaces;
681 if ( $wgRequest->getVal( 'preview' ) == 'yes' ) {
682 // Explicit override from request
684 } elseif ( $wgRequest->getVal( 'preview' ) == 'no' ) {
685 // Explicit override from request
687 } elseif ( $this->section
== 'new' ) {
688 // Nothing *to* preview for new sections
690 } elseif ( ( $wgRequest->getVal( 'preload' ) !== null ||
$this->mTitle
->exists() )
691 && $wgUser->getOption( 'previewonfirst' )
693 // Standard preference behavior
695 } elseif ( !$this->mTitle
->exists()
696 && isset( $wgPreviewOnOpenNamespaces[$this->mTitle
->getNamespace()] )
697 && $wgPreviewOnOpenNamespaces[$this->mTitle
->getNamespace()]
699 // Categories are special
707 * Checks whether the user entered a skin name in uppercase,
708 * e.g. "User:Example/Monobook.css" instead of "monobook.css"
712 protected function isWrongCaseCssJsPage() {
713 if ( $this->mTitle
->isCssJsSubpage() ) {
714 $name = $this->mTitle
->getSkinFromCssJsSubpage();
715 $skins = array_merge(
716 array_keys( Skin
::getSkinNames() ),
719 return !in_array( $name, $skins )
720 && in_array( strtolower( $name ), $skins );
727 * Returns whether section editing is supported for the current page.
728 * Subclasses may override this to replace the default behavior, which is
729 * to check ContentHandler::supportsSections.
731 * @return bool True if this edit page supports sections, false otherwise.
733 protected function isSectionEditSupported() {
734 $contentHandler = ContentHandler
::getForTitle( $this->mTitle
);
735 return $contentHandler->supportsSections();
739 * This function collects the form data and uses it to populate various member variables.
740 * @param WebRequest $request
741 * @throws ErrorPageError
743 function importFormData( &$request ) {
744 global $wgContLang, $wgUser;
746 # Section edit can come from either the form or a link
747 $this->section
= $request->getVal( 'wpSection', $request->getVal( 'section' ) );
749 if ( $this->section
!== null && $this->section
!== '' && !$this->isSectionEditSupported() ) {
750 throw new ErrorPageError( 'sectioneditnotsupported-title', 'sectioneditnotsupported-text' );
753 $this->isNew
= !$this->mTitle
->exists() ||
$this->section
== 'new';
755 if ( $request->wasPosted() ) {
756 # These fields need to be checked for encoding.
757 # Also remove trailing whitespace, but don't remove _initial_
758 # whitespace from the text boxes. This may be significant formatting.
759 $this->textbox1
= $this->safeUnicodeInput( $request, 'wpTextbox1' );
760 if ( !$request->getCheck( 'wpTextbox2' ) ) {
761 // Skip this if wpTextbox2 has input, it indicates that we came
762 // from a conflict page with raw page text, not a custom form
763 // modified by subclasses
764 $textbox1 = $this->importContentFormData( $request );
765 if ( $textbox1 !== null ) {
766 $this->textbox1
= $textbox1;
770 # Truncate for whole multibyte characters
771 $this->summary
= $wgContLang->truncate( $request->getText( 'wpSummary' ), 255 );
773 # If the summary consists of a heading, e.g. '==Foobar==', extract the title from the
774 # header syntax, e.g. 'Foobar'. This is mainly an issue when we are using wpSummary for
776 $this->summary
= preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->summary
);
778 # Treat sectiontitle the same way as summary.
779 # Note that wpSectionTitle is not yet a part of the actual edit form, as wpSummary is
780 # currently doing double duty as both edit summary and section title. Right now this
781 # is just to allow API edits to work around this limitation, but this should be
782 # incorporated into the actual edit form when EditPage is rewritten (Bugs 18654, 26312).
783 $this->sectiontitle
= $wgContLang->truncate( $request->getText( 'wpSectionTitle' ), 255 );
784 $this->sectiontitle
= preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->sectiontitle
);
786 $this->edittime
= $request->getVal( 'wpEdittime' );
787 $this->starttime
= $request->getVal( 'wpStarttime' );
789 $undidRev = $request->getInt( 'wpUndidRevision' );
791 $this->undidRev
= $undidRev;
794 $this->scrolltop
= $request->getIntOrNull( 'wpScrolltop' );
796 if ( $this->textbox1
=== '' && $request->getVal( 'wpTextbox1' ) === null ) {
797 // wpTextbox1 field is missing, possibly due to being "too big"
798 // according to some filter rules such as Suhosin's setting for
799 // suhosin.request.max_value_length (d'oh)
800 $this->incompleteForm
= true;
802 // If we receive the last parameter of the request, we can fairly
803 // claim the POST request has not been truncated.
805 // TODO: softened the check for cutover. Once we determine
806 // that it is safe, we should complete the transition by
807 // removing the "edittime" clause.
808 $this->incompleteForm
= ( !$request->getVal( 'wpUltimateParam' )
809 && is_null( $this->edittime
) );
811 if ( $this->incompleteForm
) {
812 # If the form is incomplete, force to preview.
813 wfDebug( __METHOD__
. ": Form data appears to be incomplete\n" );
814 wfDebug( "POST DATA: " . var_export( $_POST, true ) . "\n" );
815 $this->preview
= true;
817 $this->preview
= $request->getCheck( 'wpPreview' );
818 $this->diff
= $request->getCheck( 'wpDiff' );
820 // Remember whether a save was requested, so we can indicate
821 // if we forced preview due to session failure.
822 $this->mTriedSave
= !$this->preview
;
824 if ( $this->tokenOk( $request ) ) {
825 # Some browsers will not report any submit button
826 # if the user hits enter in the comment box.
827 # The unmarked state will be assumed to be a save,
828 # if the form seems otherwise complete.
829 wfDebug( __METHOD__
. ": Passed token check.\n" );
830 } elseif ( $this->diff
) {
831 # Failed token check, but only requested "Show Changes".
832 wfDebug( __METHOD__
. ": Failed token check; Show Changes requested.\n" );
834 # Page might be a hack attempt posted from
835 # an external site. Preview instead of saving.
836 wfDebug( __METHOD__
. ": Failed token check; forcing preview\n" );
837 $this->preview
= true;
840 $this->save
= !$this->preview
&& !$this->diff
;
841 if ( !preg_match( '/^\d{14}$/', $this->edittime
) ) {
842 $this->edittime
= null;
845 if ( !preg_match( '/^\d{14}$/', $this->starttime
) ) {
846 $this->starttime
= null;
849 $this->recreate
= $request->getCheck( 'wpRecreate' );
851 $this->minoredit
= $request->getCheck( 'wpMinoredit' );
852 $this->watchthis
= $request->getCheck( 'wpWatchthis' );
854 # Don't force edit summaries when a user is editing their own user or talk page
855 if ( ( $this->mTitle
->mNamespace
== NS_USER ||
$this->mTitle
->mNamespace
== NS_USER_TALK
)
856 && $this->mTitle
->getText() == $wgUser->getName()
858 $this->allowBlankSummary
= true;
860 $this->allowBlankSummary
= $request->getBool( 'wpIgnoreBlankSummary' )
861 ||
!$wgUser->getOption( 'forceeditsummary' );
864 $this->autoSumm
= $request->getText( 'wpAutoSummary' );
866 $this->allowBlankArticle
= $request->getBool( 'wpIgnoreBlankArticle' );
867 $this->allowSelfRedirect
= $request->getBool( 'wpIgnoreSelfRedirect' );
869 $changeTags = $request->getVal( 'wpChangeTags' );
870 if ( is_null( $changeTags ) ||
$changeTags === '' ) {
871 $this->changeTags
= array();
873 $this->changeTags
= array_filter( array_map( 'trim', explode( ',',
877 # Not a posted form? Start with nothing.
878 wfDebug( __METHOD__
. ": Not a posted form.\n" );
879 $this->textbox1
= '';
881 $this->sectiontitle
= '';
882 $this->edittime
= '';
883 $this->starttime
= wfTimestampNow();
885 $this->preview
= false;
888 $this->minoredit
= false;
889 // Watch may be overridden by request parameters
890 $this->watchthis
= $request->getBool( 'watchthis', false );
891 $this->recreate
= false;
893 // When creating a new section, we can preload a section title by passing it as the
894 // preloadtitle parameter in the URL (Bug 13100)
895 if ( $this->section
== 'new' && $request->getVal( 'preloadtitle' ) ) {
896 $this->sectiontitle
= $request->getVal( 'preloadtitle' );
897 // Once wpSummary isn't being use for setting section titles, we should delete this.
898 $this->summary
= $request->getVal( 'preloadtitle' );
899 } elseif ( $this->section
!= 'new' && $request->getVal( 'summary' ) ) {
900 $this->summary
= $request->getText( 'summary' );
901 if ( $this->summary
!== '' ) {
902 $this->hasPresetSummary
= true;
906 if ( $request->getVal( 'minor' ) ) {
907 $this->minoredit
= true;
911 $this->oldid
= $request->getInt( 'oldid' );
912 $this->parentRevId
= $request->getInt( 'parentRevId' );
914 $this->bot
= $request->getBool( 'bot', true );
915 $this->nosummary
= $request->getBool( 'nosummary' );
917 // May be overridden by revision.
918 $this->contentModel
= $request->getText( 'model', $this->contentModel
);
919 // May be overridden by revision.
920 $this->contentFormat
= $request->getText( 'format', $this->contentFormat
);
922 if ( !ContentHandler
::getForModelID( $this->contentModel
)
923 ->isSupportedFormat( $this->contentFormat
)
925 throw new ErrorPageError(
926 'editpage-notsupportedcontentformat-title',
927 'editpage-notsupportedcontentformat-text',
928 array( $this->contentFormat
, ContentHandler
::getLocalizedName( $this->contentModel
) )
933 * @todo Check if the desired model is allowed in this namespace, and if
934 * a transition from the page's current model to the new model is
938 $this->editintro
= $request->getText( 'editintro',
939 // Custom edit intro for new sections
940 $this->section
=== 'new' ?
'MediaWiki:addsection-editintro' : '' );
942 // Allow extensions to modify form data
943 Hooks
::run( 'EditPage::importFormData', array( $this, $request ) );
948 * Subpage overridable method for extracting the page content data from the
949 * posted form to be placed in $this->textbox1, if using customized input
950 * this method should be overridden and return the page text that will be used
951 * for saving, preview parsing and so on...
953 * @param WebRequest $request
955 protected function importContentFormData( &$request ) {
956 return; // Don't do anything, EditPage already extracted wpTextbox1
960 * Initialise form fields in the object
961 * Called on the first invocation, e.g. when a user clicks an edit link
962 * @return bool If the requested section is valid
964 function initialiseForm() {
966 $this->edittime
= $this->mArticle
->getTimestamp();
968 $content = $this->getContentObject( false ); #TODO: track content object?!
969 if ( $content === false ) {
972 $this->textbox1
= $this->toEditText( $content );
974 // activate checkboxes if user wants them to be always active
975 # Sort out the "watch" checkbox
976 if ( $wgUser->getOption( 'watchdefault' ) ) {
978 $this->watchthis
= true;
979 } elseif ( $wgUser->getOption( 'watchcreations' ) && !$this->mTitle
->exists() ) {
981 $this->watchthis
= true;
982 } elseif ( $wgUser->isWatched( $this->mTitle
) ) {
984 $this->watchthis
= true;
986 if ( $wgUser->getOption( 'minordefault' ) && !$this->isNew
) {
987 $this->minoredit
= true;
989 if ( $this->textbox1
=== false ) {
996 * @param Content|null $def_content The default value to return
998 * @return Content|null Content on success, $def_content for invalid sections
1002 protected function getContentObject( $def_content = null ) {
1003 global $wgOut, $wgRequest, $wgUser, $wgContLang;
1007 // For message page not locally set, use the i18n message.
1008 // For other non-existent articles, use preload text if any.
1009 if ( !$this->mTitle
->exists() ||
$this->section
== 'new' ) {
1010 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
&& $this->section
!= 'new' ) {
1011 # If this is a system message, get the default text.
1012 $msg = $this->mTitle
->getDefaultMessageText();
1014 $content = $this->toEditContent( $msg );
1016 if ( $content === false ) {
1017 # If requested, preload some text.
1018 $preload = $wgRequest->getVal( 'preload',
1019 // Custom preload text for new sections
1020 $this->section
=== 'new' ?
'MediaWiki:addsection-preload' : '' );
1021 $params = $wgRequest->getArray( 'preloadparams', array() );
1023 $content = $this->getPreloadedContent( $preload, $params );
1025 // For existing pages, get text based on "undo" or section parameters.
1027 if ( $this->section
!= '' ) {
1028 // Get section edit text (returns $def_text for invalid sections)
1029 $orig = $this->getOriginalContent( $wgUser );
1030 $content = $orig ?
$orig->getSection( $this->section
) : null;
1033 $content = $def_content;
1036 $undoafter = $wgRequest->getInt( 'undoafter' );
1037 $undo = $wgRequest->getInt( 'undo' );
1039 if ( $undo > 0 && $undoafter > 0 ) {
1041 $undorev = Revision
::newFromId( $undo );
1042 $oldrev = Revision
::newFromId( $undoafter );
1044 # Sanity check, make sure it's the right page,
1045 # the revisions exist and they were not deleted.
1046 # Otherwise, $content will be left as-is.
1047 if ( !is_null( $undorev ) && !is_null( $oldrev ) &&
1048 !$undorev->isDeleted( Revision
::DELETED_TEXT
) &&
1049 !$oldrev->isDeleted( Revision
::DELETED_TEXT
) ) {
1051 $content = $this->mArticle
->getUndoContent( $undorev, $oldrev );
1053 if ( $content === false ) {
1054 # Warn the user that something went wrong
1055 $undoMsg = 'failure';
1057 $oldContent = $this->mArticle
->getPage()->getContent( Revision
::RAW
);
1058 $popts = ParserOptions
::newFromUserAndLang( $wgUser, $wgContLang );
1059 $newContent = $content->preSaveTransform( $this->mTitle
, $wgUser, $popts );
1061 if ( $newContent->equals( $oldContent ) ) {
1062 # Tell the user that the undo results in no change,
1063 # i.e. the revisions were already undone.
1064 $undoMsg = 'nochange';
1067 # Inform the user of our success and set an automatic edit summary
1068 $undoMsg = 'success';
1070 # If we just undid one rev, use an autosummary
1071 $firstrev = $oldrev->getNext();
1072 if ( $firstrev && $firstrev->getId() == $undo ) {
1073 $userText = $undorev->getUserText();
1074 if ( $userText === '' ) {
1075 $undoSummary = wfMessage(
1076 'undo-summary-username-hidden',
1078 )->inContentLanguage()->text();
1080 $undoSummary = wfMessage(
1084 )->inContentLanguage()->text();
1086 if ( $this->summary
=== '' ) {
1087 $this->summary
= $undoSummary;
1089 $this->summary
= $undoSummary . wfMessage( 'colon-separator' )
1090 ->inContentLanguage()->text() . $this->summary
;
1092 $this->undidRev
= $undo;
1094 $this->formtype
= 'diff';
1098 // Failed basic sanity checks.
1099 // Older revisions may have been removed since the link
1100 // was created, or we may simply have got bogus input.
1104 // Messages: undo-success, undo-failure, undo-norev, undo-nochange
1105 $class = ( $undoMsg == 'success' ?
'' : 'error ' ) . "mw-undo-{$undoMsg}";
1106 $this->editFormPageTop
.= $wgOut->parse( "<div class=\"{$class}\">" .
1107 wfMessage( 'undo-' . $undoMsg )->plain() . '</div>', true, /* interface */true );
1110 if ( $content === false ) {
1111 $content = $this->getOriginalContent( $wgUser );
1120 * Get the content of the wanted revision, without section extraction.
1122 * The result of this function can be used to compare user's input with
1123 * section replaced in its context (using WikiPage::replaceSection())
1124 * to the original text of the edit.
1126 * This differs from Article::getContent() that when a missing revision is
1127 * encountered the result will be null and not the
1128 * 'missing-revision' message.
1131 * @param User $user The user to get the revision for
1132 * @return Content|null
1134 private function getOriginalContent( User
$user ) {
1135 if ( $this->section
== 'new' ) {
1136 return $this->getCurrentContent();
1138 $revision = $this->mArticle
->getRevisionFetched();
1139 if ( $revision === null ) {
1140 if ( !$this->contentModel
) {
1141 $this->contentModel
= $this->getTitle()->getContentModel();
1143 $handler = ContentHandler
::getForModelID( $this->contentModel
);
1145 return $handler->makeEmptyContent();
1147 $content = $revision->getContent( Revision
::FOR_THIS_USER
, $user );
1152 * Get the current content of the page. This is basically similar to
1153 * WikiPage::getContent( Revision::RAW ) except that when the page doesn't exist an empty
1154 * content object is returned instead of null.
1159 protected function getCurrentContent() {
1160 $rev = $this->mArticle
->getRevision();
1161 $content = $rev ?
$rev->getContent( Revision
::RAW
) : null;
1163 if ( $content === false ||
$content === null ) {
1164 if ( !$this->contentModel
) {
1165 $this->contentModel
= $this->getTitle()->getContentModel();
1167 $handler = ContentHandler
::getForModelID( $this->contentModel
);
1169 return $handler->makeEmptyContent();
1171 # nasty side-effect, but needed for consistency
1172 $this->contentModel
= $rev->getContentModel();
1173 $this->contentFormat
= $rev->getContentFormat();
1180 * Use this method before edit() to preload some content into the edit box
1182 * @param Content $content
1186 public function setPreloadedContent( Content
$content ) {
1187 $this->mPreloadContent
= $content;
1191 * Get the contents to be preloaded into the box, either set by
1192 * an earlier setPreloadText() or by loading the given page.
1194 * @param string $preload Representing the title to preload from.
1195 * @param array $params Parameters to use (interface-message style) in the preloaded text
1201 protected function getPreloadedContent( $preload, $params = array() ) {
1204 if ( !empty( $this->mPreloadContent
) ) {
1205 return $this->mPreloadContent
;
1208 $handler = ContentHandler
::getForTitle( $this->getTitle() );
1210 if ( $preload === '' ) {
1211 return $handler->makeEmptyContent();
1214 $title = Title
::newFromText( $preload );
1215 # Check for existence to avoid getting MediaWiki:Noarticletext
1216 if ( $title === null ||
!$title->exists() ||
!$title->userCan( 'read', $wgUser ) ) {
1217 //TODO: somehow show a warning to the user!
1218 return $handler->makeEmptyContent();
1221 $page = WikiPage
::factory( $title );
1222 if ( $page->isRedirect() ) {
1223 $title = $page->getRedirectTarget();
1225 if ( $title === null ||
!$title->exists() ||
!$title->userCan( 'read', $wgUser ) ) {
1226 //TODO: somehow show a warning to the user!
1227 return $handler->makeEmptyContent();
1229 $page = WikiPage
::factory( $title );
1232 $parserOptions = ParserOptions
::newFromUser( $wgUser );
1233 $content = $page->getContent( Revision
::RAW
);
1236 //TODO: somehow show a warning to the user!
1237 return $handler->makeEmptyContent();
1240 if ( $content->getModel() !== $handler->getModelID() ) {
1241 $converted = $content->convert( $handler->getModelID() );
1243 if ( !$converted ) {
1244 //TODO: somehow show a warning to the user!
1245 wfDebug( "Attempt to preload incompatible content: "
1246 . "can't convert " . $content->getModel()
1247 . " to " . $handler->getModelID() );
1249 return $handler->makeEmptyContent();
1252 $content = $converted;
1255 return $content->preloadTransform( $title, $parserOptions, $params );
1259 * Make sure the form isn't faking a user's credentials.
1261 * @param WebRequest $request
1265 function tokenOk( &$request ) {
1267 $token = $request->getVal( 'wpEditToken' );
1268 $this->mTokenOk
= $wgUser->matchEditToken( $token );
1269 $this->mTokenOkExceptSuffix
= $wgUser->matchEditTokenNoSuffix( $token );
1270 return $this->mTokenOk
;
1274 * Sets post-edit cookie indicating the user just saved a particular revision.
1276 * This uses a temporary cookie for each revision ID so separate saves will never
1277 * interfere with each other.
1279 * The cookie is deleted in the mediawiki.action.view.postEdit JS module after
1280 * the redirect. It must be clearable by JavaScript code, so it must not be
1281 * marked HttpOnly. The JavaScript code converts the cookie to a wgPostEdit config
1284 * If the variable were set on the server, it would be cached, which is unwanted
1285 * since the post-edit state should only apply to the load right after the save.
1287 * @param int $statusValue The status value (to check for new article status)
1289 protected function setPostEditCookie( $statusValue ) {
1290 $revisionId = $this->mArticle
->getLatest();
1291 $postEditKey = self
::POST_EDIT_COOKIE_KEY_PREFIX
. $revisionId;
1294 if ( $statusValue == self
::AS_SUCCESS_NEW_ARTICLE
) {
1296 } elseif ( $this->oldid
) {
1300 $response = RequestContext
::getMain()->getRequest()->response();
1301 $response->setcookie( $postEditKey, $val, time() + self
::POST_EDIT_COOKIE_DURATION
, array(
1302 'httpOnly' => false,
1307 * Attempt submission
1308 * @param array $resultDetails See docs for $result in internalAttemptSave
1309 * @throws UserBlockedError|ReadOnlyError|ThrottledError|PermissionsError
1310 * @return Status The resulting status object.
1312 public function attemptSave( &$resultDetails = false ) {
1315 # Allow bots to exempt some edits from bot flagging
1316 $bot = $wgUser->isAllowed( 'bot' ) && $this->bot
;
1317 $status = $this->internalAttemptSave( $resultDetails, $bot );
1319 Hooks
::run( 'EditPage::attemptSave:after', array( $this, $status, $resultDetails ) );
1325 * Handle status, such as after attempt save
1327 * @param Status $status
1328 * @param array|bool $resultDetails
1330 * @throws ErrorPageError
1331 * @return bool False, if output is done, true if rest of the form should be displayed
1333 private function handleStatus( Status
$status, $resultDetails ) {
1334 global $wgUser, $wgOut;
1337 * @todo FIXME: once the interface for internalAttemptSave() is made
1338 * nicer, this should use the message in $status
1340 if ( $status->value
== self
::AS_SUCCESS_UPDATE
1341 ||
$status->value
== self
::AS_SUCCESS_NEW_ARTICLE
1343 $this->didSave
= true;
1344 if ( !$resultDetails['nullEdit'] ) {
1345 $this->setPostEditCookie( $status->value
);
1349 switch ( $status->value
) {
1350 case self
::AS_HOOK_ERROR_EXPECTED
:
1351 case self
::AS_CONTENT_TOO_BIG
:
1352 case self
::AS_ARTICLE_WAS_DELETED
:
1353 case self
::AS_CONFLICT_DETECTED
:
1354 case self
::AS_SUMMARY_NEEDED
:
1355 case self
::AS_TEXTBOX_EMPTY
:
1356 case self
::AS_MAX_ARTICLE_SIZE_EXCEEDED
:
1358 case self
::AS_BLANK_ARTICLE
:
1359 case self
::AS_SELF_REDIRECT
:
1362 case self
::AS_HOOK_ERROR
:
1365 case self
::AS_PARSE_ERROR
:
1366 $wgOut->addWikiText( '<div class="error">' . $status->getWikiText() . '</div>' );
1369 case self
::AS_SUCCESS_NEW_ARTICLE
:
1370 $query = $resultDetails['redirect'] ?
'redirect=no' : '';
1371 $anchor = isset( $resultDetails['sectionanchor'] ) ?
$resultDetails['sectionanchor'] : '';
1372 $wgOut->redirect( $this->mTitle
->getFullURL( $query ) . $anchor );
1375 case self
::AS_SUCCESS_UPDATE
:
1377 $sectionanchor = $resultDetails['sectionanchor'];
1379 // Give extensions a chance to modify URL query on update
1381 'ArticleUpdateBeforeRedirect',
1382 array( $this->mArticle
, &$sectionanchor, &$extraQuery )
1385 if ( $resultDetails['redirect'] ) {
1386 if ( $extraQuery == '' ) {
1387 $extraQuery = 'redirect=no';
1389 $extraQuery = 'redirect=no&' . $extraQuery;
1392 $wgOut->redirect( $this->mTitle
->getFullURL( $extraQuery ) . $sectionanchor );
1395 case self
::AS_SPAM_ERROR
:
1396 $this->spamPageWithContent( $resultDetails['spam'] );
1399 case self
::AS_BLOCKED_PAGE_FOR_USER
:
1400 throw new UserBlockedError( $wgUser->getBlock() );
1402 case self
::AS_IMAGE_REDIRECT_ANON
:
1403 case self
::AS_IMAGE_REDIRECT_LOGGED
:
1404 throw new PermissionsError( 'upload' );
1406 case self
::AS_READ_ONLY_PAGE_ANON
:
1407 case self
::AS_READ_ONLY_PAGE_LOGGED
:
1408 throw new PermissionsError( 'edit' );
1410 case self
::AS_READ_ONLY_PAGE
:
1411 throw new ReadOnlyError
;
1413 case self
::AS_RATE_LIMITED
:
1414 throw new ThrottledError();
1416 case self
::AS_NO_CREATE_PERMISSION
:
1417 $permission = $this->mTitle
->isTalkPage() ?
'createtalk' : 'createpage';
1418 throw new PermissionsError( $permission );
1420 case self
::AS_NO_CHANGE_CONTENT_MODEL
:
1421 throw new PermissionsError( 'editcontentmodel' );
1424 // We don't recognize $status->value. The only way that can happen
1425 // is if an extension hook aborted from inside ArticleSave.
1426 // Render the status object into $this->hookError
1427 // FIXME this sucks, we should just use the Status object throughout
1428 $this->hookError
= '<div class="error">' . $status->getWikitext() .
1435 * Run hooks that can filter edits just before they get saved.
1437 * @param Content $content The Content to filter.
1438 * @param Status $status For reporting the outcome to the caller
1439 * @param User $user The user performing the edit
1443 protected function runPostMergeFilters( Content
$content, Status
$status, User
$user ) {
1444 // Run old style post-section-merge edit filter
1445 if ( !ContentHandler
::runLegacyHooks( 'EditFilterMerged',
1446 array( $this, $content, &$this->hookError
, $this->summary
) )
1448 # Error messages etc. could be handled within the hook...
1449 $status->fatal( 'hookaborted' );
1450 $status->value
= self
::AS_HOOK_ERROR
;
1452 } elseif ( $this->hookError
!= '' ) {
1453 # ...or the hook could be expecting us to produce an error
1454 $status->fatal( 'hookaborted' );
1455 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1459 // Run new style post-section-merge edit filter
1460 if ( !Hooks
::run( 'EditFilterMergedContent',
1461 array( $this->mArticle
->getContext(), $content, $status, $this->summary
,
1462 $user, $this->minoredit
) )
1464 # Error messages etc. could be handled within the hook...
1465 if ( $status->isGood() ) {
1466 $status->fatal( 'hookaborted' );
1467 // Not setting $this->hookError here is a hack to allow the hook
1468 // to cause a return to the edit page without $this->hookError
1469 // being set. This is used by ConfirmEdit to display a captcha
1470 // without any error message cruft.
1472 $this->hookError
= $status->getWikiText();
1474 // Use the existing $status->value if the hook set it
1475 if ( !$status->value
) {
1476 $status->value
= self
::AS_HOOK_ERROR
;
1479 } elseif ( !$status->isOK() ) {
1480 # ...or the hook could be expecting us to produce an error
1481 // FIXME this sucks, we should just use the Status object throughout
1482 $this->hookError
= $status->getWikiText();
1483 $status->fatal( 'hookaborted' );
1484 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1492 * Return the summary to be used for a new section.
1494 * @param string $sectionanchor Set to the section anchor text
1497 private function newSectionSummary( &$sectionanchor = null ) {
1500 if ( $this->sectiontitle
!== '' ) {
1501 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $this->sectiontitle
);
1502 // If no edit summary was specified, create one automatically from the section
1503 // title and have it link to the new section. Otherwise, respect the summary as
1505 if ( $this->summary
=== '' ) {
1506 $cleanSectionTitle = $wgParser->stripSectionName( $this->sectiontitle
);
1507 return wfMessage( 'newsectionsummary' )
1508 ->rawParams( $cleanSectionTitle )->inContentLanguage()->text();
1510 } elseif ( $this->summary
!== '' ) {
1511 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $this->summary
);
1512 # This is a new section, so create a link to the new section
1513 # in the revision summary.
1514 $cleanSummary = $wgParser->stripSectionName( $this->summary
);
1515 return wfMessage( 'newsectionsummary' )
1516 ->rawParams( $cleanSummary )->inContentLanguage()->text();
1518 return $this->summary
;
1522 * Attempt submission (no UI)
1524 * @param array $result Array to add statuses to, currently with the
1526 * - spam (string): Spam string from content if any spam is detected by
1528 * - sectionanchor (string): Section anchor for a section save.
1529 * - nullEdit (boolean): Set if doEditContent is OK. True if null edit,
1531 * - redirect (bool): Set if doEditContent is OK. True if resulting
1532 * revision is a redirect.
1533 * @param bool $bot True if edit is being made under the bot right.
1535 * @return Status Status object, possibly with a message, but always with
1536 * one of the AS_* constants in $status->value,
1538 * @todo FIXME: This interface is TERRIBLE, but hard to get rid of due to
1539 * various error display idiosyncrasies. There are also lots of cases
1540 * where error metadata is set in the object and retrieved later instead
1541 * of being returned, e.g. AS_CONTENT_TOO_BIG and
1542 * AS_BLOCKED_PAGE_FOR_USER. All that stuff needs to be cleaned up some
1545 function internalAttemptSave( &$result, $bot = false ) {
1546 global $wgUser, $wgRequest, $wgParser, $wgMaxArticleSize;
1548 $status = Status
::newGood();
1550 if ( !Hooks
::run( 'EditPage::attemptSave', array( $this ) ) ) {
1551 wfDebug( "Hook 'EditPage::attemptSave' aborted article saving\n" );
1552 $status->fatal( 'hookaborted' );
1553 $status->value
= self
::AS_HOOK_ERROR
;
1557 $spam = $wgRequest->getText( 'wpAntispam' );
1558 if ( $spam !== '' ) {
1561 $wgUser->getName() .
1563 $this->mTitle
->getPrefixedText() .
1564 '" submitted bogus field "' .
1568 $status->fatal( 'spamprotectionmatch', false );
1569 $status->value
= self
::AS_SPAM_ERROR
;
1574 # Construct Content object
1575 $textbox_content = $this->toEditContent( $this->textbox1
);
1576 } catch ( MWContentSerializationException
$ex ) {
1578 'content-failed-to-parse',
1579 $this->contentModel
,
1580 $this->contentFormat
,
1583 $status->value
= self
::AS_PARSE_ERROR
;
1587 # Check image redirect
1588 if ( $this->mTitle
->getNamespace() == NS_FILE
&&
1589 $textbox_content->isRedirect() &&
1590 !$wgUser->isAllowed( 'upload' )
1592 $code = $wgUser->isAnon() ? self
::AS_IMAGE_REDIRECT_ANON
: self
::AS_IMAGE_REDIRECT_LOGGED
;
1593 $status->setResult( false, $code );
1599 $match = self
::matchSummarySpamRegex( $this->summary
);
1600 if ( $match === false && $this->section
== 'new' ) {
1601 # $wgSpamRegex is enforced on this new heading/summary because, unlike
1602 # regular summaries, it is added to the actual wikitext.
1603 if ( $this->sectiontitle
!== '' ) {
1604 # This branch is taken when the API is used with the 'sectiontitle' parameter.
1605 $match = self
::matchSpamRegex( $this->sectiontitle
);
1607 # This branch is taken when the "Add Topic" user interface is used, or the API
1608 # is used with the 'summary' parameter.
1609 $match = self
::matchSpamRegex( $this->summary
);
1612 if ( $match === false ) {
1613 $match = self
::matchSpamRegex( $this->textbox1
);
1615 if ( $match !== false ) {
1616 $result['spam'] = $match;
1617 $ip = $wgRequest->getIP();
1618 $pdbk = $this->mTitle
->getPrefixedDBkey();
1619 $match = str_replace( "\n", '', $match );
1620 wfDebugLog( 'SpamRegex', "$ip spam regex hit [[$pdbk]]: \"$match\"" );
1621 $status->fatal( 'spamprotectionmatch', $match );
1622 $status->value
= self
::AS_SPAM_ERROR
;
1627 array( $this, $this->textbox1
, $this->section
, &$this->hookError
, $this->summary
) )
1629 # Error messages etc. could be handled within the hook...
1630 $status->fatal( 'hookaborted' );
1631 $status->value
= self
::AS_HOOK_ERROR
;
1633 } elseif ( $this->hookError
!= '' ) {
1634 # ...or the hook could be expecting us to produce an error
1635 $status->fatal( 'hookaborted' );
1636 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1640 if ( $wgUser->isBlockedFrom( $this->mTitle
, false ) ) {
1641 // Auto-block user's IP if the account was "hard" blocked
1642 $wgUser->spreadAnyEditBlock();
1643 # Check block state against master, thus 'false'.
1644 $status->setResult( false, self
::AS_BLOCKED_PAGE_FOR_USER
);
1648 $this->kblength
= (int)( strlen( $this->textbox1
) / 1024 );
1649 if ( $this->kblength
> $wgMaxArticleSize ) {
1650 // Error will be displayed by showEditForm()
1651 $this->tooBig
= true;
1652 $status->setResult( false, self
::AS_CONTENT_TOO_BIG
);
1656 if ( !$wgUser->isAllowed( 'edit' ) ) {
1657 if ( $wgUser->isAnon() ) {
1658 $status->setResult( false, self
::AS_READ_ONLY_PAGE_ANON
);
1661 $status->fatal( 'readonlytext' );
1662 $status->value
= self
::AS_READ_ONLY_PAGE_LOGGED
;
1667 if ( $this->contentModel
!== $this->mTitle
->getContentModel()
1668 && !$wgUser->isAllowed( 'editcontentmodel' )
1670 $status->setResult( false, self
::AS_NO_CHANGE_CONTENT_MODEL
);
1674 if ( $this->changeTags
) {
1675 $changeTagsStatus = ChangeTags
::canAddTagsAccompanyingChange(
1676 $this->changeTags
, $wgUser );
1677 if ( !$changeTagsStatus->isOK() ) {
1678 $changeTagsStatus->value
= self
::AS_CHANGE_TAG_ERROR
;
1679 return $changeTagsStatus;
1683 if ( wfReadOnly() ) {
1684 $status->fatal( 'readonlytext' );
1685 $status->value
= self
::AS_READ_ONLY_PAGE
;
1688 if ( $wgUser->pingLimiter() ||
$wgUser->pingLimiter( 'linkpurge', 0 ) ) {
1689 $status->fatal( 'actionthrottledtext' );
1690 $status->value
= self
::AS_RATE_LIMITED
;
1694 # If the article has been deleted while editing, don't save it without
1696 if ( $this->wasDeletedSinceLastEdit() && !$this->recreate
) {
1697 $status->setResult( false, self
::AS_ARTICLE_WAS_DELETED
);
1701 # Load the page data from the master. If anything changes in the meantime,
1702 # we detect it by using page_latest like a token in a 1 try compare-and-swap.
1703 $this->mArticle
->loadPageData( 'fromdbmaster' );
1704 $new = !$this->mArticle
->exists();
1707 // Late check for create permission, just in case *PARANOIA*
1708 if ( !$this->mTitle
->userCan( 'create', $wgUser ) ) {
1709 $status->fatal( 'nocreatetext' );
1710 $status->value
= self
::AS_NO_CREATE_PERMISSION
;
1711 wfDebug( __METHOD__
. ": no create permission\n" );
1715 // Don't save a new page if it's blank or if it's a MediaWiki:
1716 // message with content equivalent to default (allow empty pages
1717 // in this case to disable messages, see bug 50124)
1718 $defaultMessageText = $this->mTitle
->getDefaultMessageText();
1719 if ( $this->mTitle
->getNamespace() === NS_MEDIAWIKI
&& $defaultMessageText !== false ) {
1720 $defaultText = $defaultMessageText;
1725 if ( !$this->allowBlankArticle
&& $this->textbox1
=== $defaultText ) {
1726 $this->blankArticle
= true;
1727 $status->fatal( 'blankarticle' );
1728 $status->setResult( false, self
::AS_BLANK_ARTICLE
);
1732 if ( !$this->runPostMergeFilters( $textbox_content, $status, $wgUser ) ) {
1736 $content = $textbox_content;
1738 $result['sectionanchor'] = '';
1739 if ( $this->section
== 'new' ) {
1740 if ( $this->sectiontitle
!== '' ) {
1741 // Insert the section title above the content.
1742 $content = $content->addSectionHeader( $this->sectiontitle
);
1743 } elseif ( $this->summary
!== '' ) {
1744 // Insert the section title above the content.
1745 $content = $content->addSectionHeader( $this->summary
);
1747 $this->summary
= $this->newSectionSummary( $result['sectionanchor'] );
1750 $status->value
= self
::AS_SUCCESS_NEW_ARTICLE
;
1754 # Article exists. Check for edit conflict.
1756 $this->mArticle
->clear(); # Force reload of dates, etc.
1757 $timestamp = $this->mArticle
->getTimestamp();
1759 wfDebug( "timestamp: {$timestamp}, edittime: {$this->edittime}\n" );
1761 if ( $timestamp != $this->edittime
) {
1762 $this->isConflict
= true;
1763 if ( $this->section
== 'new' ) {
1764 if ( $this->mArticle
->getUserText() == $wgUser->getName() &&
1765 $this->mArticle
->getComment() == $this->newSectionSummary()
1767 // Probably a duplicate submission of a new comment.
1768 // This can happen when squid resends a request after
1769 // a timeout but the first one actually went through.
1771 . ": duplicate new section submission; trigger edit conflict!\n" );
1773 // New comment; suppress conflict.
1774 $this->isConflict
= false;
1775 wfDebug( __METHOD__
. ": conflict suppressed; new section\n" );
1777 } elseif ( $this->section
== ''
1778 && Revision
::userWasLastToEdit(
1779 DB_MASTER
, $this->mTitle
->getArticleID(),
1780 $wgUser->getId(), $this->edittime
1783 # Suppress edit conflict with self, except for section edits where merging is required.
1784 wfDebug( __METHOD__
. ": Suppressing edit conflict, same user.\n" );
1785 $this->isConflict
= false;
1789 // If sectiontitle is set, use it, otherwise use the summary as the section title.
1790 if ( $this->sectiontitle
!== '' ) {
1791 $sectionTitle = $this->sectiontitle
;
1793 $sectionTitle = $this->summary
;
1798 if ( $this->isConflict
) {
1800 . ": conflict! getting section '{$this->section}' for time '{$this->edittime}'"
1801 . " (article time '{$timestamp}')\n" );
1803 $content = $this->mArticle
->replaceSectionContent(
1810 wfDebug( __METHOD__
. ": getting section '{$this->section}'\n" );
1811 $content = $this->mArticle
->replaceSectionContent(
1818 if ( is_null( $content ) ) {
1819 wfDebug( __METHOD__
. ": activating conflict; section replace failed.\n" );
1820 $this->isConflict
= true;
1821 $content = $textbox_content; // do not try to merge here!
1822 } elseif ( $this->isConflict
) {
1824 if ( $this->mergeChangesIntoContent( $content ) ) {
1825 // Successful merge! Maybe we should tell the user the good news?
1826 $this->isConflict
= false;
1827 wfDebug( __METHOD__
. ": Suppressing edit conflict, successful merge.\n" );
1829 $this->section
= '';
1830 $this->textbox1
= ContentHandler
::getContentText( $content );
1831 wfDebug( __METHOD__
. ": Keeping edit conflict, failed merge.\n" );
1835 if ( $this->isConflict
) {
1836 $status->setResult( false, self
::AS_CONFLICT_DETECTED
);
1840 if ( !$this->runPostMergeFilters( $content, $status, $wgUser ) ) {
1844 if ( $this->section
== 'new' ) {
1845 // Handle the user preference to force summaries here
1846 if ( !$this->allowBlankSummary
&& trim( $this->summary
) == '' ) {
1847 $this->missingSummary
= true;
1848 $status->fatal( 'missingsummary' ); // or 'missingcommentheader' if $section == 'new'. Blegh
1849 $status->value
= self
::AS_SUMMARY_NEEDED
;
1853 // Do not allow the user to post an empty comment
1854 if ( $this->textbox1
== '' ) {
1855 $this->missingComment
= true;
1856 $status->fatal( 'missingcommenttext' );
1857 $status->value
= self
::AS_TEXTBOX_EMPTY
;
1860 } elseif ( !$this->allowBlankSummary
1861 && !$content->equals( $this->getOriginalContent( $wgUser ) )
1862 && !$content->isRedirect()
1863 && md5( $this->summary
) == $this->autoSumm
1865 $this->missingSummary
= true;
1866 $status->fatal( 'missingsummary' );
1867 $status->value
= self
::AS_SUMMARY_NEEDED
;
1872 $sectionanchor = '';
1873 if ( $this->section
== 'new' ) {
1874 $this->summary
= $this->newSectionSummary( $sectionanchor );
1875 } elseif ( $this->section
!= '' ) {
1876 # Try to get a section anchor from the section source, redirect
1877 # to edited section if header found.
1878 # XXX: Might be better to integrate this into Article::replaceSection
1879 # for duplicate heading checking and maybe parsing.
1880 $hasmatch = preg_match( "/^ *([=]{1,6})(.*?)(\\1) *\\n/i", $this->textbox1
, $matches );
1881 # We can't deal with anchors, includes, html etc in the header for now,
1882 # headline would need to be parsed to improve this.
1883 if ( $hasmatch && strlen( $matches[2] ) > 0 ) {
1884 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $matches[2] );
1887 $result['sectionanchor'] = $sectionanchor;
1889 // Save errors may fall down to the edit form, but we've now
1890 // merged the section into full text. Clear the section field
1891 // so that later submission of conflict forms won't try to
1892 // replace that into a duplicated mess.
1893 $this->textbox1
= $this->toEditText( $content );
1894 $this->section
= '';
1896 $status->value
= self
::AS_SUCCESS_UPDATE
;
1899 if ( !$this->allowSelfRedirect
1900 && $content->isRedirect()
1901 && $content->getRedirectTarget()->equals( $this->getTitle() )
1903 // If the page already redirects to itself, don't warn.
1904 $currentTarget = $this->getCurrentContent()->getRedirectTarget();
1905 if ( !$currentTarget ||
!$currentTarget->equals( $this->getTitle() ) ) {
1906 $this->selfRedirect
= true;
1907 $status->fatal( 'selfredirect' );
1908 $status->value
= self
::AS_SELF_REDIRECT
;
1913 // Check for length errors again now that the section is merged in
1914 $this->kblength
= (int)( strlen( $this->toEditText( $content ) ) / 1024 );
1915 if ( $this->kblength
> $wgMaxArticleSize ) {
1916 $this->tooBig
= true;
1917 $status->setResult( false, self
::AS_MAX_ARTICLE_SIZE_EXCEEDED
);
1921 $flags = EDIT_DEFER_UPDATES | EDIT_AUTOSUMMARY |
1922 ( $new ? EDIT_NEW
: EDIT_UPDATE
) |
1923 ( ( $this->minoredit
&& !$this->isNew
) ? EDIT_MINOR
: 0 ) |
1924 ( $bot ? EDIT_FORCE_BOT
: 0 );
1926 $doEditStatus = $this->mArticle
->doEditContent(
1932 $content->getDefaultFormat()
1935 if ( !$doEditStatus->isOK() ) {
1936 // Failure from doEdit()
1937 // Show the edit conflict page for certain recognized errors from doEdit(),
1938 // but don't show it for errors from extension hooks
1939 $errors = $doEditStatus->getErrorsArray();
1940 if ( in_array( $errors[0][0],
1941 array( 'edit-gone-missing', 'edit-conflict', 'edit-already-exists' ) )
1943 $this->isConflict
= true;
1944 // Destroys data doEdit() put in $status->value but who cares
1945 $doEditStatus->value
= self
::AS_END
;
1947 return $doEditStatus;
1950 $result['nullEdit'] = $doEditStatus->hasMessage( 'edit-no-change' );
1951 if ( $result['nullEdit'] ) {
1952 // We don't know if it was a null edit until now, so increment here
1953 $wgUser->pingLimiter( 'linkpurge' );
1955 $result['redirect'] = $content->isRedirect();
1957 $this->updateWatchlist();
1959 if ( $this->changeTags
&& isset( $doEditStatus->value
['revision'] ) ) {
1960 // If a revision was created, apply any change tags that were requested
1961 $addTags = $this->changeTags
;
1962 $revId = $doEditStatus->value
['revision']->getId();
1963 // Defer this both for performance and so that addTags() sees the rc_id
1964 // since the recentchange entry addition is deferred first (bug T100248)
1965 DeferredUpdates
::addCallableUpdate( function() use ( $addTags, $revId ) {
1966 ChangeTags
::addTags( $addTags, null, $revId );
1974 * Register the change of watch status
1976 protected function updateWatchlist() {
1979 if ( $wgUser->isLoggedIn()
1980 && $this->watchthis
!= $wgUser->isWatched( $this->mTitle
, WatchedItem
::IGNORE_USER_RIGHTS
)
1982 $fname = __METHOD__
;
1983 $title = $this->mTitle
;
1984 $watch = $this->watchthis
;
1986 // Do this in its own transaction to reduce contention...
1987 $dbw = wfGetDB( DB_MASTER
);
1988 $dbw->onTransactionIdle( function () use ( $dbw, $title, $watch, $wgUser, $fname ) {
1989 WatchAction
::doWatchOrUnwatch( $watch, $title, $wgUser );
1995 * Attempts to do 3-way merge of edit content with a base revision
1996 * and current content, in case of edit conflict, in whichever way appropriate
1997 * for the content type.
2001 * @param Content $editContent
2005 private function mergeChangesIntoContent( &$editContent ) {
2007 $db = wfGetDB( DB_MASTER
);
2009 // This is the revision the editor started from
2010 $baseRevision = $this->getBaseRevision();
2011 $baseContent = $baseRevision ?
$baseRevision->getContent() : null;
2013 if ( is_null( $baseContent ) ) {
2017 // The current state, we want to merge updates into it
2018 $currentRevision = Revision
::loadFromTitle( $db, $this->mTitle
);
2019 $currentContent = $currentRevision ?
$currentRevision->getContent() : null;
2021 if ( is_null( $currentContent ) ) {
2025 $handler = ContentHandler
::getForModelID( $baseContent->getModel() );
2027 $result = $handler->merge3( $baseContent, $editContent, $currentContent );
2030 $editContent = $result;
2040 function getBaseRevision() {
2041 if ( !$this->mBaseRevision
) {
2042 $db = wfGetDB( DB_MASTER
);
2043 $this->mBaseRevision
= Revision
::loadFromTimestamp(
2044 $db, $this->mTitle
, $this->edittime
);
2046 return $this->mBaseRevision
;
2050 * Check given input text against $wgSpamRegex, and return the text of the first match.
2052 * @param string $text
2054 * @return string|bool Matching string or false
2056 public static function matchSpamRegex( $text ) {
2057 global $wgSpamRegex;
2058 // For back compatibility, $wgSpamRegex may be a single string or an array of regexes.
2059 $regexes = (array)$wgSpamRegex;
2060 return self
::matchSpamRegexInternal( $text, $regexes );
2064 * Check given input text against $wgSummarySpamRegex, and return the text of the first match.
2066 * @param string $text
2068 * @return string|bool Matching string or false
2070 public static function matchSummarySpamRegex( $text ) {
2071 global $wgSummarySpamRegex;
2072 $regexes = (array)$wgSummarySpamRegex;
2073 return self
::matchSpamRegexInternal( $text, $regexes );
2077 * @param string $text
2078 * @param array $regexes
2079 * @return bool|string
2081 protected static function matchSpamRegexInternal( $text, $regexes ) {
2082 foreach ( $regexes as $regex ) {
2084 if ( preg_match( $regex, $text, $matches ) ) {
2091 function setHeaders() {
2092 global $wgOut, $wgUser, $wgAjaxEditStash;
2094 $wgOut->addModules( 'mediawiki.action.edit' );
2095 $wgOut->addModuleStyles( 'mediawiki.action.edit.styles' );
2097 if ( $wgUser->getOption( 'showtoolbar' ) ) {
2098 // The addition of default buttons is handled by getEditToolbar() which
2099 // has its own dependency on this module. The call here ensures the module
2100 // is loaded in time (it has position "top") for other modules to register
2101 // buttons (e.g. extensions, gadgets, user scripts).
2102 $wgOut->addModules( 'mediawiki.toolbar' );
2105 if ( $wgUser->getOption( 'uselivepreview' ) ) {
2106 $wgOut->addModules( 'mediawiki.action.edit.preview' );
2109 if ( $wgUser->getOption( 'useeditwarning' ) ) {
2110 $wgOut->addModules( 'mediawiki.action.edit.editWarning' );
2113 if ( $wgAjaxEditStash ) {
2114 $wgOut->addModules( 'mediawiki.action.edit.stash' );
2117 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2119 # Enabled article-related sidebar, toplinks, etc.
2120 $wgOut->setArticleRelated( true );
2122 $contextTitle = $this->getContextTitle();
2123 if ( $this->isConflict
) {
2124 $msg = 'editconflict';
2125 } elseif ( $contextTitle->exists() && $this->section
!= '' ) {
2126 $msg = $this->section
== 'new' ?
'editingcomment' : 'editingsection';
2128 $msg = $contextTitle->exists()
2129 ||
( $contextTitle->getNamespace() == NS_MEDIAWIKI
2130 && $contextTitle->getDefaultMessageText() !== false
2136 # Use the title defined by DISPLAYTITLE magic word when present
2137 $displayTitle = isset( $this->mParserOutput
) ?
$this->mParserOutput
->getDisplayTitle() : false;
2138 if ( $displayTitle === false ) {
2139 $displayTitle = $contextTitle->getPrefixedText();
2141 $wgOut->setPageTitle( wfMessage( $msg, $displayTitle ) );
2142 # Transmit the name of the message to JavaScript for live preview
2143 # Keep Resources.php/mediawiki.action.edit.preview in sync with the possible keys
2144 $wgOut->addJsConfigVars( 'wgEditMessage', $msg );
2148 * Show all applicable editing introductions
2150 protected function showIntro() {
2151 global $wgOut, $wgUser;
2152 if ( $this->suppressIntro
) {
2156 $namespace = $this->mTitle
->getNamespace();
2158 if ( $namespace == NS_MEDIAWIKI
) {
2159 # Show a warning if editing an interface message
2160 $wgOut->wrapWikiMsg( "<div class='mw-editinginterface'>\n$1\n</div>", 'editinginterface' );
2161 # If this is a default message (but not css or js),
2162 # show a hint that it is translatable on translatewiki.net
2163 if ( !$this->mTitle
->hasContentModel( CONTENT_MODEL_CSS
)
2164 && !$this->mTitle
->hasContentModel( CONTENT_MODEL_JAVASCRIPT
)
2166 $defaultMessageText = $this->mTitle
->getDefaultMessageText();
2167 if ( $defaultMessageText !== false ) {
2168 $wgOut->wrapWikiMsg( "<div class='mw-translateinterface'>\n$1\n</div>",
2169 'translateinterface' );
2172 } elseif ( $namespace == NS_FILE
) {
2173 # Show a hint to shared repo
2174 $file = wfFindFile( $this->mTitle
);
2175 if ( $file && !$file->isLocal() ) {
2176 $descUrl = $file->getDescriptionUrl();
2177 # there must be a description url to show a hint to shared repo
2179 if ( !$this->mTitle
->exists() ) {
2180 $wgOut->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-create\">\n$1\n</div>", array(
2181 'sharedupload-desc-create', $file->getRepo()->getDisplayName(), $descUrl
2184 $wgOut->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-edit\">\n$1\n</div>", array(
2185 'sharedupload-desc-edit', $file->getRepo()->getDisplayName(), $descUrl
2192 # Show a warning message when someone creates/edits a user (talk) page but the user does not exist
2193 # Show log extract when the user is currently blocked
2194 if ( $namespace == NS_USER ||
$namespace == NS_USER_TALK
) {
2195 $parts = explode( '/', $this->mTitle
->getText(), 2 );
2196 $username = $parts[0];
2197 $user = User
::newFromName( $username, false /* allow IP users*/ );
2198 $ip = User
::isIP( $username );
2199 $block = Block
::newFromTarget( $user, $user );
2200 if ( !( $user && $user->isLoggedIn() ) && !$ip ) { # User does not exist
2201 $wgOut->wrapWikiMsg( "<div class=\"mw-userpage-userdoesnotexist error\">\n$1\n</div>",
2202 array( 'userpage-userdoesnotexist', wfEscapeWikiText( $username ) ) );
2203 } elseif ( !is_null( $block ) && $block->getType() != Block
::TYPE_AUTO
) {
2204 # Show log extract if the user is currently blocked
2205 LogEventsList
::showLogExtract(
2208 MWNamespace
::getCanonicalName( NS_USER
) . ':' . $block->getTarget(),
2212 'showIfEmpty' => false,
2214 'blocked-notice-logextract',
2215 $user->getName() # Support GENDER in notice
2221 # Try to add a custom edit intro, or use the standard one if this is not possible.
2222 if ( !$this->showCustomIntro() && !$this->mTitle
->exists() ) {
2223 $helpLink = wfExpandUrl( Skin
::makeInternalOrExternalUrl(
2224 wfMessage( 'helppage' )->inContentLanguage()->text()
2226 if ( $wgUser->isLoggedIn() ) {
2227 $wgOut->wrapWikiMsg(
2228 // Suppress the external link icon, consider the help url an internal one
2229 "<div class=\"mw-newarticletext plainlinks\">\n$1\n</div>",
2236 $wgOut->wrapWikiMsg(
2237 // Suppress the external link icon, consider the help url an internal one
2238 "<div class=\"mw-newarticletextanon plainlinks\">\n$1\n</div>",
2240 'newarticletextanon',
2246 # Give a notice if the user is editing a deleted/moved page...
2247 if ( !$this->mTitle
->exists() ) {
2248 LogEventsList
::showLogExtract( $wgOut, array( 'delete', 'move' ), $this->mTitle
,
2252 'conds' => array( "log_action != 'revision'" ),
2253 'showIfEmpty' => false,
2254 'msgKey' => array( 'recreate-moveddeleted-warn' )
2261 * Attempt to show a custom editing introduction, if supplied
2265 protected function showCustomIntro() {
2266 if ( $this->editintro
) {
2267 $title = Title
::newFromText( $this->editintro
);
2268 if ( $title instanceof Title
&& $title->exists() && $title->userCan( 'read' ) ) {
2270 // Added using template syntax, to take <noinclude>'s into account.
2271 $wgOut->addWikiTextTitleTidy(
2272 '<div class="mw-editintro">{{:' . $title->getFullText() . '}}</div>',
2282 * Gets an editable textual representation of $content.
2283 * The textual representation can be turned by into a Content object by the
2284 * toEditContent() method.
2286 * If $content is null or false or a string, $content is returned unchanged.
2288 * If the given Content object is not of a type that can be edited using
2289 * the text base EditPage, an exception will be raised. Set
2290 * $this->allowNonTextContent to true to allow editing of non-textual
2293 * @param Content|null|bool|string $content
2294 * @return string The editable text form of the content.
2296 * @throws MWException If $content is not an instance of TextContent and
2297 * $this->allowNonTextContent is not true.
2299 protected function toEditText( $content ) {
2300 if ( $content === null ||
$content === false ||
is_string( $content ) ) {
2304 if ( !$this->isSupportedContentModel( $content->getModel() ) ) {
2305 throw new MWException( 'This content model is not supported: '
2306 . ContentHandler
::getLocalizedName( $content->getModel() ) );
2309 return $content->serialize( $this->contentFormat
);
2313 * Turns the given text into a Content object by unserializing it.
2315 * If the resulting Content object is not of a type that can be edited using
2316 * the text base EditPage, an exception will be raised. Set
2317 * $this->allowNonTextContent to true to allow editing of non-textual
2320 * @param string|null|bool $text Text to unserialize
2321 * @return Content The content object created from $text. If $text was false
2322 * or null, false resp. null will be returned instead.
2324 * @throws MWException If unserializing the text results in a Content
2325 * object that is not an instance of TextContent and
2326 * $this->allowNonTextContent is not true.
2328 protected function toEditContent( $text ) {
2329 if ( $text === false ||
$text === null ) {
2333 $content = ContentHandler
::makeContent( $text, $this->getTitle(),
2334 $this->contentModel
, $this->contentFormat
);
2336 if ( !$this->isSupportedContentModel( $content->getModel() ) ) {
2337 throw new MWException( 'This content model is not supported: '
2338 . ContentHandler
::getLocalizedName( $content->getModel() ) );
2345 * Send the edit form and related headers to $wgOut
2346 * @param callable|null $formCallback That takes an OutputPage parameter; will be called
2347 * during form output near the top, for captchas and the like.
2349 * The $formCallback parameter is deprecated since MediaWiki 1.25. Please
2350 * use the EditPage::showEditForm:fields hook instead.
2352 function showEditForm( $formCallback = null ) {
2353 global $wgOut, $wgUser;
2355 # need to parse the preview early so that we know which templates are used,
2356 # otherwise users with "show preview after edit box" will get a blank list
2357 # we parse this near the beginning so that setHeaders can do the title
2358 # setting work instead of leaving it in getPreviewText
2359 $previewOutput = '';
2360 if ( $this->formtype
== 'preview' ) {
2361 $previewOutput = $this->getPreviewText();
2364 Hooks
::run( 'EditPage::showEditForm:initial', array( &$this, &$wgOut ) );
2366 $this->setHeaders();
2368 if ( $this->showHeader() === false ) {
2372 $wgOut->addHTML( $this->editFormPageTop
);
2374 if ( $wgUser->getOption( 'previewontop' ) ) {
2375 $this->displayPreviewArea( $previewOutput, true );
2378 $wgOut->addHTML( $this->editFormTextTop
);
2380 $showToolbar = true;
2381 if ( $this->wasDeletedSinceLastEdit() ) {
2382 if ( $this->formtype
== 'save' ) {
2383 // Hide the toolbar and edit area, user can click preview to get it back
2384 // Add an confirmation checkbox and explanation.
2385 $showToolbar = false;
2387 $wgOut->wrapWikiMsg( "<div class='error mw-deleted-while-editing'>\n$1\n</div>",
2388 'deletedwhileediting' );
2392 // @todo add EditForm plugin interface and use it here!
2393 // search for textarea1 and textares2, and allow EditForm to override all uses.
2394 $wgOut->addHTML( Html
::openElement(
2397 'id' => self
::EDITFORM_ID
,
2398 'name' => self
::EDITFORM_ID
,
2400 'action' => $this->getActionURL( $this->getContextTitle() ),
2401 'enctype' => 'multipart/form-data'
2405 if ( is_callable( $formCallback ) ) {
2406 wfWarn( 'The $formCallback parameter to ' . __METHOD__
. 'is deprecated' );
2407 call_user_func_array( $formCallback, array( &$wgOut ) );
2410 // Add an empty field to trip up spambots
2412 Xml
::openElement( 'div', array( 'id' => 'antispam-container', 'style' => 'display: none;' ) )
2415 array( 'for' => 'wpAntiSpam' ),
2416 wfMessage( 'simpleantispam-label' )->parse()
2422 'name' => 'wpAntispam',
2423 'id' => 'wpAntispam',
2427 . Xml
::closeElement( 'div' )
2430 Hooks
::run( 'EditPage::showEditForm:fields', array( &$this, &$wgOut ) );
2432 // Put these up at the top to ensure they aren't lost on early form submission
2433 $this->showFormBeforeText();
2435 if ( $this->wasDeletedSinceLastEdit() && 'save' == $this->formtype
) {
2436 $username = $this->lastDelete
->user_name
;
2437 $comment = $this->lastDelete
->log_comment
;
2439 // It is better to not parse the comment at all than to have templates expanded in the middle
2440 // TODO: can the checkLabel be moved outside of the div so that wrapWikiMsg could be used?
2441 $key = $comment === ''
2442 ?
'confirmrecreate-noreason'
2443 : 'confirmrecreate';
2445 '<div class="mw-confirm-recreate">' .
2446 wfMessage( $key, $username, "<nowiki>$comment</nowiki>" )->parse() .
2447 Xml
::checkLabel( wfMessage( 'recreate' )->text(), 'wpRecreate', 'wpRecreate', false,
2448 array( 'title' => Linker
::titleAttrib( 'recreate' ), 'tabindex' => 1, 'id' => 'wpRecreate' )
2454 # When the summary is hidden, also hide them on preview/show changes
2455 if ( $this->nosummary
) {
2456 $wgOut->addHTML( Html
::hidden( 'nosummary', true ) );
2459 # If a blank edit summary was previously provided, and the appropriate
2460 # user preference is active, pass a hidden tag as wpIgnoreBlankSummary. This will stop the
2461 # user being bounced back more than once in the event that a summary
2464 # For a bit more sophisticated detection of blank summaries, hash the
2465 # automatic one and pass that in the hidden field wpAutoSummary.
2466 if ( $this->missingSummary ||
( $this->section
== 'new' && $this->nosummary
) ) {
2467 $wgOut->addHTML( Html
::hidden( 'wpIgnoreBlankSummary', true ) );
2470 if ( $this->undidRev
) {
2471 $wgOut->addHTML( Html
::hidden( 'wpUndidRevision', $this->undidRev
) );
2474 if ( $this->selfRedirect
) {
2475 $wgOut->addHTML( Html
::hidden( 'wpIgnoreSelfRedirect', true ) );
2478 if ( $this->hasPresetSummary
) {
2479 // If a summary has been preset using &summary= we don't want to prompt for
2480 // a different summary. Only prompt for a summary if the summary is blanked.
2482 $this->autoSumm
= md5( '' );
2485 $autosumm = $this->autoSumm ?
$this->autoSumm
: md5( $this->summary
);
2486 $wgOut->addHTML( Html
::hidden( 'wpAutoSummary', $autosumm ) );
2488 $wgOut->addHTML( Html
::hidden( 'oldid', $this->oldid
) );
2489 $wgOut->addHTML( Html
::hidden( 'parentRevId',
2490 $this->parentRevId ?
: $this->mArticle
->getRevIdFetched() ) );
2492 $wgOut->addHTML( Html
::hidden( 'format', $this->contentFormat
) );
2493 $wgOut->addHTML( Html
::hidden( 'model', $this->contentModel
) );
2495 if ( $this->section
== 'new' ) {
2496 $this->showSummaryInput( true, $this->summary
);
2497 $wgOut->addHTML( $this->getSummaryPreview( true, $this->summary
) );
2500 $wgOut->addHTML( $this->editFormTextBeforeContent
);
2502 if ( !$this->isCssJsSubpage
&& $showToolbar && $wgUser->getOption( 'showtoolbar' ) ) {
2503 $wgOut->addHTML( EditPage
::getEditToolbar() );
2506 if ( $this->blankArticle
) {
2507 $wgOut->addHTML( Html
::hidden( 'wpIgnoreBlankArticle', true ) );
2510 if ( $this->isConflict
) {
2511 // In an edit conflict bypass the overridable content form method
2512 // and fallback to the raw wpTextbox1 since editconflicts can't be
2513 // resolved between page source edits and custom ui edits using the
2515 $this->textbox2
= $this->textbox1
;
2517 $content = $this->getCurrentContent();
2518 $this->textbox1
= $this->toEditText( $content );
2520 $this->showTextbox1();
2522 $this->showContentForm();
2525 $wgOut->addHTML( $this->editFormTextAfterContent
);
2527 $this->showStandardInputs();
2529 $this->showFormAfterText();
2531 $this->showTosSummary();
2533 $this->showEditTools();
2535 $wgOut->addHTML( $this->editFormTextAfterTools
. "\n" );
2537 $wgOut->addHTML( Html
::rawElement( 'div', array( 'class' => 'templatesUsed' ),
2538 Linker
::formatTemplates( $this->getTemplates(), $this->preview
, $this->section
!= '' ) ) );
2540 $wgOut->addHTML( Html
::rawElement( 'div', array( 'class' => 'hiddencats' ),
2541 Linker
::formatHiddenCategories( $this->mArticle
->getHiddenCategories() ) ) );
2543 $wgOut->addHTML( Html
::rawElement( 'div', array( 'class' => 'limitreport' ),
2544 self
::getPreviewLimitReport( $this->mParserOutput
) ) );
2546 $wgOut->addModules( 'mediawiki.action.edit.collapsibleFooter' );
2548 if ( $this->isConflict
) {
2550 $this->showConflict();
2551 } catch ( MWContentSerializationException
$ex ) {
2552 // this can't really happen, but be nice if it does.
2554 'content-failed-to-parse',
2555 $this->contentModel
,
2556 $this->contentFormat
,
2559 $wgOut->addWikiText( '<div class="error">' . $msg->text() . '</div>' );
2563 // Marker for detecting truncated form data. This must be the last
2564 // parameter sent in order to be of use, so do not move me.
2565 $wgOut->addHTML( Html
::hidden( 'wpUltimateParam', true ) );
2566 $wgOut->addHTML( $this->editFormTextBottom
. "\n</form>\n" );
2568 if ( !$wgUser->getOption( 'previewontop' ) ) {
2569 $this->displayPreviewArea( $previewOutput, false );
2575 * Extract the section title from current section text, if any.
2577 * @param string $text
2578 * @return string|bool String or false
2580 public static function extractSectionTitle( $text ) {
2581 preg_match( "/^(=+)(.+)\\1\\s*(\n|$)/i", $text, $matches );
2582 if ( !empty( $matches[2] ) ) {
2584 return $wgParser->stripSectionName( trim( $matches[2] ) );
2593 protected function showHeader() {
2594 global $wgOut, $wgUser, $wgMaxArticleSize, $wgLang;
2595 global $wgAllowUserCss, $wgAllowUserJs;
2597 if ( $this->mTitle
->isTalkPage() ) {
2598 $wgOut->addWikiMsg( 'talkpagetext' );
2602 $editNotices = $this->mTitle
->getEditNotices( $this->oldid
);
2603 if ( count( $editNotices ) ) {
2604 $wgOut->addHTML( implode( "\n", $editNotices ) );
2606 $msg = wfMessage( 'editnotice-notext' );
2607 if ( !$msg->isDisabled() ) {
2609 '<div class="mw-editnotice-notext">'
2610 . $msg->parseAsBlock()
2616 if ( $this->isConflict
) {
2617 $wgOut->wrapWikiMsg( "<div class='mw-explainconflict'>\n$1\n</div>", 'explainconflict' );
2618 $this->edittime
= $this->mArticle
->getTimestamp();
2620 if ( $this->section
!= '' && !$this->isSectionEditSupported() ) {
2621 // We use $this->section to much before this and getVal('wgSection') directly in other places
2622 // at this point we can't reset $this->section to '' to fallback to non-section editing.
2623 // Someone is welcome to try refactoring though
2624 $wgOut->showErrorPage( 'sectioneditnotsupported-title', 'sectioneditnotsupported-text' );
2628 if ( $this->section
!= '' && $this->section
!= 'new' ) {
2629 if ( !$this->summary
&& !$this->preview
&& !$this->diff
) {
2630 $sectionTitle = self
::extractSectionTitle( $this->textbox1
); //FIXME: use Content object
2631 if ( $sectionTitle !== false ) {
2632 $this->summary
= "/* $sectionTitle */ ";
2637 if ( $this->missingComment
) {
2638 $wgOut->wrapWikiMsg( "<div id='mw-missingcommenttext'>\n$1\n</div>", 'missingcommenttext' );
2641 if ( $this->missingSummary
&& $this->section
!= 'new' ) {
2642 $wgOut->wrapWikiMsg( "<div id='mw-missingsummary'>\n$1\n</div>", 'missingsummary' );
2645 if ( $this->missingSummary
&& $this->section
== 'new' ) {
2646 $wgOut->wrapWikiMsg( "<div id='mw-missingcommentheader'>\n$1\n</div>", 'missingcommentheader' );
2649 if ( $this->blankArticle
) {
2650 $wgOut->wrapWikiMsg( "<div id='mw-blankarticle'>\n$1\n</div>", 'blankarticle' );
2653 if ( $this->selfRedirect
) {
2654 $wgOut->wrapWikiMsg( "<div id='mw-selfredirect'>\n$1\n</div>", 'selfredirect' );
2657 if ( $this->hookError
!== '' ) {
2658 $wgOut->addWikiText( $this->hookError
);
2661 if ( !$this->checkUnicodeCompliantBrowser() ) {
2662 $wgOut->addWikiMsg( 'nonunicodebrowser' );
2665 if ( $this->section
!= 'new' ) {
2666 $revision = $this->mArticle
->getRevisionFetched();
2668 // Let sysop know that this will make private content public if saved
2670 if ( !$revision->userCan( Revision
::DELETED_TEXT
, $wgUser ) ) {
2671 $wgOut->wrapWikiMsg(
2672 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
2673 'rev-deleted-text-permission'
2675 } elseif ( $revision->isDeleted( Revision
::DELETED_TEXT
) ) {
2676 $wgOut->wrapWikiMsg(
2677 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
2678 'rev-deleted-text-view'
2682 if ( !$revision->isCurrent() ) {
2683 $this->mArticle
->setOldSubtitle( $revision->getId() );
2684 $wgOut->addWikiMsg( 'editingold' );
2686 } elseif ( $this->mTitle
->exists() ) {
2687 // Something went wrong
2689 $wgOut->wrapWikiMsg( "<div class='errorbox'>\n$1\n</div>\n",
2690 array( 'missing-revision', $this->oldid
) );
2695 if ( wfReadOnly() ) {
2696 $wgOut->wrapWikiMsg(
2697 "<div id=\"mw-read-only-warning\">\n$1\n</div>",
2698 array( 'readonlywarning', wfReadOnlyReason() )
2700 } elseif ( $wgUser->isAnon() ) {
2701 if ( $this->formtype
!= 'preview' ) {
2702 $wgOut->wrapWikiMsg(
2703 "<div id='mw-anon-edit-warning'>\n$1\n</div>",
2704 array( 'anoneditwarning',
2706 '{{fullurl:Special:UserLogin|returnto={{FULLPAGENAMEE}}}}',
2708 '{{fullurl:Special:UserLogin/signup|returnto={{FULLPAGENAMEE}}}}' )
2711 $wgOut->wrapWikiMsg( "<div id=\"mw-anon-preview-warning\">\n$1</div>",
2712 'anonpreviewwarning'
2716 if ( $this->isCssJsSubpage
) {
2717 # Check the skin exists
2718 if ( $this->isWrongCaseCssJsPage
) {
2719 $wgOut->wrapWikiMsg(
2720 "<div class='error' id='mw-userinvalidcssjstitle'>\n$1\n</div>",
2721 array( 'userinvalidcssjstitle', $this->mTitle
->getSkinFromCssJsSubpage() )
2724 if ( $this->getTitle()->isSubpageOf( $wgUser->getUserPage() ) ) {
2725 if ( $this->formtype
!== 'preview' ) {
2726 if ( $this->isCssSubpage
&& $wgAllowUserCss ) {
2727 $wgOut->wrapWikiMsg(
2728 "<div id='mw-usercssyoucanpreview'>\n$1\n</div>",
2729 array( 'usercssyoucanpreview' )
2733 if ( $this->isJsSubpage
&& $wgAllowUserJs ) {
2734 $wgOut->wrapWikiMsg(
2735 "<div id='mw-userjsyoucanpreview'>\n$1\n</div>",
2736 array( 'userjsyoucanpreview' )
2744 if ( $this->mTitle
->isProtected( 'edit' ) &&
2745 MWNamespace
::getRestrictionLevels( $this->mTitle
->getNamespace() ) !== array( '' )
2747 # Is the title semi-protected?
2748 if ( $this->mTitle
->isSemiProtected() ) {
2749 $noticeMsg = 'semiprotectedpagewarning';
2751 # Then it must be protected based on static groups (regular)
2752 $noticeMsg = 'protectedpagewarning';
2754 LogEventsList
::showLogExtract( $wgOut, 'protect', $this->mTitle
, '',
2755 array( 'lim' => 1, 'msgKey' => array( $noticeMsg ) ) );
2757 if ( $this->mTitle
->isCascadeProtected() ) {
2758 # Is this page under cascading protection from some source pages?
2759 list( $cascadeSources, /* $restrictions */ ) = $this->mTitle
->getCascadeProtectionSources();
2760 $notice = "<div class='mw-cascadeprotectedwarning'>\n$1\n";
2761 $cascadeSourcesCount = count( $cascadeSources );
2762 if ( $cascadeSourcesCount > 0 ) {
2763 # Explain, and list the titles responsible
2764 foreach ( $cascadeSources as $page ) {
2765 $notice .= '* [[:' . $page->getPrefixedText() . "]]\n";
2768 $notice .= '</div>';
2769 $wgOut->wrapWikiMsg( $notice, array( 'cascadeprotectedwarning', $cascadeSourcesCount ) );
2771 if ( !$this->mTitle
->exists() && $this->mTitle
->getRestrictions( 'create' ) ) {
2772 LogEventsList
::showLogExtract( $wgOut, 'protect', $this->mTitle
, '',
2774 'showIfEmpty' => false,
2775 'msgKey' => array( 'titleprotectedwarning' ),
2776 'wrap' => "<div class=\"mw-titleprotectedwarning\">\n$1</div>" ) );
2779 if ( $this->kblength
=== false ) {
2780 $this->kblength
= (int)( strlen( $this->textbox1
) / 1024 );
2783 if ( $this->tooBig ||
$this->kblength
> $wgMaxArticleSize ) {
2784 $wgOut->wrapWikiMsg( "<div class='error' id='mw-edit-longpageerror'>\n$1\n</div>",
2787 $wgLang->formatNum( $this->kblength
),
2788 $wgLang->formatNum( $wgMaxArticleSize )
2792 if ( !wfMessage( 'longpage-hint' )->isDisabled() ) {
2793 $wgOut->wrapWikiMsg( "<div id='mw-edit-longpage-hint'>\n$1\n</div>",
2796 $wgLang->formatSize( strlen( $this->textbox1
) ),
2797 strlen( $this->textbox1
)
2802 # Add header copyright warning
2803 $this->showHeaderCopyrightWarning();
2809 * Standard summary input and label (wgSummary), abstracted so EditPage
2810 * subclasses may reorganize the form.
2811 * Note that you do not need to worry about the label's for=, it will be
2812 * inferred by the id given to the input. You can remove them both by
2813 * passing array( 'id' => false ) to $userInputAttrs.
2815 * @param string $summary The value of the summary input
2816 * @param string $labelText The html to place inside the label
2817 * @param array $inputAttrs Array of attrs to use on the input
2818 * @param array $spanLabelAttrs Array of attrs to use on the span inside the label
2820 * @return array An array in the format array( $label, $input )
2822 function getSummaryInput( $summary = "", $labelText = null,
2823 $inputAttrs = null, $spanLabelAttrs = null
2825 // Note: the maxlength is overridden in JS to 255 and to make it use UTF-8 bytes, not characters.
2826 $inputAttrs = ( is_array( $inputAttrs ) ?
$inputAttrs : array() ) +
array(
2827 'id' => 'wpSummary',
2828 'maxlength' => '200',
2831 'spellcheck' => 'true',
2832 ) + Linker
::tooltipAndAccesskeyAttribs( 'summary' );
2834 $spanLabelAttrs = ( is_array( $spanLabelAttrs ) ?
$spanLabelAttrs : array() ) +
array(
2835 'class' => $this->missingSummary ?
'mw-summarymissed' : 'mw-summary',
2836 'id' => "wpSummaryLabel"
2843 $inputAttrs['id'] ?
array( 'for' => $inputAttrs['id'] ) : null,
2846 $label = Xml
::tags( 'span', $spanLabelAttrs, $label );
2849 $input = Html
::input( 'wpSummary', $summary, 'text', $inputAttrs );
2851 return array( $label, $input );
2855 * @param bool $isSubjectPreview True if this is the section subject/title
2856 * up top, or false if this is the comment summary
2857 * down below the textarea
2858 * @param string $summary The text of the summary to display
2860 protected function showSummaryInput( $isSubjectPreview, $summary = "" ) {
2861 global $wgOut, $wgContLang;
2862 # Add a class if 'missingsummary' is triggered to allow styling of the summary line
2863 $summaryClass = $this->missingSummary ?
'mw-summarymissed' : 'mw-summary';
2864 if ( $isSubjectPreview ) {
2865 if ( $this->nosummary
) {
2869 if ( !$this->mShowSummaryField
) {
2873 $summary = $wgContLang->recodeForEdit( $summary );
2874 $labelText = wfMessage( $isSubjectPreview ?
'subject' : 'summary' )->parse();
2875 list( $label, $input ) = $this->getSummaryInput(
2878 array( 'class' => $summaryClass ),
2881 $wgOut->addHTML( "{$label} {$input}" );
2885 * @param bool $isSubjectPreview True if this is the section subject/title
2886 * up top, or false if this is the comment summary
2887 * down below the textarea
2888 * @param string $summary The text of the summary to display
2891 protected function getSummaryPreview( $isSubjectPreview, $summary = "" ) {
2892 // avoid spaces in preview, gets always trimmed on save
2893 $summary = trim( $summary );
2894 if ( !$summary ||
( !$this->preview
&& !$this->diff
) ) {
2900 if ( $isSubjectPreview ) {
2901 $summary = wfMessage( 'newsectionsummary' )->rawParams( $wgParser->stripSectionName( $summary ) )
2902 ->inContentLanguage()->text();
2905 $message = $isSubjectPreview ?
'subject-preview' : 'summary-preview';
2907 $summary = wfMessage( $message )->parse()
2908 . Linker
::commentBlock( $summary, $this->mTitle
, $isSubjectPreview );
2909 return Xml
::tags( 'div', array( 'class' => 'mw-summary-preview' ), $summary );
2912 protected function showFormBeforeText() {
2914 $section = htmlspecialchars( $this->section
);
2915 $wgOut->addHTML( <<<HTML
2916 <input type='hidden' value="{$section}" name="wpSection"/>
2917 <input type='hidden' value="{$this->starttime}" name="wpStarttime" />
2918 <input type='hidden' value="{$this->edittime}" name="wpEdittime" />
2919 <input type='hidden' value="{$this->scrolltop}" name="wpScrolltop" id="wpScrolltop" />
2923 if ( !$this->checkUnicodeCompliantBrowser() ) {
2924 $wgOut->addHTML( Html
::hidden( 'safemode', '1' ) );
2928 protected function showFormAfterText() {
2929 global $wgOut, $wgUser;
2931 * To make it harder for someone to slip a user a page
2932 * which submits an edit form to the wiki without their
2933 * knowledge, a random token is associated with the login
2934 * session. If it's not passed back with the submission,
2935 * we won't save the page, or render user JavaScript and
2938 * For anon editors, who may not have a session, we just
2939 * include the constant suffix to prevent editing from
2940 * broken text-mangling proxies.
2942 $wgOut->addHTML( "\n" . Html
::hidden( "wpEditToken", $wgUser->getEditToken() ) . "\n" );
2946 * Subpage overridable method for printing the form for page content editing
2947 * By default this simply outputs wpTextbox1
2948 * Subclasses can override this to provide a custom UI for editing;
2949 * be it a form, or simply wpTextbox1 with a modified content that will be
2950 * reverse modified when extracted from the post data.
2951 * Note that this is basically the inverse for importContentFormData
2953 protected function showContentForm() {
2954 $this->showTextbox1();
2958 * Method to output wpTextbox1
2959 * The $textoverride method can be used by subclasses overriding showContentForm
2960 * to pass back to this method.
2962 * @param array $customAttribs Array of html attributes to use in the textarea
2963 * @param string $textoverride Optional text to override $this->textarea1 with
2965 protected function showTextbox1( $customAttribs = null, $textoverride = null ) {
2966 if ( $this->wasDeletedSinceLastEdit() && $this->formtype
== 'save' ) {
2967 $attribs = array( 'style' => 'display:none;' );
2969 $classes = array(); // Textarea CSS
2970 if ( $this->mTitle
->isProtected( 'edit' ) &&
2971 MWNamespace
::getRestrictionLevels( $this->mTitle
->getNamespace() ) !== array( '' )
2973 # Is the title semi-protected?
2974 if ( $this->mTitle
->isSemiProtected() ) {
2975 $classes[] = 'mw-textarea-sprotected';
2977 # Then it must be protected based on static groups (regular)
2978 $classes[] = 'mw-textarea-protected';
2980 # Is the title cascade-protected?
2981 if ( $this->mTitle
->isCascadeProtected() ) {
2982 $classes[] = 'mw-textarea-cprotected';
2986 $attribs = array( 'tabindex' => 1 );
2988 if ( is_array( $customAttribs ) ) {
2989 $attribs +
= $customAttribs;
2992 if ( count( $classes ) ) {
2993 if ( isset( $attribs['class'] ) ) {
2994 $classes[] = $attribs['class'];
2996 $attribs['class'] = implode( ' ', $classes );
3001 $textoverride !== null ?
$textoverride : $this->textbox1
,
3007 protected function showTextbox2() {
3008 $this->showTextbox( $this->textbox2
, 'wpTextbox2', array( 'tabindex' => 6, 'readonly' ) );
3011 protected function showTextbox( $text, $name, $customAttribs = array() ) {
3012 global $wgOut, $wgUser;
3014 $wikitext = $this->safeUnicodeOutput( $text );
3015 if ( strval( $wikitext ) !== '' ) {
3016 // Ensure there's a newline at the end, otherwise adding lines
3018 // But don't add a newline if the ext is empty, or Firefox in XHTML
3019 // mode will show an extra newline. A bit annoying.
3023 $attribs = $customAttribs +
array(
3026 'cols' => $wgUser->getIntOption( 'cols' ),
3027 'rows' => $wgUser->getIntOption( 'rows' ),
3028 // Avoid PHP notices when appending preferences
3029 // (appending allows customAttribs['style'] to still work).
3033 $pageLang = $this->mTitle
->getPageLanguage();
3034 $attribs['lang'] = $pageLang->getHtmlCode();
3035 $attribs['dir'] = $pageLang->getDir();
3037 $wgOut->addHTML( Html
::textarea( $name, $wikitext, $attribs ) );
3040 protected function displayPreviewArea( $previewOutput, $isOnTop = false ) {
3044 $classes[] = 'ontop';
3047 $attribs = array( 'id' => 'wikiPreview', 'class' => implode( ' ', $classes ) );
3049 if ( $this->formtype
!= 'preview' ) {
3050 $attribs['style'] = 'display: none;';
3053 $wgOut->addHTML( Xml
::openElement( 'div', $attribs ) );
3055 if ( $this->formtype
== 'preview' ) {
3056 $this->showPreview( $previewOutput );
3058 // Empty content container for LivePreview
3059 $pageViewLang = $this->mTitle
->getPageViewLanguage();
3060 $attribs = array( 'lang' => $pageViewLang->getHtmlCode(), 'dir' => $pageViewLang->getDir(),
3061 'class' => 'mw-content-' . $pageViewLang->getDir() );
3062 $wgOut->addHTML( Html
::rawElement( 'div', $attribs ) );
3065 $wgOut->addHTML( '</div>' );
3067 if ( $this->formtype
== 'diff' ) {
3070 } catch ( MWContentSerializationException
$ex ) {
3072 'content-failed-to-parse',
3073 $this->contentModel
,
3074 $this->contentFormat
,
3077 $wgOut->addWikiText( '<div class="error">' . $msg->text() . '</div>' );
3083 * Append preview output to $wgOut.
3084 * Includes category rendering if this is a category page.
3086 * @param string $text The HTML to be output for the preview.
3088 protected function showPreview( $text ) {
3090 if ( $this->mTitle
->getNamespace() == NS_CATEGORY
) {
3091 $this->mArticle
->openShowCategory();
3093 # This hook seems slightly odd here, but makes things more
3094 # consistent for extensions.
3095 Hooks
::run( 'OutputPageBeforeHTML', array( &$wgOut, &$text ) );
3096 $wgOut->addHTML( $text );
3097 if ( $this->mTitle
->getNamespace() == NS_CATEGORY
) {
3098 $this->mArticle
->closeShowCategory();
3103 * Get a diff between the current contents of the edit box and the
3104 * version of the page we're editing from.
3106 * If this is a section edit, we'll replace the section as for final
3107 * save and then make a comparison.
3109 function showDiff() {
3110 global $wgUser, $wgContLang, $wgOut;
3112 $oldtitlemsg = 'currentrev';
3113 # if message does not exist, show diff against the preloaded default
3114 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
&& !$this->mTitle
->exists() ) {
3115 $oldtext = $this->mTitle
->getDefaultMessageText();
3116 if ( $oldtext !== false ) {
3117 $oldtitlemsg = 'defaultmessagetext';
3118 $oldContent = $this->toEditContent( $oldtext );
3123 $oldContent = $this->getCurrentContent();
3126 $textboxContent = $this->toEditContent( $this->textbox1
);
3128 $newContent = $this->mArticle
->replaceSectionContent(
3129 $this->section
, $textboxContent,
3130 $this->summary
, $this->edittime
);
3132 if ( $newContent ) {
3133 ContentHandler
::runLegacyHooks( 'EditPageGetDiffText', array( $this, &$newContent ) );
3134 Hooks
::run( 'EditPageGetDiffContent', array( $this, &$newContent ) );
3136 $popts = ParserOptions
::newFromUserAndLang( $wgUser, $wgContLang );
3137 $newContent = $newContent->preSaveTransform( $this->mTitle
, $wgUser, $popts );
3140 if ( ( $oldContent && !$oldContent->isEmpty() ) ||
( $newContent && !$newContent->isEmpty() ) ) {
3141 $oldtitle = wfMessage( $oldtitlemsg )->parse();
3142 $newtitle = wfMessage( 'yourtext' )->parse();
3144 if ( !$oldContent ) {
3145 $oldContent = $newContent->getContentHandler()->makeEmptyContent();
3148 if ( !$newContent ) {
3149 $newContent = $oldContent->getContentHandler()->makeEmptyContent();
3152 $de = $oldContent->getContentHandler()->createDifferenceEngine( $this->mArticle
->getContext() );
3153 $de->setContent( $oldContent, $newContent );
3155 $difftext = $de->getDiff( $oldtitle, $newtitle );
3156 $de->showDiffStyle();
3161 $wgOut->addHTML( '<div id="wikiDiff">' . $difftext . '</div>' );
3165 * Show the header copyright warning.
3167 protected function showHeaderCopyrightWarning() {
3168 $msg = 'editpage-head-copy-warn';
3169 if ( !wfMessage( $msg )->isDisabled() ) {
3171 $wgOut->wrapWikiMsg( "<div class='editpage-head-copywarn'>\n$1\n</div>",
3172 'editpage-head-copy-warn' );
3177 * Give a chance for site and per-namespace customizations of
3178 * terms of service summary link that might exist separately
3179 * from the copyright notice.
3181 * This will display between the save button and the edit tools,
3182 * so should remain short!
3184 protected function showTosSummary() {
3185 $msg = 'editpage-tos-summary';
3186 Hooks
::run( 'EditPageTosSummary', array( $this->mTitle
, &$msg ) );
3187 if ( !wfMessage( $msg )->isDisabled() ) {
3189 $wgOut->addHTML( '<div class="mw-tos-summary">' );
3190 $wgOut->addWikiMsg( $msg );
3191 $wgOut->addHTML( '</div>' );
3195 protected function showEditTools() {
3197 $wgOut->addHTML( '<div class="mw-editTools">' .
3198 wfMessage( 'edittools' )->inContentLanguage()->parse() .
3203 * Get the copyright warning
3205 * Renamed to getCopyrightWarning(), old name kept around for backwards compatibility
3208 protected function getCopywarn() {
3209 return self
::getCopyrightWarning( $this->mTitle
);
3213 * Get the copyright warning, by default returns wikitext
3215 * @param Title $title
3216 * @param string $format Output format, valid values are any function of a Message object
3219 public static function getCopyrightWarning( $title, $format = 'plain' ) {
3220 global $wgRightsText;
3221 if ( $wgRightsText ) {
3222 $copywarnMsg = array( 'copyrightwarning',
3223 '[[' . wfMessage( 'copyrightpage' )->inContentLanguage()->text() . ']]',
3226 $copywarnMsg = array( 'copyrightwarning2',
3227 '[[' . wfMessage( 'copyrightpage' )->inContentLanguage()->text() . ']]' );
3229 // Allow for site and per-namespace customization of contribution/copyright notice.
3230 Hooks
::run( 'EditPageCopyrightWarning', array( $title, &$copywarnMsg ) );
3232 return "<div id=\"editpage-copywarn\">\n" .
3233 call_user_func_array( 'wfMessage', $copywarnMsg )->$format() . "\n</div>";
3237 * Get the Limit report for page previews
3240 * @param ParserOutput $output ParserOutput object from the parse
3241 * @return string HTML
3243 public static function getPreviewLimitReport( $output ) {
3244 if ( !$output ||
!$output->getLimitReportData() ) {
3248 $limitReport = Html
::rawElement( 'div', array( 'class' => 'mw-limitReportExplanation' ),
3249 wfMessage( 'limitreport-title' )->parseAsBlock()
3252 // Show/hide animation doesn't work correctly on a table, so wrap it in a div.
3253 $limitReport .= Html
::openElement( 'div', array( 'class' => 'preview-limit-report-wrapper' ) );
3255 $limitReport .= Html
::openElement( 'table', array(
3256 'class' => 'preview-limit-report wikitable'
3258 Html
::openElement( 'tbody' );
3260 foreach ( $output->getLimitReportData() as $key => $value ) {
3261 if ( Hooks
::run( 'ParserLimitReportFormat',
3262 array( $key, &$value, &$limitReport, true, true )
3264 $keyMsg = wfMessage( $key );
3265 $valueMsg = wfMessage( array( "$key-value-html", "$key-value" ) );
3266 if ( !$valueMsg->exists() ) {
3267 $valueMsg = new RawMessage( '$1' );
3269 if ( !$keyMsg->isDisabled() && !$valueMsg->isDisabled() ) {
3270 $limitReport .= Html
::openElement( 'tr' ) .
3271 Html
::rawElement( 'th', null, $keyMsg->parse() ) .
3272 Html
::rawElement( 'td', null, $valueMsg->params( $value )->parse() ) .
3273 Html
::closeElement( 'tr' );
3278 $limitReport .= Html
::closeElement( 'tbody' ) .
3279 Html
::closeElement( 'table' ) .
3280 Html
::closeElement( 'div' );
3282 return $limitReport;
3285 protected function showStandardInputs( &$tabindex = 2 ) {
3287 $wgOut->addHTML( "<div class='editOptions'>\n" );
3289 if ( $this->section
!= 'new' ) {
3290 $this->showSummaryInput( false, $this->summary
);
3291 $wgOut->addHTML( $this->getSummaryPreview( false, $this->summary
) );
3294 $checkboxes = $this->getCheckboxes( $tabindex,
3295 array( 'minor' => $this->minoredit
, 'watch' => $this->watchthis
) );
3296 $wgOut->addHTML( "<div class='editCheckboxes'>" . implode( $checkboxes, "\n" ) . "</div>\n" );
3298 // Show copyright warning.
3299 $wgOut->addWikiText( $this->getCopywarn() );
3300 $wgOut->addHTML( $this->editFormTextAfterWarn
);
3302 $wgOut->addHTML( "<div class='editButtons'>\n" );
3303 $wgOut->addHTML( implode( $this->getEditButtons( $tabindex ), "\n" ) . "\n" );
3305 $cancel = $this->getCancelLink();
3306 if ( $cancel !== '' ) {
3307 $cancel .= Html
::element( 'span',
3308 array( 'class' => 'mw-editButtons-pipe-separator' ),
3309 wfMessage( 'pipe-separator' )->text() );
3312 $message = wfMessage( 'edithelppage' )->inContentLanguage()->text();
3313 $edithelpurl = Skin
::makeInternalOrExternalUrl( $message );
3315 'target' => 'helpwindow',
3316 'href' => $edithelpurl,
3318 $edithelp = Html
::linkButton( wfMessage( 'edithelp' )->text(),
3319 $attrs, array( 'mw-ui-quiet' ) ) .
3320 wfMessage( 'word-separator' )->escaped() .
3321 wfMessage( 'newwindow' )->parse();
3323 $wgOut->addHTML( " <span class='cancelLink'>{$cancel}</span>\n" );
3324 $wgOut->addHTML( " <span class='editHelp'>{$edithelp}</span>\n" );
3325 $wgOut->addHTML( "</div><!-- editButtons -->\n" );
3327 Hooks
::run( 'EditPage::showStandardInputs:options', array( $this, $wgOut, &$tabindex ) );
3329 $wgOut->addHTML( "</div><!-- editOptions -->\n" );
3333 * Show an edit conflict. textbox1 is already shown in showEditForm().
3334 * If you want to use another entry point to this function, be careful.
3336 protected function showConflict() {
3339 if ( Hooks
::run( 'EditPageBeforeConflictDiff', array( &$this, &$wgOut ) ) ) {
3340 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
3342 $content1 = $this->toEditContent( $this->textbox1
);
3343 $content2 = $this->toEditContent( $this->textbox2
);
3345 $handler = ContentHandler
::getForModelID( $this->contentModel
);
3346 $de = $handler->createDifferenceEngine( $this->mArticle
->getContext() );
3347 $de->setContent( $content2, $content1 );
3349 wfMessage( 'yourtext' )->parse(),
3350 wfMessage( 'storedversion' )->text()
3353 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
3354 $this->showTextbox2();
3361 public function getCancelLink() {
3362 $cancelParams = array();
3363 if ( !$this->isConflict
&& $this->oldid
> 0 ) {
3364 $cancelParams['oldid'] = $this->oldid
;
3366 $attrs = array( 'id' => 'mw-editform-cancel' );
3368 return Linker
::linkKnown(
3369 $this->getContextTitle(),
3370 wfMessage( 'cancel' )->parse(),
3371 Html
::buttonAttributes( $attrs, array( 'mw-ui-quiet' ) ),
3377 * Returns the URL to use in the form's action attribute.
3378 * This is used by EditPage subclasses when simply customizing the action
3379 * variable in the constructor is not enough. This can be used when the
3380 * EditPage lives inside of a Special page rather than a custom page action.
3382 * @param Title $title Title object for which is being edited (where we go to for &action= links)
3385 protected function getActionURL( Title
$title ) {
3386 return $title->getLocalURL( array( 'action' => $this->action
) );
3390 * Check if a page was deleted while the user was editing it, before submit.
3391 * Note that we rely on the logging table, which hasn't been always there,
3392 * but that doesn't matter, because this only applies to brand new
3396 protected function wasDeletedSinceLastEdit() {
3397 if ( $this->deletedSinceEdit
!== null ) {
3398 return $this->deletedSinceEdit
;
3401 $this->deletedSinceEdit
= false;
3403 if ( $this->mTitle
->isDeletedQuick() ) {
3404 $this->lastDelete
= $this->getLastDelete();
3405 if ( $this->lastDelete
) {
3406 $deleteTime = wfTimestamp( TS_MW
, $this->lastDelete
->log_timestamp
);
3407 if ( $deleteTime > $this->starttime
) {
3408 $this->deletedSinceEdit
= true;
3413 return $this->deletedSinceEdit
;
3417 * @return bool|stdClass
3419 protected function getLastDelete() {
3420 $dbr = wfGetDB( DB_SLAVE
);
3421 $data = $dbr->selectRow(
3422 array( 'logging', 'user' ),
3435 'log_namespace' => $this->mTitle
->getNamespace(),
3436 'log_title' => $this->mTitle
->getDBkey(),
3437 'log_type' => 'delete',
3438 'log_action' => 'delete',
3442 array( 'LIMIT' => 1, 'ORDER BY' => 'log_timestamp DESC' )
3444 // Quick paranoid permission checks...
3445 if ( is_object( $data ) ) {
3446 if ( $data->log_deleted
& LogPage
::DELETED_USER
) {
3447 $data->user_name
= wfMessage( 'rev-deleted-user' )->escaped();
3450 if ( $data->log_deleted
& LogPage
::DELETED_COMMENT
) {
3451 $data->log_comment
= wfMessage( 'rev-deleted-comment' )->escaped();
3459 * Get the rendered text for previewing.
3460 * @throws MWException
3463 function getPreviewText() {
3464 global $wgOut, $wgUser, $wgRawHtml, $wgLang;
3465 global $wgAllowUserCss, $wgAllowUserJs;
3467 $stats = $wgOut->getContext()->getStats();
3469 if ( $wgRawHtml && !$this->mTokenOk
) {
3470 // Could be an offsite preview attempt. This is very unsafe if
3471 // HTML is enabled, as it could be an attack.
3473 if ( $this->textbox1
!== '' ) {
3474 // Do not put big scary notice, if previewing the empty
3475 // string, which happens when you initially edit
3476 // a category page, due to automatic preview-on-open.
3477 $parsedNote = $wgOut->parse( "<div class='previewnote'>" .
3478 wfMessage( 'session_fail_preview_html' )->text() . "</div>", true, /* interface */true );
3480 $stats->increment( 'edit.failures.session_loss' );
3487 $content = $this->toEditContent( $this->textbox1
);
3491 'AlternateEditPreview',
3492 array( $this, &$content, &$previewHTML, &$this->mParserOutput
) )
3494 return $previewHTML;
3497 # provide a anchor link to the editform
3498 $continueEditing = '<span class="mw-continue-editing">' .
3499 '[[#' . self
::EDITFORM_ID
. '|' . $wgLang->getArrow() . ' ' .
3500 wfMessage( 'continue-editing' )->text() . ']]</span>';
3501 if ( $this->mTriedSave
&& !$this->mTokenOk
) {
3502 if ( $this->mTokenOkExceptSuffix
) {
3503 $note = wfMessage( 'token_suffix_mismatch' )->plain();
3504 $stats->increment( 'edit.failures.bad_token' );
3506 $note = wfMessage( 'session_fail_preview' )->plain();
3507 $stats->increment( 'edit.failures.session_loss' );
3509 } elseif ( $this->incompleteForm
) {
3510 $note = wfMessage( 'edit_form_incomplete' )->plain();
3511 if ( $this->mTriedSave
) {
3512 $stats->increment( 'edit.failures.incomplete_form' );
3515 $note = wfMessage( 'previewnote' )->plain() . ' ' . $continueEditing;
3518 $parserOptions = $this->mArticle
->makeParserOptions( $this->mArticle
->getContext() );
3519 $parserOptions->setIsPreview( true );
3520 $parserOptions->setIsSectionPreview( !is_null( $this->section
) && $this->section
!== '' );
3522 # don't parse non-wikitext pages, show message about preview
3523 if ( $this->mTitle
->isCssJsSubpage() ||
$this->mTitle
->isCssOrJsPage() ) {
3524 if ( $this->mTitle
->isCssJsSubpage() ) {
3526 } elseif ( $this->mTitle
->isCssOrJsPage() ) {
3532 if ( $content->getModel() == CONTENT_MODEL_CSS
) {
3534 if ( $level === 'user' && !$wgAllowUserCss ) {
3537 } elseif ( $content->getModel() == CONTENT_MODEL_JAVASCRIPT
) {
3539 if ( $level === 'user' && !$wgAllowUserJs ) {
3546 # Used messages to make sure grep find them:
3547 # Messages: usercsspreview, userjspreview, sitecsspreview, sitejspreview
3548 if ( $level && $format ) {
3549 $note = "<div id='mw-{$level}{$format}preview'>" .
3550 wfMessage( "{$level}{$format}preview" )->text() .
3551 ' ' . $continueEditing . "</div>";
3555 # If we're adding a comment, we need to show the
3556 # summary as the headline
3557 if ( $this->section
=== "new" && $this->summary
!== "" ) {
3558 $content = $content->addSectionHeader( $this->summary
);
3561 $hook_args = array( $this, &$content );
3562 ContentHandler
::runLegacyHooks( 'EditPageGetPreviewText', $hook_args );
3563 Hooks
::run( 'EditPageGetPreviewContent', $hook_args );
3565 $parserOptions->enableLimitReport();
3567 # For CSS/JS pages, we should have called the ShowRawCssJs hook here.
3568 # But it's now deprecated, so never mind
3570 $pstContent = $content->preSaveTransform( $this->mTitle
, $wgUser, $parserOptions );
3571 $scopedCallback = $parserOptions->setupFakeRevision(
3572 $this->mTitle
, $pstContent, $wgUser );
3573 $parserOutput = $pstContent->getParserOutput( $this->mTitle
, null, $parserOptions );
3575 # Try to stash the edit for the final submission step
3576 # @todo: different date format preferences cause cache misses
3577 ApiStashEdit
::stashEditFromPreview(
3578 $this->getArticle(), $content, $pstContent,
3579 $parserOutput, $parserOptions, $parserOptions, wfTimestampNow()
3582 $parserOutput->setEditSectionTokens( false ); // no section edit links
3583 $previewHTML = $parserOutput->getText();
3584 $this->mParserOutput
= $parserOutput;
3585 $wgOut->addParserOutputMetadata( $parserOutput );
3587 if ( count( $parserOutput->getWarnings() ) ) {
3588 $note .= "\n\n" . implode( "\n\n", $parserOutput->getWarnings() );
3590 } catch ( MWContentSerializationException
$ex ) {
3592 'content-failed-to-parse',
3593 $this->contentModel
,
3594 $this->contentFormat
,
3597 $note .= "\n\n" . $m->parse();
3601 if ( $this->isConflict
) {
3602 $conflict = '<h2 id="mw-previewconflict">'
3603 . wfMessage( 'previewconflict' )->escaped() . "</h2>\n";
3605 $conflict = '<hr />';
3608 $previewhead = "<div class='previewnote'>\n" .
3609 '<h2 id="mw-previewheader">' . wfMessage( 'preview' )->escaped() . "</h2>" .
3610 $wgOut->parse( $note, true, /* interface */true ) . $conflict . "</div>\n";
3612 $pageViewLang = $this->mTitle
->getPageViewLanguage();
3613 $attribs = array( 'lang' => $pageViewLang->getHtmlCode(), 'dir' => $pageViewLang->getDir(),
3614 'class' => 'mw-content-' . $pageViewLang->getDir() );
3615 $previewHTML = Html
::rawElement( 'div', $attribs, $previewHTML );
3617 return $previewhead . $previewHTML . $this->previewTextAfterContent
;
3623 function getTemplates() {
3624 if ( $this->preview ||
$this->section
!= '' ) {
3625 $templates = array();
3626 if ( !isset( $this->mParserOutput
) ) {
3629 foreach ( $this->mParserOutput
->getTemplates() as $ns => $template ) {
3630 foreach ( array_keys( $template ) as $dbk ) {
3631 $templates[] = Title
::makeTitle( $ns, $dbk );
3636 return $this->mTitle
->getTemplateLinksFrom();
3641 * Shows a bulletin board style toolbar for common editing functions.
3642 * It can be disabled in the user preferences.
3646 static function getEditToolbar() {
3647 global $wgContLang, $wgOut;
3648 global $wgEnableUploads, $wgForeignFileRepos;
3650 $imagesAvailable = $wgEnableUploads ||
count( $wgForeignFileRepos );
3653 * $toolarray is an array of arrays each of which includes the
3654 * opening tag, the closing tag, optionally a sample text that is
3655 * inserted between the two when no selection is highlighted
3656 * and. The tip text is shown when the user moves the mouse
3659 * Images are defined in ResourceLoaderEditToolbarModule.
3663 'id' => 'mw-editbutton-bold',
3665 'close' => '\'\'\'',
3666 'sample' => wfMessage( 'bold_sample' )->text(),
3667 'tip' => wfMessage( 'bold_tip' )->text(),
3670 'id' => 'mw-editbutton-italic',
3673 'sample' => wfMessage( 'italic_sample' )->text(),
3674 'tip' => wfMessage( 'italic_tip' )->text(),
3677 'id' => 'mw-editbutton-link',
3680 'sample' => wfMessage( 'link_sample' )->text(),
3681 'tip' => wfMessage( 'link_tip' )->text(),
3684 'id' => 'mw-editbutton-extlink',
3687 'sample' => wfMessage( 'extlink_sample' )->text(),
3688 'tip' => wfMessage( 'extlink_tip' )->text(),
3691 'id' => 'mw-editbutton-headline',
3694 'sample' => wfMessage( 'headline_sample' )->text(),
3695 'tip' => wfMessage( 'headline_tip' )->text(),
3697 $imagesAvailable ?
array(
3698 'id' => 'mw-editbutton-image',
3699 'open' => '[[' . $wgContLang->getNsText( NS_FILE
) . ':',
3701 'sample' => wfMessage( 'image_sample' )->text(),
3702 'tip' => wfMessage( 'image_tip' )->text(),
3704 $imagesAvailable ?
array(
3705 'id' => 'mw-editbutton-media',
3706 'open' => '[[' . $wgContLang->getNsText( NS_MEDIA
) . ':',
3708 'sample' => wfMessage( 'media_sample' )->text(),
3709 'tip' => wfMessage( 'media_tip' )->text(),
3712 'id' => 'mw-editbutton-nowiki',
3713 'open' => "<nowiki>",
3714 'close' => "</nowiki>",
3715 'sample' => wfMessage( 'nowiki_sample' )->text(),
3716 'tip' => wfMessage( 'nowiki_tip' )->text(),
3719 'id' => 'mw-editbutton-signature',
3723 'tip' => wfMessage( 'sig_tip' )->text(),
3726 'id' => 'mw-editbutton-hr',
3727 'open' => "\n----\n",
3730 'tip' => wfMessage( 'hr_tip' )->text(),
3734 $script = 'mw.loader.using("mediawiki.toolbar", function () {';
3735 foreach ( $toolarray as $tool ) {
3741 // Images are defined in ResourceLoaderEditToolbarModule
3743 // Note that we use the tip both for the ALT tag and the TITLE tag of the image.
3744 // Older browsers show a "speedtip" type message only for ALT.
3745 // Ideally these should be different, realistically they
3746 // probably don't need to be.
3754 $script .= Xml
::encodeJsCall(
3755 'mw.toolbar.addButton',
3757 ResourceLoader
::inDebugMode()
3762 $wgOut->addScript( ResourceLoader
::makeInlineScript( $script ) );
3764 $toolbar = '<div id="toolbar"></div>';
3766 Hooks
::run( 'EditPageBeforeEditToolbar', array( &$toolbar ) );
3772 * Returns an array of html code of the following checkboxes:
3775 * @param int $tabindex Current tabindex
3776 * @param array $checked Array of checkbox => bool, where bool indicates the checked
3777 * status of the checkbox
3781 public function getCheckboxes( &$tabindex, $checked ) {
3782 global $wgUser, $wgUseMediaWikiUIEverywhere;
3784 $checkboxes = array();
3786 // don't show the minor edit checkbox if it's a new page or section
3787 if ( !$this->isNew
) {
3788 $checkboxes['minor'] = '';
3789 $minorLabel = wfMessage( 'minoredit' )->parse();
3790 if ( $wgUser->isAllowed( 'minoredit' ) ) {
3792 'tabindex' => ++
$tabindex,
3793 'accesskey' => wfMessage( 'accesskey-minoredit' )->text(),
3794 'id' => 'wpMinoredit',
3797 Xml
::check( 'wpMinoredit', $checked['minor'], $attribs ) .
3798 " <label for='wpMinoredit' id='mw-editpage-minoredit'" .
3799 Xml
::expandAttributes( array( 'title' => Linker
::titleAttrib( 'minoredit', 'withaccess' ) ) ) .
3800 ">{$minorLabel}</label>";
3802 if ( $wgUseMediaWikiUIEverywhere ) {
3803 $checkboxes['minor'] = Html
::openElement( 'div', array( 'class' => 'mw-ui-checkbox' ) ) .
3805 Html
::closeElement( 'div' );
3807 $checkboxes['minor'] = $minorEditHtml;
3812 $watchLabel = wfMessage( 'watchthis' )->parse();
3813 $checkboxes['watch'] = '';
3814 if ( $wgUser->isLoggedIn() ) {
3816 'tabindex' => ++
$tabindex,
3817 'accesskey' => wfMessage( 'accesskey-watch' )->text(),
3818 'id' => 'wpWatchthis',
3821 Xml
::check( 'wpWatchthis', $checked['watch'], $attribs ) .
3822 " <label for='wpWatchthis' id='mw-editpage-watch'" .
3823 Xml
::expandAttributes( array( 'title' => Linker
::titleAttrib( 'watch', 'withaccess' ) ) ) .
3824 ">{$watchLabel}</label>";
3825 if ( $wgUseMediaWikiUIEverywhere ) {
3826 $checkboxes['watch'] = Html
::openElement( 'div', array( 'class' => 'mw-ui-checkbox' ) ) .
3828 Html
::closeElement( 'div' );
3830 $checkboxes['watch'] = $watchThisHtml;
3833 Hooks
::run( 'EditPageBeforeEditChecks', array( &$this, &$checkboxes, &$tabindex ) );
3838 * Returns an array of html code of the following buttons:
3839 * save, diff, preview and live
3841 * @param int $tabindex Current tabindex
3845 public function getEditButtons( &$tabindex ) {
3851 'tabindex' => ++
$tabindex,
3852 ) + Linker
::tooltipAndAccesskeyAttribs( 'save' );
3853 $buttons['save'] = Html
::submitButton( wfMessage( 'savearticle' )->text(),
3854 $attribs, array( 'mw-ui-constructive' ) );
3856 ++
$tabindex; // use the same for preview and live preview
3858 'id' => 'wpPreview',
3859 'name' => 'wpPreview',
3860 'tabindex' => $tabindex,
3861 ) + Linker
::tooltipAndAccesskeyAttribs( 'preview' );
3862 $buttons['preview'] = Html
::submitButton( wfMessage( 'showpreview' )->text(),
3864 $buttons['live'] = '';
3869 'tabindex' => ++
$tabindex,
3870 ) + Linker
::tooltipAndAccesskeyAttribs( 'diff' );
3871 $buttons['diff'] = Html
::submitButton( wfMessage( 'showdiff' )->text(),
3874 Hooks
::run( 'EditPageBeforeEditButtons', array( &$this, &$buttons, &$tabindex ) );
3879 * Creates a basic error page which informs the user that
3880 * they have attempted to edit a nonexistent section.
3882 function noSuchSectionPage() {
3885 $wgOut->prepareErrorPage( wfMessage( 'nosuchsectiontitle' ) );
3887 $res = wfMessage( 'nosuchsectiontext', $this->section
)->parseAsBlock();
3888 Hooks
::run( 'EditPageNoSuchSection', array( &$this, &$res ) );
3889 $wgOut->addHTML( $res );
3891 $wgOut->returnToMain( false, $this->mTitle
);
3895 * Show "your edit contains spam" page with your diff and text
3897 * @param string|array|bool $match Text (or array of texts) which triggered one or more filters
3899 public function spamPageWithContent( $match = false ) {
3900 global $wgOut, $wgLang;
3901 $this->textbox2
= $this->textbox1
;
3903 if ( is_array( $match ) ) {
3904 $match = $wgLang->listToText( $match );
3906 $wgOut->prepareErrorPage( wfMessage( 'spamprotectiontitle' ) );
3908 $wgOut->addHTML( '<div id="spamprotected">' );
3909 $wgOut->addWikiMsg( 'spamprotectiontext' );
3911 $wgOut->addWikiMsg( 'spamprotectionmatch', wfEscapeWikiText( $match ) );
3913 $wgOut->addHTML( '</div>' );
3915 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
3918 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
3919 $this->showTextbox2();
3921 $wgOut->addReturnTo( $this->getContextTitle(), array( 'action' => 'edit' ) );
3925 * Check if the browser is on a blacklist of user-agents known to
3926 * mangle UTF-8 data on form submission. Returns true if Unicode
3927 * should make it through, false if it's known to be a problem.
3930 private function checkUnicodeCompliantBrowser() {
3931 global $wgBrowserBlackList, $wgRequest;
3933 $currentbrowser = $wgRequest->getHeader( 'User-Agent' );
3934 if ( $currentbrowser === false ) {
3935 // No User-Agent header sent? Trust it by default...
3939 foreach ( $wgBrowserBlackList as $browser ) {
3940 if ( preg_match( $browser, $currentbrowser ) ) {
3948 * Filter an input field through a Unicode de-armoring process if it
3949 * came from an old browser with known broken Unicode editing issues.
3951 * @param WebRequest $request
3952 * @param string $field
3955 protected function safeUnicodeInput( $request, $field ) {
3956 $text = rtrim( $request->getText( $field ) );
3957 return $request->getBool( 'safemode' )
3958 ?
$this->unmakeSafe( $text )
3963 * Filter an output field through a Unicode armoring process if it is
3964 * going to an old browser with known broken Unicode editing issues.
3966 * @param string $text
3969 protected function safeUnicodeOutput( $text ) {
3971 $codedText = $wgContLang->recodeForEdit( $text );
3972 return $this->checkUnicodeCompliantBrowser()
3974 : $this->makeSafe( $codedText );
3978 * A number of web browsers are known to corrupt non-ASCII characters
3979 * in a UTF-8 text editing environment. To protect against this,
3980 * detected browsers will be served an armored version of the text,
3981 * with non-ASCII chars converted to numeric HTML character references.
3983 * Preexisting such character references will have a 0 added to them
3984 * to ensure that round-trips do not alter the original data.
3986 * @param string $invalue
3989 private function makeSafe( $invalue ) {
3990 // Armor existing references for reversibility.
3991 $invalue = strtr( $invalue, array( "&#x" => "�" ) );
3996 $valueLength = strlen( $invalue );
3997 for ( $i = 0; $i < $valueLength; $i++
) {
3998 $bytevalue = ord( $invalue[$i] );
3999 if ( $bytevalue <= 0x7F ) { // 0xxx xxxx
4000 $result .= chr( $bytevalue );
4002 } elseif ( $bytevalue <= 0xBF ) { // 10xx xxxx
4003 $working = $working << 6;
4004 $working +
= ( $bytevalue & 0x3F );
4006 if ( $bytesleft <= 0 ) {
4007 $result .= "&#x" . strtoupper( dechex( $working ) ) . ";";
4009 } elseif ( $bytevalue <= 0xDF ) { // 110x xxxx
4010 $working = $bytevalue & 0x1F;
4012 } elseif ( $bytevalue <= 0xEF ) { // 1110 xxxx
4013 $working = $bytevalue & 0x0F;
4015 } else { // 1111 0xxx
4016 $working = $bytevalue & 0x07;
4024 * Reverse the previously applied transliteration of non-ASCII characters
4025 * back to UTF-8. Used to protect data from corruption by broken web browsers
4026 * as listed in $wgBrowserBlackList.
4028 * @param string $invalue
4031 private function unmakeSafe( $invalue ) {
4033 $valueLength = strlen( $invalue );
4034 for ( $i = 0; $i < $valueLength; $i++
) {
4035 if ( ( substr( $invalue, $i, 3 ) == "&#x" ) && ( $invalue[$i +
3] != '0' ) ) {
4039 $hexstring .= $invalue[$i];
4041 } while ( ctype_xdigit( $invalue[$i] ) && ( $i < strlen( $invalue ) ) );
4043 // Do some sanity checks. These aren't needed for reversibility,
4044 // but should help keep the breakage down if the editor
4045 // breaks one of the entities whilst editing.
4046 if ( ( substr( $invalue, $i, 1 ) == ";" ) && ( strlen( $hexstring ) <= 6 ) ) {
4047 $codepoint = hexdec( $hexstring );
4048 $result .= UtfNormal\Utils
::codepointToUtf8( $codepoint );
4050 $result .= "&#x" . $hexstring . substr( $invalue, $i, 1 );
4053 $result .= substr( $invalue, $i, 1 );
4056 // reverse the transform that we made for reversibility reasons.
4057 return strtr( $result, array( "�" => "&#x" ) );