3 * User interface for page editing.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
24 * The edit page/HTML interface (split from Article)
25 * The actual database and text munging is still in Article,
26 * but it should get easier to call those from alternate
29 * EditPage cares about two distinct titles:
30 * $this->mContextTitle is the page that forms submit to, links point to,
31 * redirects go to, etc. $this->mTitle (as well as $mArticle) is the
32 * page in the database that is actually being edited. These are
33 * usually the same, but they are now allowed to be different.
35 * Surgeon General's Warning: prolonged exposure to this class is known to cause
36 * headaches, which may be fatal.
40 * Status: Article successfully updated
42 const AS_SUCCESS_UPDATE
= 200;
45 * Status: Article successfully created
47 const AS_SUCCESS_NEW_ARTICLE
= 201;
50 * Status: Article update aborted by a hook function
52 const AS_HOOK_ERROR
= 210;
55 * Status: A hook function returned an error
57 const AS_HOOK_ERROR_EXPECTED
= 212;
60 * Status: User is blocked from editing this page
62 const AS_BLOCKED_PAGE_FOR_USER
= 215;
65 * Status: Content too big (> $wgMaxArticleSize)
67 const AS_CONTENT_TOO_BIG
= 216;
70 * Status: this anonymous user is not allowed to edit this page
72 const AS_READ_ONLY_PAGE_ANON
= 218;
75 * Status: this logged in user is not allowed to edit this page
77 const AS_READ_ONLY_PAGE_LOGGED
= 219;
80 * Status: wiki is in readonly mode (wfReadOnly() == true)
82 const AS_READ_ONLY_PAGE
= 220;
85 * Status: rate limiter for action 'edit' was tripped
87 const AS_RATE_LIMITED
= 221;
90 * Status: article was deleted while editing and param wpRecreate == false or form
93 const AS_ARTICLE_WAS_DELETED
= 222;
96 * Status: user tried to create this page, but is not allowed to do that
97 * ( Title->userCan('create') == false )
99 const AS_NO_CREATE_PERMISSION
= 223;
102 * Status: user tried to create a blank page and wpIgnoreBlankArticle == false
104 const AS_BLANK_ARTICLE
= 224;
107 * Status: (non-resolvable) edit conflict
109 const AS_CONFLICT_DETECTED
= 225;
112 * Status: no edit summary given and the user has forceeditsummary set and the user is not
113 * editing in his own userspace or talkspace and wpIgnoreBlankSummary == false
115 const AS_SUMMARY_NEEDED
= 226;
118 * Status: user tried to create a new section without content
120 const AS_TEXTBOX_EMPTY
= 228;
123 * Status: article is too big (> $wgMaxArticleSize), after merging in the new section
125 const AS_MAX_ARTICLE_SIZE_EXCEEDED
= 229;
128 * Status: WikiPage::doEdit() was unsuccessful
133 * Status: summary contained spam according to one of the regexes in $wgSummarySpamRegex
135 const AS_SPAM_ERROR
= 232;
138 * Status: anonymous user is not allowed to upload (User::isAllowed('upload') == false)
140 const AS_IMAGE_REDIRECT_ANON
= 233;
143 * Status: logged in user is not allowed to upload (User::isAllowed('upload') == false)
145 const AS_IMAGE_REDIRECT_LOGGED
= 234;
148 * Status: user tried to modify the content model, but is not allowed to do that
149 * ( User::isAllowed('editcontentmodel') == false )
151 const AS_NO_CHANGE_CONTENT_MODEL
= 235;
154 * Status: user tried to create self-redirect (redirect to the same article) and
155 * wpIgnoreSelfRedirect == false
157 const AS_SELF_REDIRECT
= 236;
160 * Status: can't parse content
162 const AS_PARSE_ERROR
= 240;
165 * HTML id and name for the beginning of the edit form.
167 const EDITFORM_ID
= 'editform';
170 * Prefix of key for cookie used to pass post-edit state.
171 * The revision id edited is added after this
173 const POST_EDIT_COOKIE_KEY_PREFIX
= 'PostEditRevision';
176 * Duration of PostEdit cookie, in seconds.
177 * The cookie will be removed instantly if the JavaScript runs.
179 * Otherwise, though, we don't want the cookies to accumulate.
180 * RFC 2109 ( https://www.ietf.org/rfc/rfc2109.txt ) specifies a possible
181 * limit of only 20 cookies per domain. This still applies at least to some
182 * versions of IE without full updates:
183 * https://blogs.msdn.com/b/ieinternals/archive/2009/08/20/wininet-ie-cookie-internals-faq.aspx
185 * A value of 20 minutes should be enough to take into account slow loads and minor
186 * clock skew while still avoiding cookie accumulation when JavaScript is turned off.
188 const POST_EDIT_COOKIE_DURATION
= 1200;
196 /** @var null|Title */
197 private $mContextTitle = null;
200 public $action = 'submit';
203 public $isConflict = false;
206 public $isCssJsSubpage = false;
209 public $isCssSubpage = false;
212 public $isJsSubpage = false;
215 public $isWrongCaseCssJsPage = false;
217 /** @var bool New page or new section */
218 public $isNew = false;
221 public $deletedSinceEdit;
229 /** @var bool|stdClass */
233 public $mTokenOk = false;
236 public $mTokenOkExceptSuffix = false;
239 public $mTriedSave = false;
242 public $incompleteForm = false;
245 public $tooBig = false;
248 public $kblength = false;
251 public $missingComment = false;
254 public $missingSummary = false;
257 public $allowBlankSummary = false;
260 protected $blankArticle = false;
263 protected $allowBlankArticle = false;
266 protected $selfRedirect = false;
269 protected $allowSelfRedirect = false;
272 public $autoSumm = '';
275 public $hookError = '';
277 /** @var ParserOutput */
278 public $mParserOutput;
280 /** @var bool Has a summary been preset using GET parameter &summary= ? */
281 public $hasPresetSummary = false;
284 public $mBaseRevision = false;
287 public $mShowSummaryField = true;
292 public $save = false;
295 public $preview = false;
298 public $diff = false;
301 public $minoredit = false;
304 public $watchthis = false;
307 public $recreate = false;
310 public $textbox1 = '';
313 public $textbox2 = '';
316 public $summary = '';
319 public $nosummary = false;
322 public $edittime = '';
325 public $section = '';
328 public $sectiontitle = '';
331 public $starttime = '';
337 public $parentRevId = 0;
340 public $editintro = '';
343 public $scrolltop = null;
348 /** @var null|string */
349 public $contentModel = null;
351 /** @var null|string */
352 public $contentFormat = null;
354 # Placeholders for text injection by hooks (must be HTML)
355 # extensions should take care to _append_ to the present value
357 /** @var string Before even the preview */
358 public $editFormPageTop = '';
359 public $editFormTextTop = '';
360 public $editFormTextBeforeContent = '';
361 public $editFormTextAfterWarn = '';
362 public $editFormTextAfterTools = '';
363 public $editFormTextBottom = '';
364 public $editFormTextAfterContent = '';
365 public $previewTextAfterContent = '';
366 public $mPreloadContent = null;
368 /* $didSave should be set to true whenever an article was successfully altered. */
369 public $didSave = false;
370 public $undidRev = 0;
372 public $suppressIntro = false;
374 /** @var bool Set to true to allow editing of non-text content types. */
375 public $allowNonTextContent = false;
384 * @param Article $article
386 public function __construct( Article
$article ) {
387 $this->mArticle
= $article;
388 $this->mTitle
= $article->getTitle();
390 $this->contentModel
= $this->mTitle
->getContentModel();
392 $handler = ContentHandler
::getForModelID( $this->contentModel
);
393 $this->contentFormat
= $handler->getDefaultFormat();
399 public function getArticle() {
400 return $this->mArticle
;
407 public function getTitle() {
408 return $this->mTitle
;
412 * Set the context Title object
414 * @param Title|null $title Title object or null
416 public function setContextTitle( $title ) {
417 $this->mContextTitle
= $title;
421 * Get the context title object.
422 * If not set, $wgTitle will be returned. This behavior might change in
423 * the future to return $this->mTitle instead.
427 public function getContextTitle() {
428 if ( is_null( $this->mContextTitle
) ) {
432 return $this->mContextTitle
;
437 * Returns if the given content model is editable.
439 * @param string $modelId The ID of the content model to test. Use CONTENT_MODEL_XXX constants.
441 * @throws MWException If $modelId has no known handler
443 public function isSupportedContentModel( $modelId ) {
444 return $this->allowNonTextContent ||
445 ContentHandler
::getForModelID( $modelId ) instanceof TextContentHandler
;
453 * This is the function that gets called for "action=edit". It
454 * sets up various member variables, then passes execution to
455 * another function, usually showEditForm()
457 * The edit form is self-submitting, so that when things like
458 * preview and edit conflicts occur, we get the same form back
459 * with the extra stuff added. Only when the final submission
460 * is made and all is well do we actually save and redirect to
461 * the newly-edited page.
464 global $wgOut, $wgRequest, $wgUser;
465 // Allow extensions to modify/prevent this form or submission
466 if ( !Hooks
::run( 'AlternateEdit', array( $this ) ) ) {
470 wfProfileIn( __METHOD__
);
471 wfDebug( __METHOD__
. ": enter\n" );
473 // If they used redlink=1 and the page exists, redirect to the main article
474 if ( $wgRequest->getBool( 'redlink' ) && $this->mTitle
->exists() ) {
475 $wgOut->redirect( $this->mTitle
->getFullURL() );
476 wfProfileOut( __METHOD__
);
480 $this->importFormData( $wgRequest );
481 $this->firsttime
= false;
484 $this->livePreview();
485 wfProfileOut( __METHOD__
);
489 if ( wfReadOnly() && $this->save
) {
492 $this->preview
= true;
496 $this->formtype
= 'save';
497 } elseif ( $this->preview
) {
498 $this->formtype
= 'preview';
499 } elseif ( $this->diff
) {
500 $this->formtype
= 'diff';
501 } else { # First time through
502 $this->firsttime
= true;
503 if ( $this->previewOnOpen() ) {
504 $this->formtype
= 'preview';
506 $this->formtype
= 'initial';
510 $permErrors = $this->getEditPermissionErrors();
512 wfDebug( __METHOD__
. ": User can't edit\n" );
513 // Auto-block user's IP if the account was "hard" blocked
514 $wgUser->spreadAnyEditBlock();
516 $this->displayPermissionsError( $permErrors );
518 wfProfileOut( __METHOD__
);
522 wfProfileIn( __METHOD__
. "-business-end" );
524 $this->isConflict
= false;
525 // css / js subpages of user pages get a special treatment
526 $this->isCssJsSubpage
= $this->mTitle
->isCssJsSubpage();
527 $this->isCssSubpage
= $this->mTitle
->isCssSubpage();
528 $this->isJsSubpage
= $this->mTitle
->isJsSubpage();
529 // @todo FIXME: Silly assignment.
530 $this->isWrongCaseCssJsPage
= $this->isWrongCaseCssJsPage();
532 # Show applicable editing introductions
533 if ( $this->formtype
== 'initial' ||
$this->firsttime
) {
537 # Attempt submission here. This will check for edit conflicts,
538 # and redundantly check for locked database, blocked IPs, etc.
539 # that edit() already checked just in case someone tries to sneak
540 # in the back door with a hand-edited submission URL.
542 if ( 'save' == $this->formtype
) {
543 if ( !$this->attemptSave() ) {
544 wfProfileOut( __METHOD__
. "-business-end" );
545 wfProfileOut( __METHOD__
);
550 # First time through: get contents, set time for conflict
552 if ( 'initial' == $this->formtype ||
$this->firsttime
) {
553 if ( $this->initialiseForm() === false ) {
554 $this->noSuchSectionPage();
555 wfProfileOut( __METHOD__
. "-business-end" );
556 wfProfileOut( __METHOD__
);
560 if ( !$this->mTitle
->getArticleID() ) {
561 Hooks
::run( 'EditFormPreloadText', array( &$this->textbox1
, &$this->mTitle
) );
563 Hooks
::run( 'EditFormInitialText', array( $this ) );
568 $this->showEditForm();
569 wfProfileOut( __METHOD__
. "-business-end" );
570 wfProfileOut( __METHOD__
);
576 protected function getEditPermissionErrors() {
578 $permErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $wgUser );
579 # Can this title be created?
580 if ( !$this->mTitle
->exists() ) {
581 $permErrors = array_merge( $permErrors,
582 wfArrayDiff2( $this->mTitle
->getUserPermissionsErrors( 'create', $wgUser ), $permErrors ) );
584 # Ignore some permissions errors when a user is just previewing/viewing diffs
586 foreach ( $permErrors as $error ) {
587 if ( ( $this->preview ||
$this->diff
)
588 && ( $error[0] == 'blockedtext' ||
$error[0] == 'autoblockedtext' )
593 $permErrors = wfArrayDiff2( $permErrors, $remove );
598 * Display a permissions error page, like OutputPage::showPermissionsErrorPage(),
599 * but with the following differences:
600 * - If redlink=1, the user will be redirected to the page
601 * - If there is content to display or the error occurs while either saving,
602 * previewing or showing the difference, it will be a
603 * "View source for ..." page displaying the source code after the error message.
606 * @param array $permErrors Array of permissions errors, as returned by
607 * Title::getUserPermissionsErrors().
608 * @throws PermissionsError
610 protected function displayPermissionsError( array $permErrors ) {
611 global $wgRequest, $wgOut;
613 if ( $wgRequest->getBool( 'redlink' ) ) {
614 // The edit page was reached via a red link.
615 // Redirect to the article page and let them click the edit tab if
616 // they really want a permission error.
617 $wgOut->redirect( $this->mTitle
->getFullURL() );
621 $content = $this->getContentObject();
623 # Use the normal message if there's nothing to display
624 if ( $this->firsttime
&& ( !$content ||
$content->isEmpty() ) ) {
625 $action = $this->mTitle
->exists() ?
'edit' :
626 ( $this->mTitle
->isTalkPage() ?
'createtalk' : 'createpage' );
627 throw new PermissionsError( $action, $permErrors );
630 Hooks
::run( 'EditPage::showReadOnlyForm:initial', array( $this, &$wgOut ) );
632 $wgOut->setRobotPolicy( 'noindex,nofollow' );
633 $wgOut->setPageTitle( wfMessage(
635 $this->getContextTitle()->getPrefixedText()
637 $wgOut->addBacklinkSubtitle( $this->getContextTitle() );
638 $wgOut->addWikiText( $wgOut->formatPermissionsErrorMessage( $permErrors, 'edit' ) );
639 $wgOut->addHTML( "<hr />\n" );
641 # If the user made changes, preserve them when showing the markup
642 # (This happens when a user is blocked during edit, for instance)
643 if ( !$this->firsttime
) {
644 $text = $this->textbox1
;
645 $wgOut->addWikiMsg( 'viewyourtext' );
647 $text = $this->toEditText( $content );
648 $wgOut->addWikiMsg( 'viewsourcetext' );
651 $this->showTextbox( $text, 'wpTextbox1', array( 'readonly' ) );
653 $wgOut->addHTML( Html
::rawElement( 'div', array( 'class' => 'templatesUsed' ),
654 Linker
::formatTemplates( $this->getTemplates() ) ) );
656 $wgOut->addModules( 'mediawiki.action.edit.collapsibleFooter' );
658 if ( $this->mTitle
->exists() ) {
659 $wgOut->returnToMain( null, $this->mTitle
);
664 * Should we show a preview when the edit form is first shown?
668 protected function previewOnOpen() {
669 global $wgRequest, $wgUser, $wgPreviewOnOpenNamespaces;
670 if ( $wgRequest->getVal( 'preview' ) == 'yes' ) {
671 // Explicit override from request
673 } elseif ( $wgRequest->getVal( 'preview' ) == 'no' ) {
674 // Explicit override from request
676 } elseif ( $this->section
== 'new' ) {
677 // Nothing *to* preview for new sections
679 } elseif ( ( $wgRequest->getVal( 'preload' ) !== null ||
$this->mTitle
->exists() )
680 && $wgUser->getOption( 'previewonfirst' )
682 // Standard preference behavior
684 } elseif ( !$this->mTitle
->exists()
685 && isset( $wgPreviewOnOpenNamespaces[$this->mTitle
->getNamespace()] )
686 && $wgPreviewOnOpenNamespaces[$this->mTitle
->getNamespace()]
688 // Categories are special
696 * Checks whether the user entered a skin name in uppercase,
697 * e.g. "User:Example/Monobook.css" instead of "monobook.css"
701 protected function isWrongCaseCssJsPage() {
702 if ( $this->mTitle
->isCssJsSubpage() ) {
703 $name = $this->mTitle
->getSkinFromCssJsSubpage();
704 $skins = array_merge(
705 array_keys( Skin
::getSkinNames() ),
708 return !in_array( $name, $skins )
709 && in_array( strtolower( $name ), $skins );
716 * Returns whether section editing is supported for the current page.
717 * Subclasses may override this to replace the default behavior, which is
718 * to check ContentHandler::supportsSections.
720 * @return bool True if this edit page supports sections, false otherwise.
722 protected function isSectionEditSupported() {
723 $contentHandler = ContentHandler
::getForTitle( $this->mTitle
);
724 return $contentHandler->supportsSections();
728 * This function collects the form data and uses it to populate various member variables.
729 * @param WebRequest $request
730 * @throws ErrorPageError
732 function importFormData( &$request ) {
733 global $wgContLang, $wgUser;
735 wfProfileIn( __METHOD__
);
737 # Section edit can come from either the form or a link
738 $this->section
= $request->getVal( 'wpSection', $request->getVal( 'section' ) );
740 if ( $this->section
!== null && $this->section
!== '' && !$this->isSectionEditSupported() ) {
741 wfProfileOut( __METHOD__
);
742 throw new ErrorPageError( 'sectioneditnotsupported-title', 'sectioneditnotsupported-text' );
745 $this->isNew
= !$this->mTitle
->exists() ||
$this->section
== 'new';
747 if ( $request->wasPosted() ) {
748 # These fields need to be checked for encoding.
749 # Also remove trailing whitespace, but don't remove _initial_
750 # whitespace from the text boxes. This may be significant formatting.
751 $this->textbox1
= $this->safeUnicodeInput( $request, 'wpTextbox1' );
752 if ( !$request->getCheck( 'wpTextbox2' ) ) {
753 // Skip this if wpTextbox2 has input, it indicates that we came
754 // from a conflict page with raw page text, not a custom form
755 // modified by subclasses
756 wfProfileIn( get_class( $this ) . "::importContentFormData" );
757 $textbox1 = $this->importContentFormData( $request );
758 if ( $textbox1 !== null ) {
759 $this->textbox1
= $textbox1;
762 wfProfileOut( get_class( $this ) . "::importContentFormData" );
765 # Truncate for whole multibyte characters
766 $this->summary
= $wgContLang->truncate( $request->getText( 'wpSummary' ), 255 );
768 # If the summary consists of a heading, e.g. '==Foobar==', extract the title from the
769 # header syntax, e.g. 'Foobar'. This is mainly an issue when we are using wpSummary for
771 $this->summary
= preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->summary
);
773 # Treat sectiontitle the same way as summary.
774 # Note that wpSectionTitle is not yet a part of the actual edit form, as wpSummary is
775 # currently doing double duty as both edit summary and section title. Right now this
776 # is just to allow API edits to work around this limitation, but this should be
777 # incorporated into the actual edit form when EditPage is rewritten (Bugs 18654, 26312).
778 $this->sectiontitle
= $wgContLang->truncate( $request->getText( 'wpSectionTitle' ), 255 );
779 $this->sectiontitle
= preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->sectiontitle
);
781 $this->edittime
= $request->getVal( 'wpEdittime' );
782 $this->starttime
= $request->getVal( 'wpStarttime' );
784 $undidRev = $request->getInt( 'wpUndidRevision' );
786 $this->undidRev
= $undidRev;
789 $this->scrolltop
= $request->getIntOrNull( 'wpScrolltop' );
791 if ( $this->textbox1
=== '' && $request->getVal( 'wpTextbox1' ) === null ) {
792 // wpTextbox1 field is missing, possibly due to being "too big"
793 // according to some filter rules such as Suhosin's setting for
794 // suhosin.request.max_value_length (d'oh)
795 $this->incompleteForm
= true;
797 // If we receive the last parameter of the request, we can fairly
798 // claim the POST request has not been truncated.
800 // TODO: softened the check for cutover. Once we determine
801 // that it is safe, we should complete the transition by
802 // removing the "edittime" clause.
803 $this->incompleteForm
= ( !$request->getVal( 'wpUltimateParam' )
804 && is_null( $this->edittime
) );
806 if ( $this->incompleteForm
) {
807 # If the form is incomplete, force to preview.
808 wfDebug( __METHOD__
. ": Form data appears to be incomplete\n" );
809 wfDebug( "POST DATA: " . var_export( $_POST, true ) . "\n" );
810 $this->preview
= true;
812 /* Fallback for live preview */
813 $this->preview
= $request->getCheck( 'wpPreview' ) ||
$request->getCheck( 'wpLivePreview' );
814 $this->diff
= $request->getCheck( 'wpDiff' );
816 // Remember whether a save was requested, so we can indicate
817 // if we forced preview due to session failure.
818 $this->mTriedSave
= !$this->preview
;
820 if ( $this->tokenOk( $request ) ) {
821 # Some browsers will not report any submit button
822 # if the user hits enter in the comment box.
823 # The unmarked state will be assumed to be a save,
824 # if the form seems otherwise complete.
825 wfDebug( __METHOD__
. ": Passed token check.\n" );
826 } elseif ( $this->diff
) {
827 # Failed token check, but only requested "Show Changes".
828 wfDebug( __METHOD__
. ": Failed token check; Show Changes requested.\n" );
830 # Page might be a hack attempt posted from
831 # an external site. Preview instead of saving.
832 wfDebug( __METHOD__
. ": Failed token check; forcing preview\n" );
833 $this->preview
= true;
836 $this->save
= !$this->preview
&& !$this->diff
;
837 if ( !preg_match( '/^\d{14}$/', $this->edittime
) ) {
838 $this->edittime
= null;
841 if ( !preg_match( '/^\d{14}$/', $this->starttime
) ) {
842 $this->starttime
= null;
845 $this->recreate
= $request->getCheck( 'wpRecreate' );
847 $this->minoredit
= $request->getCheck( 'wpMinoredit' );
848 $this->watchthis
= $request->getCheck( 'wpWatchthis' );
850 # Don't force edit summaries when a user is editing their own user or talk page
851 if ( ( $this->mTitle
->mNamespace
== NS_USER ||
$this->mTitle
->mNamespace
== NS_USER_TALK
)
852 && $this->mTitle
->getText() == $wgUser->getName()
854 $this->allowBlankSummary
= true;
856 $this->allowBlankSummary
= $request->getBool( 'wpIgnoreBlankSummary' )
857 ||
!$wgUser->getOption( 'forceeditsummary' );
860 $this->autoSumm
= $request->getText( 'wpAutoSummary' );
862 $this->allowBlankArticle
= $request->getBool( 'wpIgnoreBlankArticle' );
863 $this->allowSelfRedirect
= $request->getBool( 'wpIgnoreSelfRedirect' );
865 # Not a posted form? Start with nothing.
866 wfDebug( __METHOD__
. ": Not a posted form.\n" );
867 $this->textbox1
= '';
869 $this->sectiontitle
= '';
870 $this->edittime
= '';
871 $this->starttime
= wfTimestampNow();
873 $this->preview
= false;
876 $this->minoredit
= false;
877 // Watch may be overridden by request parameters
878 $this->watchthis
= $request->getBool( 'watchthis', false );
879 $this->recreate
= false;
881 // When creating a new section, we can preload a section title by passing it as the
882 // preloadtitle parameter in the URL (Bug 13100)
883 if ( $this->section
== 'new' && $request->getVal( 'preloadtitle' ) ) {
884 $this->sectiontitle
= $request->getVal( 'preloadtitle' );
885 // Once wpSummary isn't being use for setting section titles, we should delete this.
886 $this->summary
= $request->getVal( 'preloadtitle' );
887 } elseif ( $this->section
!= 'new' && $request->getVal( 'summary' ) ) {
888 $this->summary
= $request->getText( 'summary' );
889 if ( $this->summary
!== '' ) {
890 $this->hasPresetSummary
= true;
894 if ( $request->getVal( 'minor' ) ) {
895 $this->minoredit
= true;
899 $this->oldid
= $request->getInt( 'oldid' );
900 $this->parentRevId
= $request->getInt( 'parentRevId' );
902 $this->bot
= $request->getBool( 'bot', true );
903 $this->nosummary
= $request->getBool( 'nosummary' );
905 // May be overridden by revision.
906 $this->contentModel
= $request->getText( 'model', $this->contentModel
);
907 // May be overridden by revision.
908 $this->contentFormat
= $request->getText( 'format', $this->contentFormat
);
910 if ( !ContentHandler
::getForModelID( $this->contentModel
)
911 ->isSupportedFormat( $this->contentFormat
)
913 throw new ErrorPageError(
914 'editpage-notsupportedcontentformat-title',
915 'editpage-notsupportedcontentformat-text',
916 array( $this->contentFormat
, ContentHandler
::getLocalizedName( $this->contentModel
) )
921 * @todo Check if the desired model is allowed in this namespace, and if
922 * a transition from the page's current model to the new model is
926 $this->live
= $request->getCheck( 'live' );
927 $this->editintro
= $request->getText( 'editintro',
928 // Custom edit intro for new sections
929 $this->section
=== 'new' ?
'MediaWiki:addsection-editintro' : '' );
931 // Allow extensions to modify form data
932 Hooks
::run( 'EditPage::importFormData', array( $this, $request ) );
934 wfProfileOut( __METHOD__
);
938 * Subpage overridable method for extracting the page content data from the
939 * posted form to be placed in $this->textbox1, if using customized input
940 * this method should be overridden and return the page text that will be used
941 * for saving, preview parsing and so on...
943 * @param WebRequest $request
945 protected function importContentFormData( &$request ) {
946 return; // Don't do anything, EditPage already extracted wpTextbox1
950 * Initialise form fields in the object
951 * Called on the first invocation, e.g. when a user clicks an edit link
952 * @return bool If the requested section is valid
954 function initialiseForm() {
956 $this->edittime
= $this->mArticle
->getTimestamp();
958 $content = $this->getContentObject( false ); #TODO: track content object?!
959 if ( $content === false ) {
962 $this->textbox1
= $this->toEditText( $content );
964 // activate checkboxes if user wants them to be always active
965 # Sort out the "watch" checkbox
966 if ( $wgUser->getOption( 'watchdefault' ) ) {
968 $this->watchthis
= true;
969 } elseif ( $wgUser->getOption( 'watchcreations' ) && !$this->mTitle
->exists() ) {
971 $this->watchthis
= true;
972 } elseif ( $wgUser->isWatched( $this->mTitle
) ) {
974 $this->watchthis
= true;
976 if ( $wgUser->getOption( 'minordefault' ) && !$this->isNew
) {
977 $this->minoredit
= true;
979 if ( $this->textbox1
=== false ) {
986 * @param Content|null $def_content The default value to return
988 * @return Content|null Content on success, $def_content for invalid sections
992 protected function getContentObject( $def_content = null ) {
993 global $wgOut, $wgRequest, $wgUser, $wgContLang;
995 wfProfileIn( __METHOD__
);
999 // For message page not locally set, use the i18n message.
1000 // For other non-existent articles, use preload text if any.
1001 if ( !$this->mTitle
->exists() ||
$this->section
== 'new' ) {
1002 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
&& $this->section
!= 'new' ) {
1003 # If this is a system message, get the default text.
1004 $msg = $this->mTitle
->getDefaultMessageText();
1006 $content = $this->toEditContent( $msg );
1008 if ( $content === false ) {
1009 # If requested, preload some text.
1010 $preload = $wgRequest->getVal( 'preload',
1011 // Custom preload text for new sections
1012 $this->section
=== 'new' ?
'MediaWiki:addsection-preload' : '' );
1013 $params = $wgRequest->getArray( 'preloadparams', array() );
1015 $content = $this->getPreloadedContent( $preload, $params );
1017 // For existing pages, get text based on "undo" or section parameters.
1019 if ( $this->section
!= '' ) {
1020 // Get section edit text (returns $def_text for invalid sections)
1021 $orig = $this->getOriginalContent( $wgUser );
1022 $content = $orig ?
$orig->getSection( $this->section
) : null;
1025 $content = $def_content;
1028 $undoafter = $wgRequest->getInt( 'undoafter' );
1029 $undo = $wgRequest->getInt( 'undo' );
1031 if ( $undo > 0 && $undoafter > 0 ) {
1033 $undorev = Revision
::newFromId( $undo );
1034 $oldrev = Revision
::newFromId( $undoafter );
1036 # Sanity check, make sure it's the right page,
1037 # the revisions exist and they were not deleted.
1038 # Otherwise, $content will be left as-is.
1039 if ( !is_null( $undorev ) && !is_null( $oldrev ) &&
1040 !$undorev->isDeleted( Revision
::DELETED_TEXT
) &&
1041 !$oldrev->isDeleted( Revision
::DELETED_TEXT
) ) {
1043 $content = $this->mArticle
->getUndoContent( $undorev, $oldrev );
1045 if ( $content === false ) {
1046 # Warn the user that something went wrong
1047 $undoMsg = 'failure';
1049 $oldContent = $this->mArticle
->getPage()->getContent( Revision
::RAW
);
1050 $popts = ParserOptions
::newFromUserAndLang( $wgUser, $wgContLang );
1051 $newContent = $content->preSaveTransform( $this->mTitle
, $wgUser, $popts );
1053 if ( $newContent->equals( $oldContent ) ) {
1054 # Tell the user that the undo results in no change,
1055 # i.e. the revisions were already undone.
1056 $undoMsg = 'nochange';
1059 # Inform the user of our success and set an automatic edit summary
1060 $undoMsg = 'success';
1062 # If we just undid one rev, use an autosummary
1063 $firstrev = $oldrev->getNext();
1064 if ( $firstrev && $firstrev->getId() == $undo ) {
1065 $userText = $undorev->getUserText();
1066 if ( $userText === '' ) {
1067 $undoSummary = wfMessage(
1068 'undo-summary-username-hidden',
1070 )->inContentLanguage()->text();
1072 $undoSummary = wfMessage(
1076 )->inContentLanguage()->text();
1078 if ( $this->summary
=== '' ) {
1079 $this->summary
= $undoSummary;
1081 $this->summary
= $undoSummary . wfMessage( 'colon-separator' )
1082 ->inContentLanguage()->text() . $this->summary
;
1084 $this->undidRev
= $undo;
1086 $this->formtype
= 'diff';
1090 // Failed basic sanity checks.
1091 // Older revisions may have been removed since the link
1092 // was created, or we may simply have got bogus input.
1096 // Messages: undo-success, undo-failure, undo-norev, undo-nochange
1097 $class = ( $undoMsg == 'success' ?
'' : 'error ' ) . "mw-undo-{$undoMsg}";
1098 $this->editFormPageTop
.= $wgOut->parse( "<div class=\"{$class}\">" .
1099 wfMessage( 'undo-' . $undoMsg )->plain() . '</div>', true, /* interface */true );
1102 if ( $content === false ) {
1103 $content = $this->getOriginalContent( $wgUser );
1108 wfProfileOut( __METHOD__
);
1113 * Get the content of the wanted revision, without section extraction.
1115 * The result of this function can be used to compare user's input with
1116 * section replaced in its context (using WikiPage::replaceSection())
1117 * to the original text of the edit.
1119 * This differs from Article::getContent() that when a missing revision is
1120 * encountered the result will be null and not the
1121 * 'missing-revision' message.
1124 * @param User $user The user to get the revision for
1125 * @return Content|null
1127 private function getOriginalContent( User
$user ) {
1128 if ( $this->section
== 'new' ) {
1129 return $this->getCurrentContent();
1131 $revision = $this->mArticle
->getRevisionFetched();
1132 if ( $revision === null ) {
1133 if ( !$this->contentModel
) {
1134 $this->contentModel
= $this->getTitle()->getContentModel();
1136 $handler = ContentHandler
::getForModelID( $this->contentModel
);
1138 return $handler->makeEmptyContent();
1140 $content = $revision->getContent( Revision
::FOR_THIS_USER
, $user );
1145 * Get the current content of the page. This is basically similar to
1146 * WikiPage::getContent( Revision::RAW ) except that when the page doesn't exist an empty
1147 * content object is returned instead of null.
1152 protected function getCurrentContent() {
1153 $rev = $this->mArticle
->getRevision();
1154 $content = $rev ?
$rev->getContent( Revision
::RAW
) : null;
1156 if ( $content === false ||
$content === null ) {
1157 if ( !$this->contentModel
) {
1158 $this->contentModel
= $this->getTitle()->getContentModel();
1160 $handler = ContentHandler
::getForModelID( $this->contentModel
);
1162 return $handler->makeEmptyContent();
1164 # nasty side-effect, but needed for consistency
1165 $this->contentModel
= $rev->getContentModel();
1166 $this->contentFormat
= $rev->getContentFormat();
1173 * Use this method before edit() to preload some content into the edit box
1175 * @param Content $content
1179 public function setPreloadedContent( Content
$content ) {
1180 $this->mPreloadContent
= $content;
1184 * Get the contents to be preloaded into the box, either set by
1185 * an earlier setPreloadText() or by loading the given page.
1187 * @param string $preload Representing the title to preload from.
1188 * @param array $params Parameters to use (interface-message style) in the preloaded text
1194 protected function getPreloadedContent( $preload, $params = array() ) {
1197 if ( !empty( $this->mPreloadContent
) ) {
1198 return $this->mPreloadContent
;
1201 $handler = ContentHandler
::getForTitle( $this->getTitle() );
1203 if ( $preload === '' ) {
1204 return $handler->makeEmptyContent();
1207 $title = Title
::newFromText( $preload );
1208 # Check for existence to avoid getting MediaWiki:Noarticletext
1209 if ( $title === null ||
!$title->exists() ||
!$title->userCan( 'read', $wgUser ) ) {
1210 //TODO: somehow show a warning to the user!
1211 return $handler->makeEmptyContent();
1214 $page = WikiPage
::factory( $title );
1215 if ( $page->isRedirect() ) {
1216 $title = $page->getRedirectTarget();
1218 if ( $title === null ||
!$title->exists() ||
!$title->userCan( 'read', $wgUser ) ) {
1219 //TODO: somehow show a warning to the user!
1220 return $handler->makeEmptyContent();
1222 $page = WikiPage
::factory( $title );
1225 $parserOptions = ParserOptions
::newFromUser( $wgUser );
1226 $content = $page->getContent( Revision
::RAW
);
1229 //TODO: somehow show a warning to the user!
1230 return $handler->makeEmptyContent();
1233 if ( $content->getModel() !== $handler->getModelID() ) {
1234 $converted = $content->convert( $handler->getModelID() );
1236 if ( !$converted ) {
1237 //TODO: somehow show a warning to the user!
1238 wfDebug( "Attempt to preload incompatible content: "
1239 . "can't convert " . $content->getModel()
1240 . " to " . $handler->getModelID() );
1242 return $handler->makeEmptyContent();
1245 $content = $converted;
1248 return $content->preloadTransform( $title, $parserOptions, $params );
1252 * Make sure the form isn't faking a user's credentials.
1254 * @param WebRequest $request
1258 function tokenOk( &$request ) {
1260 $token = $request->getVal( 'wpEditToken' );
1261 $this->mTokenOk
= $wgUser->matchEditToken( $token );
1262 $this->mTokenOkExceptSuffix
= $wgUser->matchEditTokenNoSuffix( $token );
1263 return $this->mTokenOk
;
1267 * Sets post-edit cookie indicating the user just saved a particular revision.
1269 * This uses a temporary cookie for each revision ID so separate saves will never
1270 * interfere with each other.
1272 * The cookie is deleted in the mediawiki.action.view.postEdit JS module after
1273 * the redirect. It must be clearable by JavaScript code, so it must not be
1274 * marked HttpOnly. The JavaScript code converts the cookie to a wgPostEdit config
1277 * If the variable were set on the server, it would be cached, which is unwanted
1278 * since the post-edit state should only apply to the load right after the save.
1280 * @param int $statusValue The status value (to check for new article status)
1282 protected function setPostEditCookie( $statusValue ) {
1283 $revisionId = $this->mArticle
->getLatest();
1284 $postEditKey = self
::POST_EDIT_COOKIE_KEY_PREFIX
. $revisionId;
1287 if ( $statusValue == self
::AS_SUCCESS_NEW_ARTICLE
) {
1289 } elseif ( $this->oldid
) {
1293 $response = RequestContext
::getMain()->getRequest()->response();
1294 $response->setcookie( $postEditKey, $val, time() + self
::POST_EDIT_COOKIE_DURATION
, array(
1295 'httpOnly' => false,
1300 * Attempt submission
1301 * @throws UserBlockedError|ReadOnlyError|ThrottledError|PermissionsError
1302 * @return bool False if output is done, true if the rest of the form should be displayed
1304 public function attemptSave() {
1307 $resultDetails = false;
1308 # Allow bots to exempt some edits from bot flagging
1309 $bot = $wgUser->isAllowed( 'bot' ) && $this->bot
;
1310 $status = $this->internalAttemptSave( $resultDetails, $bot );
1312 return $this->handleStatus( $status, $resultDetails );
1316 * Handle status, such as after attempt save
1318 * @param Status $status
1319 * @param array|bool $resultDetails
1321 * @throws ErrorPageError
1322 * @return bool False, if output is done, true if rest of the form should be displayed
1324 private function handleStatus( Status
$status, $resultDetails ) {
1325 global $wgUser, $wgOut;
1328 * @todo FIXME: once the interface for internalAttemptSave() is made
1329 * nicer, this should use the message in $status
1331 if ( $status->value
== self
::AS_SUCCESS_UPDATE
1332 ||
$status->value
== self
::AS_SUCCESS_NEW_ARTICLE
1334 $this->didSave
= true;
1335 if ( !$resultDetails['nullEdit'] ) {
1336 $this->setPostEditCookie( $status->value
);
1340 switch ( $status->value
) {
1341 case self
::AS_HOOK_ERROR_EXPECTED
:
1342 case self
::AS_CONTENT_TOO_BIG
:
1343 case self
::AS_ARTICLE_WAS_DELETED
:
1344 case self
::AS_CONFLICT_DETECTED
:
1345 case self
::AS_SUMMARY_NEEDED
:
1346 case self
::AS_TEXTBOX_EMPTY
:
1347 case self
::AS_MAX_ARTICLE_SIZE_EXCEEDED
:
1349 case self
::AS_BLANK_ARTICLE
:
1350 case self
::AS_SELF_REDIRECT
:
1353 case self
::AS_HOOK_ERROR
:
1356 case self
::AS_PARSE_ERROR
:
1357 $wgOut->addWikiText( '<div class="error">' . $status->getWikiText() . '</div>' );
1360 case self
::AS_SUCCESS_NEW_ARTICLE
:
1361 $query = $resultDetails['redirect'] ?
'redirect=no' : '';
1362 $anchor = isset( $resultDetails['sectionanchor'] ) ?
$resultDetails['sectionanchor'] : '';
1363 $wgOut->redirect( $this->mTitle
->getFullURL( $query ) . $anchor );
1366 case self
::AS_SUCCESS_UPDATE
:
1368 $sectionanchor = $resultDetails['sectionanchor'];
1370 // Give extensions a chance to modify URL query on update
1372 'ArticleUpdateBeforeRedirect',
1373 array( $this->mArticle
, &$sectionanchor, &$extraQuery )
1376 if ( $resultDetails['redirect'] ) {
1377 if ( $extraQuery == '' ) {
1378 $extraQuery = 'redirect=no';
1380 $extraQuery = 'redirect=no&' . $extraQuery;
1383 $wgOut->redirect( $this->mTitle
->getFullURL( $extraQuery ) . $sectionanchor );
1386 case self
::AS_SPAM_ERROR
:
1387 $this->spamPageWithContent( $resultDetails['spam'] );
1390 case self
::AS_BLOCKED_PAGE_FOR_USER
:
1391 throw new UserBlockedError( $wgUser->getBlock() );
1393 case self
::AS_IMAGE_REDIRECT_ANON
:
1394 case self
::AS_IMAGE_REDIRECT_LOGGED
:
1395 throw new PermissionsError( 'upload' );
1397 case self
::AS_READ_ONLY_PAGE_ANON
:
1398 case self
::AS_READ_ONLY_PAGE_LOGGED
:
1399 throw new PermissionsError( 'edit' );
1401 case self
::AS_READ_ONLY_PAGE
:
1402 throw new ReadOnlyError
;
1404 case self
::AS_RATE_LIMITED
:
1405 throw new ThrottledError();
1407 case self
::AS_NO_CREATE_PERMISSION
:
1408 $permission = $this->mTitle
->isTalkPage() ?
'createtalk' : 'createpage';
1409 throw new PermissionsError( $permission );
1411 case self
::AS_NO_CHANGE_CONTENT_MODEL
:
1412 throw new PermissionsError( 'editcontentmodel' );
1415 // We don't recognize $status->value. The only way that can happen
1416 // is if an extension hook aborted from inside ArticleSave.
1417 // Render the status object into $this->hookError
1418 // FIXME this sucks, we should just use the Status object throughout
1419 $this->hookError
= '<div class="error">' . $status->getWikitext() .
1426 * Run hooks that can filter edits just before they get saved.
1428 * @param Content $content The Content to filter.
1429 * @param Status $status For reporting the outcome to the caller
1430 * @param User $user The user performing the edit
1434 protected function runPostMergeFilters( Content
$content, Status
$status, User
$user ) {
1435 // Run old style post-section-merge edit filter
1436 if ( !ContentHandler
::runLegacyHooks( 'EditFilterMerged',
1437 array( $this, $content, &$this->hookError
, $this->summary
) )
1439 # Error messages etc. could be handled within the hook...
1440 $status->fatal( 'hookaborted' );
1441 $status->value
= self
::AS_HOOK_ERROR
;
1443 } elseif ( $this->hookError
!= '' ) {
1444 # ...or the hook could be expecting us to produce an error
1445 $status->fatal( 'hookaborted' );
1446 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1450 // Run new style post-section-merge edit filter
1451 if ( !Hooks
::run( 'EditFilterMergedContent',
1452 array( $this->mArticle
->getContext(), $content, $status, $this->summary
,
1453 $user, $this->minoredit
) )
1455 # Error messages etc. could be handled within the hook...
1456 if ( $status->isGood() ) {
1457 $status->fatal( 'hookaborted' );
1458 // Not setting $this->hookError here is a hack to allow the hook
1459 // to cause a return to the edit page without $this->hookError
1460 // being set. This is used by ConfirmEdit to display a captcha
1461 // without any error message cruft.
1463 $this->hookError
= $status->getWikiText();
1465 // Use the existing $status->value if the hook set it
1466 if ( !$status->value
) {
1467 $status->value
= self
::AS_HOOK_ERROR
;
1470 } elseif ( !$status->isOK() ) {
1471 # ...or the hook could be expecting us to produce an error
1472 // FIXME this sucks, we should just use the Status object throughout
1473 $this->hookError
= $status->getWikiText();
1474 $status->fatal( 'hookaborted' );
1475 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1483 * Return the summary to be used for a new section.
1485 * @param string $sectionanchor Set to the section anchor text
1488 private function newSectionSummary( &$sectionanchor = null ) {
1491 if ( $this->sectiontitle
!== '' ) {
1492 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $this->sectiontitle
);
1493 // If no edit summary was specified, create one automatically from the section
1494 // title and have it link to the new section. Otherwise, respect the summary as
1496 if ( $this->summary
=== '' ) {
1497 $cleanSectionTitle = $wgParser->stripSectionName( $this->sectiontitle
);
1498 return wfMessage( 'newsectionsummary' )
1499 ->rawParams( $cleanSectionTitle )->inContentLanguage()->text();
1501 } elseif ( $this->summary
!== '' ) {
1502 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $this->summary
);
1503 # This is a new section, so create a link to the new section
1504 # in the revision summary.
1505 $cleanSummary = $wgParser->stripSectionName( $this->summary
);
1506 return wfMessage( 'newsectionsummary' )
1507 ->rawParams( $cleanSummary )->inContentLanguage()->text();
1509 return $this->summary
;
1513 * Attempt submission (no UI)
1515 * @param array $result Array to add statuses to, currently with the
1517 * - spam (string): Spam string from content if any spam is detected by
1519 * - sectionanchor (string): Section anchor for a section save.
1520 * - nullEdit (boolean): Set if doEditContent is OK. True if null edit,
1522 * - redirect (bool): Set if doEditContent is OK. True if resulting
1523 * revision is a redirect.
1524 * @param bool $bot True if edit is being made under the bot right.
1526 * @return Status Status object, possibly with a message, but always with
1527 * one of the AS_* constants in $status->value,
1529 * @todo FIXME: This interface is TERRIBLE, but hard to get rid of due to
1530 * various error display idiosyncrasies. There are also lots of cases
1531 * where error metadata is set in the object and retrieved later instead
1532 * of being returned, e.g. AS_CONTENT_TOO_BIG and
1533 * AS_BLOCKED_PAGE_FOR_USER. All that stuff needs to be cleaned up some
1536 function internalAttemptSave( &$result, $bot = false ) {
1537 global $wgUser, $wgRequest, $wgParser, $wgMaxArticleSize;
1539 $status = Status
::newGood();
1541 wfProfileIn( __METHOD__
);
1542 wfProfileIn( __METHOD__
. '-checks' );
1544 if ( !Hooks
::run( 'EditPage::attemptSave', array( $this ) ) ) {
1545 wfDebug( "Hook 'EditPage::attemptSave' aborted article saving\n" );
1546 $status->fatal( 'hookaborted' );
1547 $status->value
= self
::AS_HOOK_ERROR
;
1548 wfProfileOut( __METHOD__
. '-checks' );
1549 wfProfileOut( __METHOD__
);
1553 $spam = $wgRequest->getText( 'wpAntispam' );
1554 if ( $spam !== '' ) {
1557 $wgUser->getName() .
1559 $this->mTitle
->getPrefixedText() .
1560 '" submitted bogus field "' .
1564 $status->fatal( 'spamprotectionmatch', false );
1565 $status->value
= self
::AS_SPAM_ERROR
;
1566 wfProfileOut( __METHOD__
. '-checks' );
1567 wfProfileOut( __METHOD__
);
1572 # Construct Content object
1573 $textbox_content = $this->toEditContent( $this->textbox1
);
1574 } catch ( MWContentSerializationException
$ex ) {
1576 'content-failed-to-parse',
1577 $this->contentModel
,
1578 $this->contentFormat
,
1581 $status->value
= self
::AS_PARSE_ERROR
;
1582 wfProfileOut( __METHOD__
. '-checks' );
1583 wfProfileOut( __METHOD__
);
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 );
1595 wfProfileOut( __METHOD__
. '-checks' );
1596 wfProfileOut( __METHOD__
);
1602 $match = self
::matchSummarySpamRegex( $this->summary
);
1603 if ( $match === false && $this->section
== 'new' ) {
1604 # $wgSpamRegex is enforced on this new heading/summary because, unlike
1605 # regular summaries, it is added to the actual wikitext.
1606 if ( $this->sectiontitle
!== '' ) {
1607 # This branch is taken when the API is used with the 'sectiontitle' parameter.
1608 $match = self
::matchSpamRegex( $this->sectiontitle
);
1610 # This branch is taken when the "Add Topic" user interface is used, or the API
1611 # is used with the 'summary' parameter.
1612 $match = self
::matchSpamRegex( $this->summary
);
1615 if ( $match === false ) {
1616 $match = self
::matchSpamRegex( $this->textbox1
);
1618 if ( $match !== false ) {
1619 $result['spam'] = $match;
1620 $ip = $wgRequest->getIP();
1621 $pdbk = $this->mTitle
->getPrefixedDBkey();
1622 $match = str_replace( "\n", '', $match );
1623 wfDebugLog( 'SpamRegex', "$ip spam regex hit [[$pdbk]]: \"$match\"" );
1624 $status->fatal( 'spamprotectionmatch', $match );
1625 $status->value
= self
::AS_SPAM_ERROR
;
1626 wfProfileOut( __METHOD__
. '-checks' );
1627 wfProfileOut( __METHOD__
);
1632 array( $this, $this->textbox1
, $this->section
, &$this->hookError
, $this->summary
) )
1634 # Error messages etc. could be handled within the hook...
1635 $status->fatal( 'hookaborted' );
1636 $status->value
= self
::AS_HOOK_ERROR
;
1637 wfProfileOut( __METHOD__
. '-checks' );
1638 wfProfileOut( __METHOD__
);
1640 } elseif ( $this->hookError
!= '' ) {
1641 # ...or the hook could be expecting us to produce an error
1642 $status->fatal( 'hookaborted' );
1643 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1644 wfProfileOut( __METHOD__
. '-checks' );
1645 wfProfileOut( __METHOD__
);
1649 if ( $wgUser->isBlockedFrom( $this->mTitle
, false ) ) {
1650 // Auto-block user's IP if the account was "hard" blocked
1651 $wgUser->spreadAnyEditBlock();
1652 # Check block state against master, thus 'false'.
1653 $status->setResult( false, self
::AS_BLOCKED_PAGE_FOR_USER
);
1654 wfProfileOut( __METHOD__
. '-checks' );
1655 wfProfileOut( __METHOD__
);
1659 $this->kblength
= (int)( strlen( $this->textbox1
) / 1024 );
1660 if ( $this->kblength
> $wgMaxArticleSize ) {
1661 // Error will be displayed by showEditForm()
1662 $this->tooBig
= true;
1663 $status->setResult( false, self
::AS_CONTENT_TOO_BIG
);
1664 wfProfileOut( __METHOD__
. '-checks' );
1665 wfProfileOut( __METHOD__
);
1669 if ( !$wgUser->isAllowed( 'edit' ) ) {
1670 if ( $wgUser->isAnon() ) {
1671 $status->setResult( false, self
::AS_READ_ONLY_PAGE_ANON
);
1672 wfProfileOut( __METHOD__
. '-checks' );
1673 wfProfileOut( __METHOD__
);
1676 $status->fatal( 'readonlytext' );
1677 $status->value
= self
::AS_READ_ONLY_PAGE_LOGGED
;
1678 wfProfileOut( __METHOD__
. '-checks' );
1679 wfProfileOut( __METHOD__
);
1684 if ( $this->contentModel
!== $this->mTitle
->getContentModel()
1685 && !$wgUser->isAllowed( 'editcontentmodel' )
1687 $status->setResult( false, self
::AS_NO_CHANGE_CONTENT_MODEL
);
1688 wfProfileOut( __METHOD__
. '-checks' );
1689 wfProfileOut( __METHOD__
);
1693 if ( wfReadOnly() ) {
1694 $status->fatal( 'readonlytext' );
1695 $status->value
= self
::AS_READ_ONLY_PAGE
;
1696 wfProfileOut( __METHOD__
. '-checks' );
1697 wfProfileOut( __METHOD__
);
1700 if ( $wgUser->pingLimiter() ||
$wgUser->pingLimiter( 'linkpurge', 0 ) ) {
1701 $status->fatal( 'actionthrottledtext' );
1702 $status->value
= self
::AS_RATE_LIMITED
;
1703 wfProfileOut( __METHOD__
. '-checks' );
1704 wfProfileOut( __METHOD__
);
1708 # If the article has been deleted while editing, don't save it without
1710 if ( $this->wasDeletedSinceLastEdit() && !$this->recreate
) {
1711 $status->setResult( false, self
::AS_ARTICLE_WAS_DELETED
);
1712 wfProfileOut( __METHOD__
. '-checks' );
1713 wfProfileOut( __METHOD__
);
1717 wfProfileOut( __METHOD__
. '-checks' );
1719 # Load the page data from the master. If anything changes in the meantime,
1720 # we detect it by using page_latest like a token in a 1 try compare-and-swap.
1721 $this->mArticle
->loadPageData( 'fromdbmaster' );
1722 $new = !$this->mArticle
->exists();
1725 // Late check for create permission, just in case *PARANOIA*
1726 if ( !$this->mTitle
->userCan( 'create', $wgUser ) ) {
1727 $status->fatal( 'nocreatetext' );
1728 $status->value
= self
::AS_NO_CREATE_PERMISSION
;
1729 wfDebug( __METHOD__
. ": no create permission\n" );
1730 wfProfileOut( __METHOD__
);
1734 // Don't save a new page if it's blank or if it's a MediaWiki:
1735 // message with content equivalent to default (allow empty pages
1736 // in this case to disable messages, see bug 50124)
1737 $defaultMessageText = $this->mTitle
->getDefaultMessageText();
1738 if ( $this->mTitle
->getNamespace() === NS_MEDIAWIKI
&& $defaultMessageText !== false ) {
1739 $defaultText = $defaultMessageText;
1744 if ( !$this->allowBlankArticle
&& $this->textbox1
=== $defaultText ) {
1745 $this->blankArticle
= true;
1746 $status->fatal( 'blankarticle' );
1747 $status->setResult( false, self
::AS_BLANK_ARTICLE
);
1748 wfProfileOut( __METHOD__
);
1752 if ( !$this->runPostMergeFilters( $textbox_content, $status, $wgUser ) ) {
1753 wfProfileOut( __METHOD__
);
1757 $content = $textbox_content;
1759 $result['sectionanchor'] = '';
1760 if ( $this->section
== 'new' ) {
1761 if ( $this->sectiontitle
!== '' ) {
1762 // Insert the section title above the content.
1763 $content = $content->addSectionHeader( $this->sectiontitle
);
1764 } elseif ( $this->summary
!== '' ) {
1765 // Insert the section title above the content.
1766 $content = $content->addSectionHeader( $this->summary
);
1768 $this->summary
= $this->newSectionSummary( $result['sectionanchor'] );
1771 $status->value
= self
::AS_SUCCESS_NEW_ARTICLE
;
1775 # Article exists. Check for edit conflict.
1777 $this->mArticle
->clear(); # Force reload of dates, etc.
1778 $timestamp = $this->mArticle
->getTimestamp();
1780 wfDebug( "timestamp: {$timestamp}, edittime: {$this->edittime}\n" );
1782 if ( $timestamp != $this->edittime
) {
1783 $this->isConflict
= true;
1784 if ( $this->section
== 'new' ) {
1785 if ( $this->mArticle
->getUserText() == $wgUser->getName() &&
1786 $this->mArticle
->getComment() == $this->newSectionSummary()
1788 // Probably a duplicate submission of a new comment.
1789 // This can happen when squid resends a request after
1790 // a timeout but the first one actually went through.
1792 . ": duplicate new section submission; trigger edit conflict!\n" );
1794 // New comment; suppress conflict.
1795 $this->isConflict
= false;
1796 wfDebug( __METHOD__
. ": conflict suppressed; new section\n" );
1798 } elseif ( $this->section
== ''
1799 && Revision
::userWasLastToEdit(
1800 DB_MASTER
, $this->mTitle
->getArticleID(),
1801 $wgUser->getId(), $this->edittime
1804 # Suppress edit conflict with self, except for section edits where merging is required.
1805 wfDebug( __METHOD__
. ": Suppressing edit conflict, same user.\n" );
1806 $this->isConflict
= false;
1810 // If sectiontitle is set, use it, otherwise use the summary as the section title.
1811 if ( $this->sectiontitle
!== '' ) {
1812 $sectionTitle = $this->sectiontitle
;
1814 $sectionTitle = $this->summary
;
1819 if ( $this->isConflict
) {
1821 . ": conflict! getting section '{$this->section}' for time '{$this->edittime}'"
1822 . " (article time '{$timestamp}')\n" );
1824 $content = $this->mArticle
->replaceSectionContent(
1831 wfDebug( __METHOD__
. ": getting section '{$this->section}'\n" );
1832 $content = $this->mArticle
->replaceSectionContent(
1839 if ( is_null( $content ) ) {
1840 wfDebug( __METHOD__
. ": activating conflict; section replace failed.\n" );
1841 $this->isConflict
= true;
1842 $content = $textbox_content; // do not try to merge here!
1843 } elseif ( $this->isConflict
) {
1845 if ( $this->mergeChangesIntoContent( $content ) ) {
1846 // Successful merge! Maybe we should tell the user the good news?
1847 $this->isConflict
= false;
1848 wfDebug( __METHOD__
. ": Suppressing edit conflict, successful merge.\n" );
1850 $this->section
= '';
1851 $this->textbox1
= ContentHandler
::getContentText( $content );
1852 wfDebug( __METHOD__
. ": Keeping edit conflict, failed merge.\n" );
1856 if ( $this->isConflict
) {
1857 $status->setResult( false, self
::AS_CONFLICT_DETECTED
);
1858 wfProfileOut( __METHOD__
);
1862 if ( !$this->runPostMergeFilters( $content, $status, $wgUser ) ) {
1863 wfProfileOut( __METHOD__
);
1867 if ( $this->section
== 'new' ) {
1868 // Handle the user preference to force summaries here
1869 if ( !$this->allowBlankSummary
&& trim( $this->summary
) == '' ) {
1870 $this->missingSummary
= true;
1871 $status->fatal( 'missingsummary' ); // or 'missingcommentheader' if $section == 'new'. Blegh
1872 $status->value
= self
::AS_SUMMARY_NEEDED
;
1873 wfProfileOut( __METHOD__
);
1877 // Do not allow the user to post an empty comment
1878 if ( $this->textbox1
== '' ) {
1879 $this->missingComment
= true;
1880 $status->fatal( 'missingcommenttext' );
1881 $status->value
= self
::AS_TEXTBOX_EMPTY
;
1882 wfProfileOut( __METHOD__
);
1885 } elseif ( !$this->allowBlankSummary
1886 && !$content->equals( $this->getOriginalContent( $wgUser ) )
1887 && !$content->isRedirect()
1888 && md5( $this->summary
) == $this->autoSumm
1890 $this->missingSummary
= true;
1891 $status->fatal( 'missingsummary' );
1892 $status->value
= self
::AS_SUMMARY_NEEDED
;
1893 wfProfileOut( __METHOD__
);
1898 wfProfileIn( __METHOD__
. '-sectionanchor' );
1899 $sectionanchor = '';
1900 if ( $this->section
== 'new' ) {
1901 $this->summary
= $this->newSectionSummary( $sectionanchor );
1902 } elseif ( $this->section
!= '' ) {
1903 # Try to get a section anchor from the section source, redirect
1904 # to edited section if header found.
1905 # XXX: Might be better to integrate this into Article::replaceSection
1906 # for duplicate heading checking and maybe parsing.
1907 $hasmatch = preg_match( "/^ *([=]{1,6})(.*?)(\\1) *\\n/i", $this->textbox1
, $matches );
1908 # We can't deal with anchors, includes, html etc in the header for now,
1909 # headline would need to be parsed to improve this.
1910 if ( $hasmatch && strlen( $matches[2] ) > 0 ) {
1911 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $matches[2] );
1914 $result['sectionanchor'] = $sectionanchor;
1915 wfProfileOut( __METHOD__
. '-sectionanchor' );
1917 // Save errors may fall down to the edit form, but we've now
1918 // merged the section into full text. Clear the section field
1919 // so that later submission of conflict forms won't try to
1920 // replace that into a duplicated mess.
1921 $this->textbox1
= $this->toEditText( $content );
1922 $this->section
= '';
1924 $status->value
= self
::AS_SUCCESS_UPDATE
;
1927 if ( !$this->allowSelfRedirect
1928 && $content->isRedirect()
1929 && $content->getRedirectTarget()->equals( $this->getTitle() )
1931 // If the page already redirects to itself, don't warn.
1932 $currentTarget = $this->getCurrentContent()->getRedirectTarget();
1933 if ( !$currentTarget ||
!$currentTarget->equals( $this->getTitle() ) ) {
1934 $this->selfRedirect
= true;
1935 $status->fatal( 'selfredirect' );
1936 $status->value
= self
::AS_SELF_REDIRECT
;
1937 wfProfileOut( __METHOD__
);
1942 // Check for length errors again now that the section is merged in
1943 $this->kblength
= (int)( strlen( $this->toEditText( $content ) ) / 1024 );
1944 if ( $this->kblength
> $wgMaxArticleSize ) {
1945 $this->tooBig
= true;
1946 $status->setResult( false, self
::AS_MAX_ARTICLE_SIZE_EXCEEDED
);
1947 wfProfileOut( __METHOD__
);
1951 $flags = EDIT_DEFER_UPDATES | EDIT_AUTOSUMMARY |
1952 ( $new ? EDIT_NEW
: EDIT_UPDATE
) |
1953 ( ( $this->minoredit
&& !$this->isNew
) ? EDIT_MINOR
: 0 ) |
1954 ( $bot ? EDIT_FORCE_BOT
: 0 );
1956 $doEditStatus = $this->mArticle
->doEditContent(
1962 $content->getDefaultFormat()
1965 if ( !$doEditStatus->isOK() ) {
1966 // Failure from doEdit()
1967 // Show the edit conflict page for certain recognized errors from doEdit(),
1968 // but don't show it for errors from extension hooks
1969 $errors = $doEditStatus->getErrorsArray();
1970 if ( in_array( $errors[0][0],
1971 array( 'edit-gone-missing', 'edit-conflict', 'edit-already-exists' ) )
1973 $this->isConflict
= true;
1974 // Destroys data doEdit() put in $status->value but who cares
1975 $doEditStatus->value
= self
::AS_END
;
1977 wfProfileOut( __METHOD__
);
1978 return $doEditStatus;
1981 $result['nullEdit'] = $doEditStatus->hasMessage( 'edit-no-change' );
1982 if ( $result['nullEdit'] ) {
1983 // We don't know if it was a null edit until now, so increment here
1984 $wgUser->pingLimiter( 'linkpurge' );
1986 $result['redirect'] = $content->isRedirect();
1987 $this->updateWatchlist();
1988 wfProfileOut( __METHOD__
);
1993 * Register the change of watch status
1995 protected function updateWatchlist() {
1998 if ( $wgUser->isLoggedIn()
1999 && $this->watchthis
!= $wgUser->isWatched( $this->mTitle
, WatchedItem
::IGNORE_USER_RIGHTS
)
2001 $fname = __METHOD__
;
2002 $title = $this->mTitle
;
2003 $watch = $this->watchthis
;
2005 // Do this in its own transaction to reduce contention...
2006 $dbw = wfGetDB( DB_MASTER
);
2007 $dbw->onTransactionIdle( function () use ( $dbw, $title, $watch, $wgUser, $fname ) {
2008 WatchAction
::doWatchOrUnwatch( $watch, $title, $wgUser );
2014 * Attempts to do 3-way merge of edit content with a base revision
2015 * and current content, in case of edit conflict, in whichever way appropriate
2016 * for the content type.
2020 * @param Content $editContent
2024 private function mergeChangesIntoContent( &$editContent ) {
2025 wfProfileIn( __METHOD__
);
2027 $db = wfGetDB( DB_MASTER
);
2029 // This is the revision the editor started from
2030 $baseRevision = $this->getBaseRevision();
2031 $baseContent = $baseRevision ?
$baseRevision->getContent() : null;
2033 if ( is_null( $baseContent ) ) {
2034 wfProfileOut( __METHOD__
);
2038 // The current state, we want to merge updates into it
2039 $currentRevision = Revision
::loadFromTitle( $db, $this->mTitle
);
2040 $currentContent = $currentRevision ?
$currentRevision->getContent() : null;
2042 if ( is_null( $currentContent ) ) {
2043 wfProfileOut( __METHOD__
);
2047 $handler = ContentHandler
::getForModelID( $baseContent->getModel() );
2049 $result = $handler->merge3( $baseContent, $editContent, $currentContent );
2052 $editContent = $result;
2053 wfProfileOut( __METHOD__
);
2057 wfProfileOut( __METHOD__
);
2064 function getBaseRevision() {
2065 if ( !$this->mBaseRevision
) {
2066 $db = wfGetDB( DB_MASTER
);
2067 $this->mBaseRevision
= Revision
::loadFromTimestamp(
2068 $db, $this->mTitle
, $this->edittime
);
2070 return $this->mBaseRevision
;
2074 * Check given input text against $wgSpamRegex, and return the text of the first match.
2076 * @param string $text
2078 * @return string|bool Matching string or false
2080 public static function matchSpamRegex( $text ) {
2081 global $wgSpamRegex;
2082 // For back compatibility, $wgSpamRegex may be a single string or an array of regexes.
2083 $regexes = (array)$wgSpamRegex;
2084 return self
::matchSpamRegexInternal( $text, $regexes );
2088 * Check given input text against $wgSummarySpamRegex, and return the text of the first match.
2090 * @param string $text
2092 * @return string|bool Matching string or false
2094 public static function matchSummarySpamRegex( $text ) {
2095 global $wgSummarySpamRegex;
2096 $regexes = (array)$wgSummarySpamRegex;
2097 return self
::matchSpamRegexInternal( $text, $regexes );
2101 * @param string $text
2102 * @param array $regexes
2103 * @return bool|string
2105 protected static function matchSpamRegexInternal( $text, $regexes ) {
2106 foreach ( $regexes as $regex ) {
2108 if ( preg_match( $regex, $text, $matches ) ) {
2115 function setHeaders() {
2116 global $wgOut, $wgUser, $wgAjaxEditStash;
2118 $wgOut->addModules( 'mediawiki.action.edit' );
2119 $wgOut->addModuleStyles( 'mediawiki.action.edit.styles' );
2121 if ( $wgUser->getOption( 'showtoolbar' ) ) {
2122 // The addition of default buttons is handled by getEditToolbar() which
2123 // has its own dependency on this module. The call here ensures the module
2124 // is loaded in time (it has position "top") for other modules to register
2125 // buttons (e.g. extensions, gadgets, user scripts).
2126 $wgOut->addModules( 'mediawiki.toolbar' );
2129 if ( $wgUser->getOption( 'uselivepreview' ) ) {
2130 $wgOut->addModules( 'mediawiki.action.edit.preview' );
2133 if ( $wgUser->getOption( 'useeditwarning' ) ) {
2134 $wgOut->addModules( 'mediawiki.action.edit.editWarning' );
2137 if ( $wgAjaxEditStash ) {
2138 $wgOut->addModules( 'mediawiki.action.edit.stash' );
2141 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2143 # Enabled article-related sidebar, toplinks, etc.
2144 $wgOut->setArticleRelated( true );
2146 $contextTitle = $this->getContextTitle();
2147 if ( $this->isConflict
) {
2148 $msg = 'editconflict';
2149 } elseif ( $contextTitle->exists() && $this->section
!= '' ) {
2150 $msg = $this->section
== 'new' ?
'editingcomment' : 'editingsection';
2152 $msg = $contextTitle->exists()
2153 ||
( $contextTitle->getNamespace() == NS_MEDIAWIKI
2154 && $contextTitle->getDefaultMessageText() !== false
2160 # Use the title defined by DISPLAYTITLE magic word when present
2161 $displayTitle = isset( $this->mParserOutput
) ?
$this->mParserOutput
->getDisplayTitle() : false;
2162 if ( $displayTitle === false ) {
2163 $displayTitle = $contextTitle->getPrefixedText();
2165 $wgOut->setPageTitle( wfMessage( $msg, $displayTitle ) );
2169 * Show all applicable editing introductions
2171 protected function showIntro() {
2172 global $wgOut, $wgUser;
2173 if ( $this->suppressIntro
) {
2177 $namespace = $this->mTitle
->getNamespace();
2179 if ( $namespace == NS_MEDIAWIKI
) {
2180 # Show a warning if editing an interface message
2181 $wgOut->wrapWikiMsg( "<div class='mw-editinginterface'>\n$1\n</div>", 'editinginterface' );
2182 # If this is a default message (but not css or js),
2183 # show a hint that it is translatable on translatewiki.net
2184 if ( !$this->mTitle
->hasContentModel( CONTENT_MODEL_CSS
)
2185 && !$this->mTitle
->hasContentModel( CONTENT_MODEL_JAVASCRIPT
)
2187 $defaultMessageText = $this->mTitle
->getDefaultMessageText();
2188 if ( $defaultMessageText !== false ) {
2189 $wgOut->wrapWikiMsg( "<div class='mw-translateinterface'>\n$1\n</div>",
2190 'translateinterface' );
2193 } elseif ( $namespace == NS_FILE
) {
2194 # Show a hint to shared repo
2195 $file = wfFindFile( $this->mTitle
);
2196 if ( $file && !$file->isLocal() ) {
2197 $descUrl = $file->getDescriptionUrl();
2198 # there must be a description url to show a hint to shared repo
2200 if ( !$this->mTitle
->exists() ) {
2201 $wgOut->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-create\">\n$1\n</div>", array(
2202 'sharedupload-desc-create', $file->getRepo()->getDisplayName(), $descUrl
2205 $wgOut->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-edit\">\n$1\n</div>", array(
2206 'sharedupload-desc-edit', $file->getRepo()->getDisplayName(), $descUrl
2213 # Show a warning message when someone creates/edits a user (talk) page but the user does not exist
2214 # Show log extract when the user is currently blocked
2215 if ( $namespace == NS_USER ||
$namespace == NS_USER_TALK
) {
2216 $parts = explode( '/', $this->mTitle
->getText(), 2 );
2217 $username = $parts[0];
2218 $user = User
::newFromName( $username, false /* allow IP users*/ );
2219 $ip = User
::isIP( $username );
2220 $block = Block
::newFromTarget( $user, $user );
2221 if ( !( $user && $user->isLoggedIn() ) && !$ip ) { # User does not exist
2222 $wgOut->wrapWikiMsg( "<div class=\"mw-userpage-userdoesnotexist error\">\n$1\n</div>",
2223 array( 'userpage-userdoesnotexist', wfEscapeWikiText( $username ) ) );
2224 } elseif ( !is_null( $block ) && $block->getType() != Block
::TYPE_AUTO
) {
2225 # Show log extract if the user is currently blocked
2226 LogEventsList
::showLogExtract(
2229 MWNamespace
::getCanonicalName( NS_USER
) . ':' . $block->getTarget(),
2233 'showIfEmpty' => false,
2235 'blocked-notice-logextract',
2236 $user->getName() # Support GENDER in notice
2242 # Try to add a custom edit intro, or use the standard one if this is not possible.
2243 if ( !$this->showCustomIntro() && !$this->mTitle
->exists() ) {
2244 $helpLink = wfExpandUrl( Skin
::makeInternalOrExternalUrl(
2245 wfMessage( 'helppage' )->inContentLanguage()->text()
2247 if ( $wgUser->isLoggedIn() ) {
2248 $wgOut->wrapWikiMsg(
2249 // Suppress the external link icon, consider the help url an internal one
2250 "<div class=\"mw-newarticletext plainlinks\">\n$1\n</div>",
2257 $wgOut->wrapWikiMsg(
2258 // Suppress the external link icon, consider the help url an internal one
2259 "<div class=\"mw-newarticletextanon plainlinks\">\n$1\n</div>",
2261 'newarticletextanon',
2267 # Give a notice if the user is editing a deleted/moved page...
2268 if ( !$this->mTitle
->exists() ) {
2269 LogEventsList
::showLogExtract( $wgOut, array( 'delete', 'move' ), $this->mTitle
,
2273 'conds' => array( "log_action != 'revision'" ),
2274 'showIfEmpty' => false,
2275 'msgKey' => array( 'recreate-moveddeleted-warn' )
2282 * Attempt to show a custom editing introduction, if supplied
2286 protected function showCustomIntro() {
2287 if ( $this->editintro
) {
2288 $title = Title
::newFromText( $this->editintro
);
2289 if ( $title instanceof Title
&& $title->exists() && $title->userCan( 'read' ) ) {
2291 // Added using template syntax, to take <noinclude>'s into account.
2292 $wgOut->addWikiTextTitleTidy(
2293 '<div class="mw-editintro">{{:' . $title->getFullText() . '}}</div>',
2303 * Gets an editable textual representation of $content.
2304 * The textual representation can be turned by into a Content object by the
2305 * toEditContent() method.
2307 * If $content is null or false or a string, $content is returned unchanged.
2309 * If the given Content object is not of a type that can be edited using
2310 * the text base EditPage, an exception will be raised. Set
2311 * $this->allowNonTextContent to true to allow editing of non-textual
2314 * @param Content|null|bool|string $content
2315 * @return string The editable text form of the content.
2317 * @throws MWException If $content is not an instance of TextContent and
2318 * $this->allowNonTextContent is not true.
2320 protected function toEditText( $content ) {
2321 if ( $content === null ||
$content === false ||
is_string( $content ) ) {
2325 if ( !$this->isSupportedContentModel( $content->getModel() ) ) {
2326 throw new MWException( 'This content model is not supported: '
2327 . ContentHandler
::getLocalizedName( $content->getModel() ) );
2330 return $content->serialize( $this->contentFormat
);
2334 * Turns the given text into a Content object by unserializing it.
2336 * If the resulting Content object is not of a type that can be edited using
2337 * the text base EditPage, an exception will be raised. Set
2338 * $this->allowNonTextContent to true to allow editing of non-textual
2341 * @param string|null|bool $text Text to unserialize
2342 * @return Content The content object created from $text. If $text was false
2343 * or null, false resp. null will be returned instead.
2345 * @throws MWException If unserializing the text results in a Content
2346 * object that is not an instance of TextContent and
2347 * $this->allowNonTextContent is not true.
2349 protected function toEditContent( $text ) {
2350 if ( $text === false ||
$text === null ) {
2354 $content = ContentHandler
::makeContent( $text, $this->getTitle(),
2355 $this->contentModel
, $this->contentFormat
);
2357 if ( !$this->isSupportedContentModel( $content->getModel() ) ) {
2358 throw new MWException( 'This content model is not supported: '
2359 . ContentHandler
::getLocalizedName( $content->getModel() ) );
2366 * Send the edit form and related headers to $wgOut
2367 * @param callable|null $formCallback That takes an OutputPage parameter; will be called
2368 * during form output near the top, for captchas and the like.
2370 * The $formCallback parameter is deprecated since MediaWiki 1.25. Please
2371 * use the EditPage::showEditForm:fields hook instead.
2373 function showEditForm( $formCallback = null ) {
2374 global $wgOut, $wgUser;
2376 wfProfileIn( __METHOD__
);
2378 # need to parse the preview early so that we know which templates are used,
2379 # otherwise users with "show preview after edit box" will get a blank list
2380 # we parse this near the beginning so that setHeaders can do the title
2381 # setting work instead of leaving it in getPreviewText
2382 $previewOutput = '';
2383 if ( $this->formtype
== 'preview' ) {
2384 $previewOutput = $this->getPreviewText();
2387 Hooks
::run( 'EditPage::showEditForm:initial', array( &$this, &$wgOut ) );
2389 $this->setHeaders();
2391 if ( $this->showHeader() === false ) {
2392 wfProfileOut( __METHOD__
);
2396 $wgOut->addHTML( $this->editFormPageTop
);
2398 if ( $wgUser->getOption( 'previewontop' ) ) {
2399 $this->displayPreviewArea( $previewOutput, true );
2402 $wgOut->addHTML( $this->editFormTextTop
);
2404 $showToolbar = true;
2405 if ( $this->wasDeletedSinceLastEdit() ) {
2406 if ( $this->formtype
== 'save' ) {
2407 // Hide the toolbar and edit area, user can click preview to get it back
2408 // Add an confirmation checkbox and explanation.
2409 $showToolbar = false;
2411 $wgOut->wrapWikiMsg( "<div class='error mw-deleted-while-editing'>\n$1\n</div>",
2412 'deletedwhileediting' );
2416 // @todo add EditForm plugin interface and use it here!
2417 // search for textarea1 and textares2, and allow EditForm to override all uses.
2418 $wgOut->addHTML( Html
::openElement(
2421 'id' => self
::EDITFORM_ID
,
2422 'name' => self
::EDITFORM_ID
,
2424 'action' => $this->getActionURL( $this->getContextTitle() ),
2425 'enctype' => 'multipart/form-data'
2429 if ( is_callable( $formCallback ) ) {
2430 wfWarn( 'The $formCallback parameter to ' . __METHOD__
. 'is deprecated' );
2431 call_user_func_array( $formCallback, array( &$wgOut ) );
2434 // Add an empty field to trip up spambots
2436 Xml
::openElement( 'div', array( 'id' => 'antispam-container', 'style' => 'display: none;' ) )
2439 array( 'for' => 'wpAntiSpam' ),
2440 wfMessage( 'simpleantispam-label' )->parse()
2446 'name' => 'wpAntispam',
2447 'id' => 'wpAntispam',
2451 . Xml
::closeElement( 'div' )
2454 Hooks
::run( 'EditPage::showEditForm:fields', array( &$this, &$wgOut ) );
2456 // Put these up at the top to ensure they aren't lost on early form submission
2457 $this->showFormBeforeText();
2459 if ( $this->wasDeletedSinceLastEdit() && 'save' == $this->formtype
) {
2460 $username = $this->lastDelete
->user_name
;
2461 $comment = $this->lastDelete
->log_comment
;
2463 // It is better to not parse the comment at all than to have templates expanded in the middle
2464 // TODO: can the checkLabel be moved outside of the div so that wrapWikiMsg could be used?
2465 $key = $comment === ''
2466 ?
'confirmrecreate-noreason'
2467 : 'confirmrecreate';
2469 '<div class="mw-confirm-recreate">' .
2470 wfMessage( $key, $username, "<nowiki>$comment</nowiki>" )->parse() .
2471 Xml
::checkLabel( wfMessage( 'recreate' )->text(), 'wpRecreate', 'wpRecreate', false,
2472 array( 'title' => Linker
::titleAttrib( 'recreate' ), 'tabindex' => 1, 'id' => 'wpRecreate' )
2478 # When the summary is hidden, also hide them on preview/show changes
2479 if ( $this->nosummary
) {
2480 $wgOut->addHTML( Html
::hidden( 'nosummary', true ) );
2483 # If a blank edit summary was previously provided, and the appropriate
2484 # user preference is active, pass a hidden tag as wpIgnoreBlankSummary. This will stop the
2485 # user being bounced back more than once in the event that a summary
2488 # For a bit more sophisticated detection of blank summaries, hash the
2489 # automatic one and pass that in the hidden field wpAutoSummary.
2490 if ( $this->missingSummary ||
( $this->section
== 'new' && $this->nosummary
) ) {
2491 $wgOut->addHTML( Html
::hidden( 'wpIgnoreBlankSummary', true ) );
2494 if ( $this->undidRev
) {
2495 $wgOut->addHTML( Html
::hidden( 'wpUndidRevision', $this->undidRev
) );
2498 if ( $this->selfRedirect
) {
2499 $wgOut->addHTML( Html
::hidden( 'wpIgnoreSelfRedirect', true ) );
2502 if ( $this->hasPresetSummary
) {
2503 // If a summary has been preset using &summary= we don't want to prompt for
2504 // a different summary. Only prompt for a summary if the summary is blanked.
2506 $this->autoSumm
= md5( '' );
2509 $autosumm = $this->autoSumm ?
$this->autoSumm
: md5( $this->summary
);
2510 $wgOut->addHTML( Html
::hidden( 'wpAutoSummary', $autosumm ) );
2512 $wgOut->addHTML( Html
::hidden( 'oldid', $this->oldid
) );
2513 $wgOut->addHTML( Html
::hidden( 'parentRevId',
2514 $this->parentRevId ?
: $this->mArticle
->getRevIdFetched() ) );
2516 $wgOut->addHTML( Html
::hidden( 'format', $this->contentFormat
) );
2517 $wgOut->addHTML( Html
::hidden( 'model', $this->contentModel
) );
2519 if ( $this->section
== 'new' ) {
2520 $this->showSummaryInput( true, $this->summary
);
2521 $wgOut->addHTML( $this->getSummaryPreview( true, $this->summary
) );
2524 $wgOut->addHTML( $this->editFormTextBeforeContent
);
2526 if ( !$this->isCssJsSubpage
&& $showToolbar && $wgUser->getOption( 'showtoolbar' ) ) {
2527 $wgOut->addHTML( EditPage
::getEditToolbar() );
2530 if ( $this->blankArticle
) {
2531 $wgOut->addHTML( Html
::hidden( 'wpIgnoreBlankArticle', true ) );
2534 if ( $this->isConflict
) {
2535 // In an edit conflict bypass the overridable content form method
2536 // and fallback to the raw wpTextbox1 since editconflicts can't be
2537 // resolved between page source edits and custom ui edits using the
2539 $this->textbox2
= $this->textbox1
;
2541 $content = $this->getCurrentContent();
2542 $this->textbox1
= $this->toEditText( $content );
2544 $this->showTextbox1();
2546 $this->showContentForm();
2549 $wgOut->addHTML( $this->editFormTextAfterContent
);
2551 $this->showStandardInputs();
2553 $this->showFormAfterText();
2555 $this->showTosSummary();
2557 $this->showEditTools();
2559 $wgOut->addHTML( $this->editFormTextAfterTools
. "\n" );
2561 $wgOut->addHTML( Html
::rawElement( 'div', array( 'class' => 'templatesUsed' ),
2562 Linker
::formatTemplates( $this->getTemplates(), $this->preview
, $this->section
!= '' ) ) );
2564 $wgOut->addHTML( Html
::rawElement( 'div', array( 'class' => 'hiddencats' ),
2565 Linker
::formatHiddenCategories( $this->mArticle
->getHiddenCategories() ) ) );
2567 $wgOut->addHTML( Html
::rawElement( 'div', array( 'class' => 'limitreport' ),
2568 self
::getPreviewLimitReport( $this->mParserOutput
) ) );
2570 $wgOut->addModules( 'mediawiki.action.edit.collapsibleFooter' );
2572 if ( $this->isConflict
) {
2574 $this->showConflict();
2575 } catch ( MWContentSerializationException
$ex ) {
2576 // this can't really happen, but be nice if it does.
2578 'content-failed-to-parse',
2579 $this->contentModel
,
2580 $this->contentFormat
,
2583 $wgOut->addWikiText( '<div class="error">' . $msg->text() . '</div>' );
2587 // Marker for detecting truncated form data. This must be the last
2588 // parameter sent in order to be of use, so do not move me.
2589 $wgOut->addHTML( Html
::hidden( 'wpUltimateParam', true ) );
2590 $wgOut->addHTML( $this->editFormTextBottom
. "\n</form>\n" );
2592 if ( !$wgUser->getOption( 'previewontop' ) ) {
2593 $this->displayPreviewArea( $previewOutput, false );
2596 wfProfileOut( __METHOD__
);
2600 * Extract the section title from current section text, if any.
2602 * @param string $text
2603 * @return string|bool String or false
2605 public static function extractSectionTitle( $text ) {
2606 preg_match( "/^(=+)(.+)\\1\\s*(\n|$)/i", $text, $matches );
2607 if ( !empty( $matches[2] ) ) {
2609 return $wgParser->stripSectionName( trim( $matches[2] ) );
2618 protected function showHeader() {
2619 global $wgOut, $wgUser, $wgMaxArticleSize, $wgLang;
2620 global $wgAllowUserCss, $wgAllowUserJs;
2622 if ( $this->mTitle
->isTalkPage() ) {
2623 $wgOut->addWikiMsg( 'talkpagetext' );
2627 $wgOut->addHTML( implode( "\n", $this->mTitle
->getEditNotices( $this->oldid
) ) );
2629 if ( $this->isConflict
) {
2630 $wgOut->wrapWikiMsg( "<div class='mw-explainconflict'>\n$1\n</div>", 'explainconflict' );
2631 $this->edittime
= $this->mArticle
->getTimestamp();
2633 if ( $this->section
!= '' && !$this->isSectionEditSupported() ) {
2634 // We use $this->section to much before this and getVal('wgSection') directly in other places
2635 // at this point we can't reset $this->section to '' to fallback to non-section editing.
2636 // Someone is welcome to try refactoring though
2637 $wgOut->showErrorPage( 'sectioneditnotsupported-title', 'sectioneditnotsupported-text' );
2641 if ( $this->section
!= '' && $this->section
!= 'new' ) {
2642 if ( !$this->summary
&& !$this->preview
&& !$this->diff
) {
2643 $sectionTitle = self
::extractSectionTitle( $this->textbox1
); //FIXME: use Content object
2644 if ( $sectionTitle !== false ) {
2645 $this->summary
= "/* $sectionTitle */ ";
2650 if ( $this->missingComment
) {
2651 $wgOut->wrapWikiMsg( "<div id='mw-missingcommenttext'>\n$1\n</div>", 'missingcommenttext' );
2654 if ( $this->missingSummary
&& $this->section
!= 'new' ) {
2655 $wgOut->wrapWikiMsg( "<div id='mw-missingsummary'>\n$1\n</div>", 'missingsummary' );
2658 if ( $this->missingSummary
&& $this->section
== 'new' ) {
2659 $wgOut->wrapWikiMsg( "<div id='mw-missingcommentheader'>\n$1\n</div>", 'missingcommentheader' );
2662 if ( $this->blankArticle
) {
2663 $wgOut->wrapWikiMsg( "<div id='mw-blankarticle'>\n$1\n</div>", 'blankarticle' );
2666 if ( $this->selfRedirect
) {
2667 $wgOut->wrapWikiMsg( "<div id='mw-selfredirect'>\n$1\n</div>", 'selfredirect' );
2670 if ( $this->hookError
!== '' ) {
2671 $wgOut->addWikiText( $this->hookError
);
2674 if ( !$this->checkUnicodeCompliantBrowser() ) {
2675 $wgOut->addWikiMsg( 'nonunicodebrowser' );
2678 if ( $this->section
!= 'new' ) {
2679 $revision = $this->mArticle
->getRevisionFetched();
2681 // Let sysop know that this will make private content public if saved
2683 if ( !$revision->userCan( Revision
::DELETED_TEXT
, $wgUser ) ) {
2684 $wgOut->wrapWikiMsg(
2685 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
2686 'rev-deleted-text-permission'
2688 } elseif ( $revision->isDeleted( Revision
::DELETED_TEXT
) ) {
2689 $wgOut->wrapWikiMsg(
2690 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
2691 'rev-deleted-text-view'
2695 if ( !$revision->isCurrent() ) {
2696 $this->mArticle
->setOldSubtitle( $revision->getId() );
2697 $wgOut->addWikiMsg( 'editingold' );
2699 } elseif ( $this->mTitle
->exists() ) {
2700 // Something went wrong
2702 $wgOut->wrapWikiMsg( "<div class='errorbox'>\n$1\n</div>\n",
2703 array( 'missing-revision', $this->oldid
) );
2708 if ( wfReadOnly() ) {
2709 $wgOut->wrapWikiMsg(
2710 "<div id=\"mw-read-only-warning\">\n$1\n</div>",
2711 array( 'readonlywarning', wfReadOnlyReason() )
2713 } elseif ( $wgUser->isAnon() ) {
2714 if ( $this->formtype
!= 'preview' ) {
2715 $wgOut->wrapWikiMsg(
2716 "<div id='mw-anon-edit-warning'>\n$1\n</div>",
2717 array( 'anoneditwarning',
2719 '{{fullurl:Special:UserLogin|returnto={{FULLPAGENAMEE}}}}',
2721 '{{fullurl:Special:UserLogin/signup|returnto={{FULLPAGENAMEE}}}}' )
2724 $wgOut->wrapWikiMsg( "<div id=\"mw-anon-preview-warning\">\n$1</div>",
2725 'anonpreviewwarning'
2729 if ( $this->isCssJsSubpage
) {
2730 # Check the skin exists
2731 if ( $this->isWrongCaseCssJsPage
) {
2732 $wgOut->wrapWikiMsg(
2733 "<div class='error' id='mw-userinvalidcssjstitle'>\n$1\n</div>",
2734 array( 'userinvalidcssjstitle', $this->mTitle
->getSkinFromCssJsSubpage() )
2737 if ( $this->formtype
!== 'preview' ) {
2738 if ( $this->isCssSubpage
&& $wgAllowUserCss ) {
2739 $wgOut->wrapWikiMsg(
2740 "<div id='mw-usercssyoucanpreview'>\n$1\n</div>",
2741 array( 'usercssyoucanpreview' )
2745 if ( $this->isJsSubpage
&& $wgAllowUserJs ) {
2746 $wgOut->wrapWikiMsg(
2747 "<div id='mw-userjsyoucanpreview'>\n$1\n</div>",
2748 array( 'userjsyoucanpreview' )
2755 if ( $this->mTitle
->isProtected( 'edit' ) &&
2756 MWNamespace
::getRestrictionLevels( $this->mTitle
->getNamespace() ) !== array( '' )
2758 # Is the title semi-protected?
2759 if ( $this->mTitle
->isSemiProtected() ) {
2760 $noticeMsg = 'semiprotectedpagewarning';
2762 # Then it must be protected based on static groups (regular)
2763 $noticeMsg = 'protectedpagewarning';
2765 LogEventsList
::showLogExtract( $wgOut, 'protect', $this->mTitle
, '',
2766 array( 'lim' => 1, 'msgKey' => array( $noticeMsg ) ) );
2768 if ( $this->mTitle
->isCascadeProtected() ) {
2769 # Is this page under cascading protection from some source pages?
2770 list( $cascadeSources, /* $restrictions */ ) = $this->mTitle
->getCascadeProtectionSources();
2771 $notice = "<div class='mw-cascadeprotectedwarning'>\n$1\n";
2772 $cascadeSourcesCount = count( $cascadeSources );
2773 if ( $cascadeSourcesCount > 0 ) {
2774 # Explain, and list the titles responsible
2775 foreach ( $cascadeSources as $page ) {
2776 $notice .= '* [[:' . $page->getPrefixedText() . "]]\n";
2779 $notice .= '</div>';
2780 $wgOut->wrapWikiMsg( $notice, array( 'cascadeprotectedwarning', $cascadeSourcesCount ) );
2782 if ( !$this->mTitle
->exists() && $this->mTitle
->getRestrictions( 'create' ) ) {
2783 LogEventsList
::showLogExtract( $wgOut, 'protect', $this->mTitle
, '',
2785 'showIfEmpty' => false,
2786 'msgKey' => array( 'titleprotectedwarning' ),
2787 'wrap' => "<div class=\"mw-titleprotectedwarning\">\n$1</div>" ) );
2790 if ( $this->kblength
=== false ) {
2791 $this->kblength
= (int)( strlen( $this->textbox1
) / 1024 );
2794 if ( $this->tooBig ||
$this->kblength
> $wgMaxArticleSize ) {
2795 $wgOut->wrapWikiMsg( "<div class='error' id='mw-edit-longpageerror'>\n$1\n</div>",
2798 $wgLang->formatNum( $this->kblength
),
2799 $wgLang->formatNum( $wgMaxArticleSize )
2803 if ( !wfMessage( 'longpage-hint' )->isDisabled() ) {
2804 $wgOut->wrapWikiMsg( "<div id='mw-edit-longpage-hint'>\n$1\n</div>",
2807 $wgLang->formatSize( strlen( $this->textbox1
) ),
2808 strlen( $this->textbox1
)
2813 # Add header copyright warning
2814 $this->showHeaderCopyrightWarning();
2820 * Standard summary input and label (wgSummary), abstracted so EditPage
2821 * subclasses may reorganize the form.
2822 * Note that you do not need to worry about the label's for=, it will be
2823 * inferred by the id given to the input. You can remove them both by
2824 * passing array( 'id' => false ) to $userInputAttrs.
2826 * @param string $summary The value of the summary input
2827 * @param string $labelText The html to place inside the label
2828 * @param array $inputAttrs Array of attrs to use on the input
2829 * @param array $spanLabelAttrs Array of attrs to use on the span inside the label
2831 * @return array An array in the format array( $label, $input )
2833 function getSummaryInput( $summary = "", $labelText = null,
2834 $inputAttrs = null, $spanLabelAttrs = null
2836 // Note: the maxlength is overridden in JS to 255 and to make it use UTF-8 bytes, not characters.
2837 $inputAttrs = ( is_array( $inputAttrs ) ?
$inputAttrs : array() ) +
array(
2838 'id' => 'wpSummary',
2839 'maxlength' => '200',
2842 'spellcheck' => 'true',
2843 ) + Linker
::tooltipAndAccesskeyAttribs( 'summary' );
2845 $spanLabelAttrs = ( is_array( $spanLabelAttrs ) ?
$spanLabelAttrs : array() ) +
array(
2846 'class' => $this->missingSummary ?
'mw-summarymissed' : 'mw-summary',
2847 'id' => "wpSummaryLabel"
2854 $inputAttrs['id'] ?
array( 'for' => $inputAttrs['id'] ) : null,
2857 $label = Xml
::tags( 'span', $spanLabelAttrs, $label );
2860 $input = Html
::input( 'wpSummary', $summary, 'text', $inputAttrs );
2862 return array( $label, $input );
2866 * @param bool $isSubjectPreview True if this is the section subject/title
2867 * up top, or false if this is the comment summary
2868 * down below the textarea
2869 * @param string $summary The text of the summary to display
2871 protected function showSummaryInput( $isSubjectPreview, $summary = "" ) {
2872 global $wgOut, $wgContLang;
2873 # Add a class if 'missingsummary' is triggered to allow styling of the summary line
2874 $summaryClass = $this->missingSummary ?
'mw-summarymissed' : 'mw-summary';
2875 if ( $isSubjectPreview ) {
2876 if ( $this->nosummary
) {
2880 if ( !$this->mShowSummaryField
) {
2884 $summary = $wgContLang->recodeForEdit( $summary );
2885 $labelText = wfMessage( $isSubjectPreview ?
'subject' : 'summary' )->parse();
2886 list( $label, $input ) = $this->getSummaryInput(
2889 array( 'class' => $summaryClass ),
2892 $wgOut->addHTML( "{$label} {$input}" );
2896 * @param bool $isSubjectPreview True if this is the section subject/title
2897 * up top, or false if this is the comment summary
2898 * down below the textarea
2899 * @param string $summary The text of the summary to display
2902 protected function getSummaryPreview( $isSubjectPreview, $summary = "" ) {
2903 // avoid spaces in preview, gets always trimmed on save
2904 $summary = trim( $summary );
2905 if ( !$summary ||
( !$this->preview
&& !$this->diff
) ) {
2911 if ( $isSubjectPreview ) {
2912 $summary = wfMessage( 'newsectionsummary' )->rawParams( $wgParser->stripSectionName( $summary ) )
2913 ->inContentLanguage()->text();
2916 $message = $isSubjectPreview ?
'subject-preview' : 'summary-preview';
2918 $summary = wfMessage( $message )->parse()
2919 . Linker
::commentBlock( $summary, $this->mTitle
, $isSubjectPreview );
2920 return Xml
::tags( 'div', array( 'class' => 'mw-summary-preview' ), $summary );
2923 protected function showFormBeforeText() {
2925 $section = htmlspecialchars( $this->section
);
2926 $wgOut->addHTML( <<<HTML
2927 <input type='hidden' value="{$section}" name="wpSection"/>
2928 <input type='hidden' value="{$this->starttime}" name="wpStarttime" />
2929 <input type='hidden' value="{$this->edittime}" name="wpEdittime" />
2930 <input type='hidden' value="{$this->scrolltop}" name="wpScrolltop" id="wpScrolltop" />
2934 if ( !$this->checkUnicodeCompliantBrowser() ) {
2935 $wgOut->addHTML( Html
::hidden( 'safemode', '1' ) );
2939 protected function showFormAfterText() {
2940 global $wgOut, $wgUser;
2942 * To make it harder for someone to slip a user a page
2943 * which submits an edit form to the wiki without their
2944 * knowledge, a random token is associated with the login
2945 * session. If it's not passed back with the submission,
2946 * we won't save the page, or render user JavaScript and
2949 * For anon editors, who may not have a session, we just
2950 * include the constant suffix to prevent editing from
2951 * broken text-mangling proxies.
2953 $wgOut->addHTML( "\n" . Html
::hidden( "wpEditToken", $wgUser->getEditToken() ) . "\n" );
2957 * Subpage overridable method for printing the form for page content editing
2958 * By default this simply outputs wpTextbox1
2959 * Subclasses can override this to provide a custom UI for editing;
2960 * be it a form, or simply wpTextbox1 with a modified content that will be
2961 * reverse modified when extracted from the post data.
2962 * Note that this is basically the inverse for importContentFormData
2964 protected function showContentForm() {
2965 $this->showTextbox1();
2969 * Method to output wpTextbox1
2970 * The $textoverride method can be used by subclasses overriding showContentForm
2971 * to pass back to this method.
2973 * @param array $customAttribs Array of html attributes to use in the textarea
2974 * @param string $textoverride Optional text to override $this->textarea1 with
2976 protected function showTextbox1( $customAttribs = null, $textoverride = null ) {
2977 if ( $this->wasDeletedSinceLastEdit() && $this->formtype
== 'save' ) {
2978 $attribs = array( 'style' => 'display:none;' );
2980 $classes = array(); // Textarea CSS
2981 if ( $this->mTitle
->isProtected( 'edit' ) &&
2982 MWNamespace
::getRestrictionLevels( $this->mTitle
->getNamespace() ) !== array( '' )
2984 # Is the title semi-protected?
2985 if ( $this->mTitle
->isSemiProtected() ) {
2986 $classes[] = 'mw-textarea-sprotected';
2988 # Then it must be protected based on static groups (regular)
2989 $classes[] = 'mw-textarea-protected';
2991 # Is the title cascade-protected?
2992 if ( $this->mTitle
->isCascadeProtected() ) {
2993 $classes[] = 'mw-textarea-cprotected';
2997 $attribs = array( 'tabindex' => 1 );
2999 if ( is_array( $customAttribs ) ) {
3000 $attribs +
= $customAttribs;
3003 if ( count( $classes ) ) {
3004 if ( isset( $attribs['class'] ) ) {
3005 $classes[] = $attribs['class'];
3007 $attribs['class'] = implode( ' ', $classes );
3012 $textoverride !== null ?
$textoverride : $this->textbox1
,
3018 protected function showTextbox2() {
3019 $this->showTextbox( $this->textbox2
, 'wpTextbox2', array( 'tabindex' => 6, 'readonly' ) );
3022 protected function showTextbox( $text, $name, $customAttribs = array() ) {
3023 global $wgOut, $wgUser;
3025 $wikitext = $this->safeUnicodeOutput( $text );
3026 if ( strval( $wikitext ) !== '' ) {
3027 // Ensure there's a newline at the end, otherwise adding lines
3029 // But don't add a newline if the ext is empty, or Firefox in XHTML
3030 // mode will show an extra newline. A bit annoying.
3034 $attribs = $customAttribs +
array(
3037 'cols' => $wgUser->getIntOption( 'cols' ),
3038 'rows' => $wgUser->getIntOption( 'rows' ),
3039 // Avoid PHP notices when appending preferences
3040 // (appending allows customAttribs['style'] to still work).
3044 $pageLang = $this->mTitle
->getPageLanguage();
3045 $attribs['lang'] = $pageLang->getHtmlCode();
3046 $attribs['dir'] = $pageLang->getDir();
3048 $wgOut->addHTML( Html
::textarea( $name, $wikitext, $attribs ) );
3051 protected function displayPreviewArea( $previewOutput, $isOnTop = false ) {
3055 $classes[] = 'ontop';
3058 $attribs = array( 'id' => 'wikiPreview', 'class' => implode( ' ', $classes ) );
3060 if ( $this->formtype
!= 'preview' ) {
3061 $attribs['style'] = 'display: none;';
3064 $wgOut->addHTML( Xml
::openElement( 'div', $attribs ) );
3066 if ( $this->formtype
== 'preview' ) {
3067 $this->showPreview( $previewOutput );
3070 $wgOut->addHTML( '</div>' );
3072 if ( $this->formtype
== 'diff' ) {
3075 } catch ( MWContentSerializationException
$ex ) {
3077 'content-failed-to-parse',
3078 $this->contentModel
,
3079 $this->contentFormat
,
3082 $wgOut->addWikiText( '<div class="error">' . $msg->text() . '</div>' );
3088 * Append preview output to $wgOut.
3089 * Includes category rendering if this is a category page.
3091 * @param string $text The HTML to be output for the preview.
3093 protected function showPreview( $text ) {
3095 if ( $this->mTitle
->getNamespace() == NS_CATEGORY
) {
3096 $this->mArticle
->openShowCategory();
3098 # This hook seems slightly odd here, but makes things more
3099 # consistent for extensions.
3100 Hooks
::run( 'OutputPageBeforeHTML', array( &$wgOut, &$text ) );
3101 $wgOut->addHTML( $text );
3102 if ( $this->mTitle
->getNamespace() == NS_CATEGORY
) {
3103 $this->mArticle
->closeShowCategory();
3108 * Get a diff between the current contents of the edit box and the
3109 * version of the page we're editing from.
3111 * If this is a section edit, we'll replace the section as for final
3112 * save and then make a comparison.
3114 function showDiff() {
3115 global $wgUser, $wgContLang, $wgOut;
3117 $oldtitlemsg = 'currentrev';
3118 # if message does not exist, show diff against the preloaded default
3119 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
&& !$this->mTitle
->exists() ) {
3120 $oldtext = $this->mTitle
->getDefaultMessageText();
3121 if ( $oldtext !== false ) {
3122 $oldtitlemsg = 'defaultmessagetext';
3123 $oldContent = $this->toEditContent( $oldtext );
3128 $oldContent = $this->getCurrentContent();
3131 $textboxContent = $this->toEditContent( $this->textbox1
);
3133 $newContent = $this->mArticle
->replaceSectionContent(
3134 $this->section
, $textboxContent,
3135 $this->summary
, $this->edittime
);
3137 if ( $newContent ) {
3138 ContentHandler
::runLegacyHooks( 'EditPageGetDiffText', array( $this, &$newContent ) );
3139 Hooks
::run( 'EditPageGetDiffContent', array( $this, &$newContent ) );
3141 $popts = ParserOptions
::newFromUserAndLang( $wgUser, $wgContLang );
3142 $newContent = $newContent->preSaveTransform( $this->mTitle
, $wgUser, $popts );
3145 if ( ( $oldContent && !$oldContent->isEmpty() ) ||
( $newContent && !$newContent->isEmpty() ) ) {
3146 $oldtitle = wfMessage( $oldtitlemsg )->parse();
3147 $newtitle = wfMessage( 'yourtext' )->parse();
3149 if ( !$oldContent ) {
3150 $oldContent = $newContent->getContentHandler()->makeEmptyContent();
3153 if ( !$newContent ) {
3154 $newContent = $oldContent->getContentHandler()->makeEmptyContent();
3157 $de = $oldContent->getContentHandler()->createDifferenceEngine( $this->mArticle
->getContext() );
3158 $de->setContent( $oldContent, $newContent );
3160 $difftext = $de->getDiff( $oldtitle, $newtitle );
3161 $de->showDiffStyle();
3166 $wgOut->addHTML( '<div id="wikiDiff">' . $difftext . '</div>' );
3170 * Show the header copyright warning.
3172 protected function showHeaderCopyrightWarning() {
3173 $msg = 'editpage-head-copy-warn';
3174 if ( !wfMessage( $msg )->isDisabled() ) {
3176 $wgOut->wrapWikiMsg( "<div class='editpage-head-copywarn'>\n$1\n</div>",
3177 'editpage-head-copy-warn' );
3182 * Give a chance for site and per-namespace customizations of
3183 * terms of service summary link that might exist separately
3184 * from the copyright notice.
3186 * This will display between the save button and the edit tools,
3187 * so should remain short!
3189 protected function showTosSummary() {
3190 $msg = 'editpage-tos-summary';
3191 Hooks
::run( 'EditPageTosSummary', array( $this->mTitle
, &$msg ) );
3192 if ( !wfMessage( $msg )->isDisabled() ) {
3194 $wgOut->addHTML( '<div class="mw-tos-summary">' );
3195 $wgOut->addWikiMsg( $msg );
3196 $wgOut->addHTML( '</div>' );
3200 protected function showEditTools() {
3202 $wgOut->addHTML( '<div class="mw-editTools">' .
3203 wfMessage( 'edittools' )->inContentLanguage()->parse() .
3208 * Get the copyright warning
3210 * Renamed to getCopyrightWarning(), old name kept around for backwards compatibility
3213 protected function getCopywarn() {
3214 return self
::getCopyrightWarning( $this->mTitle
);
3218 * Get the copyright warning, by default returns wikitext
3220 * @param Title $title
3221 * @param string $format Output format, valid values are any function of a Message object
3224 public static function getCopyrightWarning( $title, $format = 'plain' ) {
3225 global $wgRightsText;
3226 if ( $wgRightsText ) {
3227 $copywarnMsg = array( 'copyrightwarning',
3228 '[[' . wfMessage( 'copyrightpage' )->inContentLanguage()->text() . ']]',
3231 $copywarnMsg = array( 'copyrightwarning2',
3232 '[[' . wfMessage( 'copyrightpage' )->inContentLanguage()->text() . ']]' );
3234 // Allow for site and per-namespace customization of contribution/copyright notice.
3235 Hooks
::run( 'EditPageCopyrightWarning', array( $title, &$copywarnMsg ) );
3237 return "<div id=\"editpage-copywarn\">\n" .
3238 call_user_func_array( 'wfMessage', $copywarnMsg )->$format() . "\n</div>";
3242 * Get the Limit report for page previews
3245 * @param ParserOutput $output ParserOutput object from the parse
3246 * @return string HTML
3248 public static function getPreviewLimitReport( $output ) {
3249 if ( !$output ||
!$output->getLimitReportData() ) {
3253 wfProfileIn( __METHOD__
);
3255 $limitReport = Html
::rawElement( 'div', array( 'class' => 'mw-limitReportExplanation' ),
3256 wfMessage( 'limitreport-title' )->parseAsBlock()
3259 // Show/hide animation doesn't work correctly on a table, so wrap it in a div.
3260 $limitReport .= Html
::openElement( 'div', array( 'class' => 'preview-limit-report-wrapper' ) );
3262 $limitReport .= Html
::openElement( 'table', array(
3263 'class' => 'preview-limit-report wikitable'
3265 Html
::openElement( 'tbody' );
3267 foreach ( $output->getLimitReportData() as $key => $value ) {
3268 if ( Hooks
::run( 'ParserLimitReportFormat',
3269 array( $key, &$value, &$limitReport, true, true )
3271 $keyMsg = wfMessage( $key );
3272 $valueMsg = wfMessage( array( "$key-value-html", "$key-value" ) );
3273 if ( !$valueMsg->exists() ) {
3274 $valueMsg = new RawMessage( '$1' );
3276 if ( !$keyMsg->isDisabled() && !$valueMsg->isDisabled() ) {
3277 $limitReport .= Html
::openElement( 'tr' ) .
3278 Html
::rawElement( 'th', null, $keyMsg->parse() ) .
3279 Html
::rawElement( 'td', null, $valueMsg->params( $value )->parse() ) .
3280 Html
::closeElement( 'tr' );
3285 $limitReport .= Html
::closeElement( 'tbody' ) .
3286 Html
::closeElement( 'table' ) .
3287 Html
::closeElement( 'div' );
3289 wfProfileOut( __METHOD__
);
3291 return $limitReport;
3294 protected function showStandardInputs( &$tabindex = 2 ) {
3296 $wgOut->addHTML( "<div class='editOptions'>\n" );
3298 if ( $this->section
!= 'new' ) {
3299 $this->showSummaryInput( false, $this->summary
);
3300 $wgOut->addHTML( $this->getSummaryPreview( false, $this->summary
) );
3303 $checkboxes = $this->getCheckboxes( $tabindex,
3304 array( 'minor' => $this->minoredit
, 'watch' => $this->watchthis
) );
3305 $wgOut->addHTML( "<div class='editCheckboxes'>" . implode( $checkboxes, "\n" ) . "</div>\n" );
3307 // Show copyright warning.
3308 $wgOut->addWikiText( $this->getCopywarn() );
3309 $wgOut->addHTML( $this->editFormTextAfterWarn
);
3311 $wgOut->addHTML( "<div class='editButtons'>\n" );
3312 $wgOut->addHTML( implode( $this->getEditButtons( $tabindex ), "\n" ) . "\n" );
3314 $cancel = $this->getCancelLink();
3315 if ( $cancel !== '' ) {
3316 $cancel .= Html
::element( 'span',
3317 array( 'class' => 'mw-editButtons-pipe-separator' ),
3318 wfMessage( 'pipe-separator' )->text() );
3321 $message = wfMessage( 'edithelppage' )->inContentLanguage()->text();
3322 $edithelpurl = Skin
::makeInternalOrExternalUrl( $message );
3324 'target' => 'helpwindow',
3325 'href' => $edithelpurl,
3327 $edithelp = Html
::linkButton( wfMessage( 'edithelp' )->text(),
3328 $attrs, array( 'mw-ui-quiet' ) ) .
3329 wfMessage( 'word-separator' )->escaped() .
3330 wfMessage( 'newwindow' )->parse();
3332 $wgOut->addHTML( " <span class='cancelLink'>{$cancel}</span>\n" );
3333 $wgOut->addHTML( " <span class='editHelp'>{$edithelp}</span>\n" );
3334 $wgOut->addHTML( "</div><!-- editButtons -->\n" );
3336 Hooks
::run( 'EditPage::showStandardInputs:options', array( $this, $wgOut, &$tabindex ) );
3338 $wgOut->addHTML( "</div><!-- editOptions -->\n" );
3342 * Show an edit conflict. textbox1 is already shown in showEditForm().
3343 * If you want to use another entry point to this function, be careful.
3345 protected function showConflict() {
3348 if ( Hooks
::run( 'EditPageBeforeConflictDiff', array( &$this, &$wgOut ) ) ) {
3349 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
3351 $content1 = $this->toEditContent( $this->textbox1
);
3352 $content2 = $this->toEditContent( $this->textbox2
);
3354 $handler = ContentHandler
::getForModelID( $this->contentModel
);
3355 $de = $handler->createDifferenceEngine( $this->mArticle
->getContext() );
3356 $de->setContent( $content2, $content1 );
3358 wfMessage( 'yourtext' )->parse(),
3359 wfMessage( 'storedversion' )->text()
3362 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
3363 $this->showTextbox2();
3370 public function getCancelLink() {
3371 $cancelParams = array();
3372 if ( !$this->isConflict
&& $this->oldid
> 0 ) {
3373 $cancelParams['oldid'] = $this->oldid
;
3375 $attrs = array( 'id' => 'mw-editform-cancel' );
3377 return Linker
::linkKnown(
3378 $this->getContextTitle(),
3379 wfMessage( 'cancel' )->parse(),
3380 Html
::buttonAttributes( $attrs, array( 'mw-ui-quiet' ) ),
3386 * Returns the URL to use in the form's action attribute.
3387 * This is used by EditPage subclasses when simply customizing the action
3388 * variable in the constructor is not enough. This can be used when the
3389 * EditPage lives inside of a Special page rather than a custom page action.
3391 * @param Title $title Title object for which is being edited (where we go to for &action= links)
3394 protected function getActionURL( Title
$title ) {
3395 return $title->getLocalURL( array( 'action' => $this->action
) );
3399 * Check if a page was deleted while the user was editing it, before submit.
3400 * Note that we rely on the logging table, which hasn't been always there,
3401 * but that doesn't matter, because this only applies to brand new
3405 protected function wasDeletedSinceLastEdit() {
3406 if ( $this->deletedSinceEdit
!== null ) {
3407 return $this->deletedSinceEdit
;
3410 $this->deletedSinceEdit
= false;
3412 if ( $this->mTitle
->isDeletedQuick() ) {
3413 $this->lastDelete
= $this->getLastDelete();
3414 if ( $this->lastDelete
) {
3415 $deleteTime = wfTimestamp( TS_MW
, $this->lastDelete
->log_timestamp
);
3416 if ( $deleteTime > $this->starttime
) {
3417 $this->deletedSinceEdit
= true;
3422 return $this->deletedSinceEdit
;
3426 * @return bool|stdClass
3428 protected function getLastDelete() {
3429 $dbr = wfGetDB( DB_SLAVE
);
3430 $data = $dbr->selectRow(
3431 array( 'logging', 'user' ),
3444 'log_namespace' => $this->mTitle
->getNamespace(),
3445 'log_title' => $this->mTitle
->getDBkey(),
3446 'log_type' => 'delete',
3447 'log_action' => 'delete',
3451 array( 'LIMIT' => 1, 'ORDER BY' => 'log_timestamp DESC' )
3453 // Quick paranoid permission checks...
3454 if ( is_object( $data ) ) {
3455 if ( $data->log_deleted
& LogPage
::DELETED_USER
) {
3456 $data->user_name
= wfMessage( 'rev-deleted-user' )->escaped();
3459 if ( $data->log_deleted
& LogPage
::DELETED_COMMENT
) {
3460 $data->log_comment
= wfMessage( 'rev-deleted-comment' )->escaped();
3468 * Get the rendered text for previewing.
3469 * @throws MWException
3472 function getPreviewText() {
3473 global $wgOut, $wgUser, $wgRawHtml, $wgLang;
3474 global $wgAllowUserCss, $wgAllowUserJs;
3476 wfProfileIn( __METHOD__
);
3478 if ( $wgRawHtml && !$this->mTokenOk
) {
3479 // Could be an offsite preview attempt. This is very unsafe if
3480 // HTML is enabled, as it could be an attack.
3482 if ( $this->textbox1
!== '' ) {
3483 // Do not put big scary notice, if previewing the empty
3484 // string, which happens when you initially edit
3485 // a category page, due to automatic preview-on-open.
3486 $parsedNote = $wgOut->parse( "<div class='previewnote'>" .
3487 wfMessage( 'session_fail_preview_html' )->text() . "</div>", true, /* interface */true );
3489 wfProfileOut( __METHOD__
);
3496 $content = $this->toEditContent( $this->textbox1
);
3500 'AlternateEditPreview',
3501 array( $this, &$content, &$previewHTML, &$this->mParserOutput
) )
3503 wfProfileOut( __METHOD__
);
3504 return $previewHTML;
3507 # provide a anchor link to the editform
3508 $continueEditing = '<span class="mw-continue-editing">' .
3509 '[[#' . self
::EDITFORM_ID
. '|' . $wgLang->getArrow() . ' ' .
3510 wfMessage( 'continue-editing' )->text() . ']]</span>';
3511 if ( $this->mTriedSave
&& !$this->mTokenOk
) {
3512 if ( $this->mTokenOkExceptSuffix
) {
3513 $note = wfMessage( 'token_suffix_mismatch' )->plain();
3515 $note = wfMessage( 'session_fail_preview' )->plain();
3517 } elseif ( $this->incompleteForm
) {
3518 $note = wfMessage( 'edit_form_incomplete' )->plain();
3520 $note = wfMessage( 'previewnote' )->plain() . ' ' . $continueEditing;
3523 $parserOptions = $this->mArticle
->makeParserOptions( $this->mArticle
->getContext() );
3524 $parserOptions->setIsPreview( true );
3525 $parserOptions->setIsSectionPreview( !is_null( $this->section
) && $this->section
!== '' );
3527 # don't parse non-wikitext pages, show message about preview
3528 if ( $this->mTitle
->isCssJsSubpage() ||
$this->mTitle
->isCssOrJsPage() ) {
3529 if ( $this->mTitle
->isCssJsSubpage() ) {
3531 } elseif ( $this->mTitle
->isCssOrJsPage() ) {
3537 if ( $content->getModel() == CONTENT_MODEL_CSS
) {
3539 if ( $level === 'user' && !$wgAllowUserCss ) {
3542 } elseif ( $content->getModel() == CONTENT_MODEL_JAVASCRIPT
) {
3544 if ( $level === 'user' && !$wgAllowUserJs ) {
3551 # Used messages to make sure grep find them:
3552 # Messages: usercsspreview, userjspreview, sitecsspreview, sitejspreview
3553 if ( $level && $format ) {
3554 $note = "<div id='mw-{$level}{$format}preview'>" .
3555 wfMessage( "{$level}{$format}preview" )->text() .
3556 ' ' . $continueEditing . "</div>";
3560 # If we're adding a comment, we need to show the
3561 # summary as the headline
3562 if ( $this->section
=== "new" && $this->summary
!== "" ) {
3563 $content = $content->addSectionHeader( $this->summary
);
3566 $hook_args = array( $this, &$content );
3567 ContentHandler
::runLegacyHooks( 'EditPageGetPreviewText', $hook_args );
3568 Hooks
::run( 'EditPageGetPreviewContent', $hook_args );
3570 $parserOptions->enableLimitReport();
3572 # For CSS/JS pages, we should have called the ShowRawCssJs hook here.
3573 # But it's now deprecated, so never mind
3575 $pstContent = $content->preSaveTransform( $this->mTitle
, $wgUser, $parserOptions );
3576 $parserOutput = $pstContent->getParserOutput( $this->mTitle
, null, $parserOptions );
3578 # Try to stash the edit for the final submission step
3579 # @todo: different date format preferences cause cache misses
3580 ApiStashEdit
::stashEditFromPreview(
3581 $this->getArticle(), $content, $pstContent,
3582 $parserOutput, $parserOptions, $parserOptions, wfTimestampNow()
3585 $parserOutput->setEditSectionTokens( false ); // no section edit links
3586 $previewHTML = $parserOutput->getText();
3587 $this->mParserOutput
= $parserOutput;
3588 $wgOut->addParserOutputMetadata( $parserOutput );
3590 if ( count( $parserOutput->getWarnings() ) ) {
3591 $note .= "\n\n" . implode( "\n\n", $parserOutput->getWarnings() );
3593 } catch ( MWContentSerializationException
$ex ) {
3595 'content-failed-to-parse',
3596 $this->contentModel
,
3597 $this->contentFormat
,
3600 $note .= "\n\n" . $m->parse();
3604 if ( $this->isConflict
) {
3605 $conflict = '<h2 id="mw-previewconflict">'
3606 . wfMessage( 'previewconflict' )->escaped() . "</h2>\n";
3608 $conflict = '<hr />';
3611 $previewhead = "<div class='previewnote'>\n" .
3612 '<h2 id="mw-previewheader">' . wfMessage( 'preview' )->escaped() . "</h2>" .
3613 $wgOut->parse( $note, true, /* interface */true ) . $conflict . "</div>\n";
3615 $pageViewLang = $this->mTitle
->getPageViewLanguage();
3616 $attribs = array( 'lang' => $pageViewLang->getHtmlCode(), 'dir' => $pageViewLang->getDir(),
3617 'class' => 'mw-content-' . $pageViewLang->getDir() );
3618 $previewHTML = Html
::rawElement( 'div', $attribs, $previewHTML );
3620 wfProfileOut( __METHOD__
);
3621 return $previewhead . $previewHTML . $this->previewTextAfterContent
;
3627 function getTemplates() {
3628 if ( $this->preview ||
$this->section
!= '' ) {
3629 $templates = array();
3630 if ( !isset( $this->mParserOutput
) ) {
3633 foreach ( $this->mParserOutput
->getTemplates() as $ns => $template ) {
3634 foreach ( array_keys( $template ) as $dbk ) {
3635 $templates[] = Title
::makeTitle( $ns, $dbk );
3640 return $this->mTitle
->getTemplateLinksFrom();
3645 * Shows a bulletin board style toolbar for common editing functions.
3646 * It can be disabled in the user preferences.
3650 static function getEditToolbar() {
3651 global $wgContLang, $wgOut;
3652 global $wgEnableUploads, $wgForeignFileRepos;
3654 $imagesAvailable = $wgEnableUploads ||
count( $wgForeignFileRepos );
3657 * $toolarray is an array of arrays each of which includes the
3658 * opening tag, the closing tag, optionally a sample text that is
3659 * inserted between the two when no selection is highlighted
3660 * and. The tip text is shown when the user moves the mouse
3663 * Images are defined in ResourceLoaderEditToolbarModule.
3667 'id' => 'mw-editbutton-bold',
3669 'close' => '\'\'\'',
3670 'sample' => wfMessage( 'bold_sample' )->text(),
3671 'tip' => wfMessage( 'bold_tip' )->text(),
3674 'id' => 'mw-editbutton-italic',
3677 'sample' => wfMessage( 'italic_sample' )->text(),
3678 'tip' => wfMessage( 'italic_tip' )->text(),
3681 'id' => 'mw-editbutton-link',
3684 'sample' => wfMessage( 'link_sample' )->text(),
3685 'tip' => wfMessage( 'link_tip' )->text(),
3688 'id' => 'mw-editbutton-extlink',
3691 'sample' => wfMessage( 'extlink_sample' )->text(),
3692 'tip' => wfMessage( 'extlink_tip' )->text(),
3695 'id' => 'mw-editbutton-headline',
3698 'sample' => wfMessage( 'headline_sample' )->text(),
3699 'tip' => wfMessage( 'headline_tip' )->text(),
3701 $imagesAvailable ?
array(
3702 'id' => 'mw-editbutton-image',
3703 'open' => '[[' . $wgContLang->getNsText( NS_FILE
) . ':',
3705 'sample' => wfMessage( 'image_sample' )->text(),
3706 'tip' => wfMessage( 'image_tip' )->text(),
3708 $imagesAvailable ?
array(
3709 'id' => 'mw-editbutton-media',
3710 'open' => '[[' . $wgContLang->getNsText( NS_MEDIA
) . ':',
3712 'sample' => wfMessage( 'media_sample' )->text(),
3713 'tip' => wfMessage( 'media_tip' )->text(),
3716 'id' => 'mw-editbutton-nowiki',
3717 'open' => "<nowiki>",
3718 'close' => "</nowiki>",
3719 'sample' => wfMessage( 'nowiki_sample' )->text(),
3720 'tip' => wfMessage( 'nowiki_tip' )->text(),
3723 'id' => 'mw-editbutton-signature',
3727 'tip' => wfMessage( 'sig_tip' )->text(),
3730 'id' => 'mw-editbutton-hr',
3731 'open' => "\n----\n",
3734 'tip' => wfMessage( 'hr_tip' )->text(),
3738 $script = 'mw.loader.using("mediawiki.toolbar", function () {';
3739 foreach ( $toolarray as $tool ) {
3745 // Images are defined in ResourceLoaderEditToolbarModule
3747 // Note that we use the tip both for the ALT tag and the TITLE tag of the image.
3748 // Older browsers show a "speedtip" type message only for ALT.
3749 // Ideally these should be different, realistically they
3750 // probably don't need to be.
3758 $script .= Xml
::encodeJsCall(
3759 'mw.toolbar.addButton',
3761 ResourceLoader
::inDebugMode()
3766 $wgOut->addScript( Html
::inlineScript( ResourceLoader
::makeLoaderConditionalScript( $script ) ) );
3768 $toolbar = '<div id="toolbar"></div>';
3770 Hooks
::run( 'EditPageBeforeEditToolbar', array( &$toolbar ) );
3776 * Returns an array of html code of the following checkboxes:
3779 * @param int $tabindex Current tabindex
3780 * @param array $checked Array of checkbox => bool, where bool indicates the checked
3781 * status of the checkbox
3785 public function getCheckboxes( &$tabindex, $checked ) {
3786 global $wgUser, $wgUseMediaWikiUIEverywhere;
3788 $checkboxes = array();
3790 // don't show the minor edit checkbox if it's a new page or section
3791 if ( !$this->isNew
) {
3792 $checkboxes['minor'] = '';
3793 $minorLabel = wfMessage( 'minoredit' )->parse();
3794 if ( $wgUser->isAllowed( 'minoredit' ) ) {
3796 'tabindex' => ++
$tabindex,
3797 'accesskey' => wfMessage( 'accesskey-minoredit' )->text(),
3798 'id' => 'wpMinoredit',
3801 Xml
::check( 'wpMinoredit', $checked['minor'], $attribs ) .
3802 " <label for='wpMinoredit' id='mw-editpage-minoredit'" .
3803 Xml
::expandAttributes( array( 'title' => Linker
::titleAttrib( 'minoredit', 'withaccess' ) ) ) .
3804 ">{$minorLabel}</label>";
3806 if ( $wgUseMediaWikiUIEverywhere ) {
3807 $checkboxes['minor'] = Html
::openElement( 'div', array( 'class' => 'mw-ui-checkbox' ) ) .
3809 Html
::closeElement( 'div' );
3811 $checkboxes['minor'] = $minorEditHtml;
3816 $watchLabel = wfMessage( 'watchthis' )->parse();
3817 $checkboxes['watch'] = '';
3818 if ( $wgUser->isLoggedIn() ) {
3820 'tabindex' => ++
$tabindex,
3821 'accesskey' => wfMessage( 'accesskey-watch' )->text(),
3822 'id' => 'wpWatchthis',
3825 Xml
::check( 'wpWatchthis', $checked['watch'], $attribs ) .
3826 " <label for='wpWatchthis' id='mw-editpage-watch'" .
3827 Xml
::expandAttributes( array( 'title' => Linker
::titleAttrib( 'watch', 'withaccess' ) ) ) .
3828 ">{$watchLabel}</label>";
3829 if ( $wgUseMediaWikiUIEverywhere ) {
3830 $checkboxes['watch'] = Html
::openElement( 'div', array( 'class' => 'mw-ui-checkbox' ) ) .
3832 Html
::closeElement( 'div' );
3834 $checkboxes['watch'] = $watchThisHtml;
3837 Hooks
::run( 'EditPageBeforeEditChecks', array( &$this, &$checkboxes, &$tabindex ) );
3842 * Returns an array of html code of the following buttons:
3843 * save, diff, preview and live
3845 * @param int $tabindex Current tabindex
3849 public function getEditButtons( &$tabindex ) {
3855 'tabindex' => ++
$tabindex,
3856 ) + Linker
::tooltipAndAccesskeyAttribs( 'save' );
3857 $buttons['save'] = Html
::submitButton( wfMessage( 'savearticle' )->text(),
3858 $attribs, array( 'mw-ui-constructive' ) );
3860 ++
$tabindex; // use the same for preview and live preview
3862 'id' => 'wpPreview',
3863 'name' => 'wpPreview',
3864 'tabindex' => $tabindex,
3865 ) + Linker
::tooltipAndAccesskeyAttribs( 'preview' );
3866 $buttons['preview'] = Html
::submitButton( wfMessage( 'showpreview' )->text(),
3868 $buttons['live'] = '';
3873 'tabindex' => ++
$tabindex,
3874 ) + Linker
::tooltipAndAccesskeyAttribs( 'diff' );
3875 $buttons['diff'] = Html
::submitButton( wfMessage( 'showdiff' )->text(),
3878 Hooks
::run( 'EditPageBeforeEditButtons', array( &$this, &$buttons, &$tabindex ) );
3883 * Output preview text only. This can be sucked into the edit page
3884 * via JavaScript, and saves the server time rendering the skin as
3885 * well as theoretically being more robust on the client (doesn't
3886 * disturb the edit box's undo history, won't eat your text on
3889 * @todo This doesn't include category or interlanguage links.
3890 * Would need to enhance it a bit, "<s>maybe wrap them in XML
3891 * or something...</s>" that might also require more skin
3892 * initialization, so check whether that's a problem.
3894 function livePreview() {
3897 header( 'Content-type: text/xml; charset=utf-8' );
3898 header( 'Cache-control: no-cache' );
3900 $previewText = $this->getPreviewText();
3901 #$categories = $skin->getCategoryLinks();
3904 '<?xml version="1.0" encoding="UTF-8" ?>' . "\n" .
3905 Xml
::tags( 'livepreview', null,
3906 Xml
::element( 'preview', null, $previewText )
3907 #. Xml::element( 'category', null, $categories )
3913 * Creates a basic error page which informs the user that
3914 * they have attempted to edit a nonexistent section.
3916 function noSuchSectionPage() {
3919 $wgOut->prepareErrorPage( wfMessage( 'nosuchsectiontitle' ) );
3921 $res = wfMessage( 'nosuchsectiontext', $this->section
)->parseAsBlock();
3922 Hooks
::run( 'EditPageNoSuchSection', array( &$this, &$res ) );
3923 $wgOut->addHTML( $res );
3925 $wgOut->returnToMain( false, $this->mTitle
);
3929 * Show "your edit contains spam" page with your diff and text
3931 * @param string|array|bool $match Text (or array of texts) which triggered one or more filters
3933 public function spamPageWithContent( $match = false ) {
3934 global $wgOut, $wgLang;
3935 $this->textbox2
= $this->textbox1
;
3937 if ( is_array( $match ) ) {
3938 $match = $wgLang->listToText( $match );
3940 $wgOut->prepareErrorPage( wfMessage( 'spamprotectiontitle' ) );
3942 $wgOut->addHTML( '<div id="spamprotected">' );
3943 $wgOut->addWikiMsg( 'spamprotectiontext' );
3945 $wgOut->addWikiMsg( 'spamprotectionmatch', wfEscapeWikiText( $match ) );
3947 $wgOut->addHTML( '</div>' );
3949 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
3952 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
3953 $this->showTextbox2();
3955 $wgOut->addReturnTo( $this->getContextTitle(), array( 'action' => 'edit' ) );
3959 * Check if the browser is on a blacklist of user-agents known to
3960 * mangle UTF-8 data on form submission. Returns true if Unicode
3961 * should make it through, false if it's known to be a problem.
3964 private function checkUnicodeCompliantBrowser() {
3965 global $wgBrowserBlackList, $wgRequest;
3967 $currentbrowser = $wgRequest->getHeader( 'User-Agent' );
3968 if ( $currentbrowser === false ) {
3969 // No User-Agent header sent? Trust it by default...
3973 foreach ( $wgBrowserBlackList as $browser ) {
3974 if ( preg_match( $browser, $currentbrowser ) ) {
3982 * Filter an input field through a Unicode de-armoring process if it
3983 * came from an old browser with known broken Unicode editing issues.
3985 * @param WebRequest $request
3986 * @param string $field
3989 protected function safeUnicodeInput( $request, $field ) {
3990 $text = rtrim( $request->getText( $field ) );
3991 return $request->getBool( 'safemode' )
3992 ?
$this->unmakeSafe( $text )
3997 * Filter an output field through a Unicode armoring process if it is
3998 * going to an old browser with known broken Unicode editing issues.
4000 * @param string $text
4003 protected function safeUnicodeOutput( $text ) {
4005 $codedText = $wgContLang->recodeForEdit( $text );
4006 return $this->checkUnicodeCompliantBrowser()
4008 : $this->makeSafe( $codedText );
4012 * A number of web browsers are known to corrupt non-ASCII characters
4013 * in a UTF-8 text editing environment. To protect against this,
4014 * detected browsers will be served an armored version of the text,
4015 * with non-ASCII chars converted to numeric HTML character references.
4017 * Preexisting such character references will have a 0 added to them
4018 * to ensure that round-trips do not alter the original data.
4020 * @param string $invalue
4023 private function makeSafe( $invalue ) {
4024 // Armor existing references for reversibility.
4025 $invalue = strtr( $invalue, array( "&#x" => "�" ) );
4030 $valueLength = strlen( $invalue );
4031 for ( $i = 0; $i < $valueLength; $i++
) {
4032 $bytevalue = ord( $invalue[$i] );
4033 if ( $bytevalue <= 0x7F ) { // 0xxx xxxx
4034 $result .= chr( $bytevalue );
4036 } elseif ( $bytevalue <= 0xBF ) { // 10xx xxxx
4037 $working = $working << 6;
4038 $working +
= ( $bytevalue & 0x3F );
4040 if ( $bytesleft <= 0 ) {
4041 $result .= "&#x" . strtoupper( dechex( $working ) ) . ";";
4043 } elseif ( $bytevalue <= 0xDF ) { // 110x xxxx
4044 $working = $bytevalue & 0x1F;
4046 } elseif ( $bytevalue <= 0xEF ) { // 1110 xxxx
4047 $working = $bytevalue & 0x0F;
4049 } else { // 1111 0xxx
4050 $working = $bytevalue & 0x07;
4058 * Reverse the previously applied transliteration of non-ASCII characters
4059 * back to UTF-8. Used to protect data from corruption by broken web browsers
4060 * as listed in $wgBrowserBlackList.
4062 * @param string $invalue
4065 private function unmakeSafe( $invalue ) {
4067 $valueLength = strlen( $invalue );
4068 for ( $i = 0; $i < $valueLength; $i++
) {
4069 if ( ( substr( $invalue, $i, 3 ) == "&#x" ) && ( $invalue[$i +
3] != '0' ) ) {
4073 $hexstring .= $invalue[$i];
4075 } while ( ctype_xdigit( $invalue[$i] ) && ( $i < strlen( $invalue ) ) );
4077 // Do some sanity checks. These aren't needed for reversibility,
4078 // but should help keep the breakage down if the editor
4079 // breaks one of the entities whilst editing.
4080 if ( ( substr( $invalue, $i, 1 ) == ";" ) && ( strlen( $hexstring ) <= 6 ) ) {
4081 $codepoint = hexdec( $hexstring );
4082 $result .= codepointToUtf8( $codepoint );
4084 $result .= "&#x" . $hexstring . substr( $invalue, $i, 1 );
4087 $result .= substr( $invalue, $i, 1 );
4090 // reverse the transform that we made for reversibility reasons.
4091 return strtr( $result, array( "�" => "&#x" ) );