3 * User interface for page editing.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
24 * The edit page/HTML interface (split from Article)
25 * The actual database and text munging is still in Article,
26 * but it should get easier to call those from alternate
29 * EditPage cares about two distinct titles:
30 * $this->mContextTitle is the page that forms submit to, links point to,
31 * redirects go to, etc. $this->mTitle (as well as $mArticle) is the
32 * page in the database that is actually being edited. These are
33 * usually the same, but they are now allowed to be different.
35 * Surgeon General's Warning: prolonged exposure to this class is known to cause
36 * headaches, which may be fatal.
40 * Status: Article successfully updated
42 const AS_SUCCESS_UPDATE
= 200;
45 * Status: Article successfully created
47 const AS_SUCCESS_NEW_ARTICLE
= 201;
50 * Status: Article update aborted by a hook function
52 const AS_HOOK_ERROR
= 210;
55 * Status: A hook function returned an error
57 const AS_HOOK_ERROR_EXPECTED
= 212;
60 * Status: User is blocked from editing this page
62 const AS_BLOCKED_PAGE_FOR_USER
= 215;
65 * Status: Content too big (> $wgMaxArticleSize)
67 const AS_CONTENT_TOO_BIG
= 216;
70 * Status: this anonymous user is not allowed to edit this page
72 const AS_READ_ONLY_PAGE_ANON
= 218;
75 * Status: this logged in user is not allowed to edit this page
77 const AS_READ_ONLY_PAGE_LOGGED
= 219;
80 * Status: wiki is in readonly mode (wfReadOnly() == true)
82 const AS_READ_ONLY_PAGE
= 220;
85 * Status: rate limiter for action 'edit' was tripped
87 const AS_RATE_LIMITED
= 221;
90 * Status: article was deleted while editing and param wpRecreate == false or form
93 const AS_ARTICLE_WAS_DELETED
= 222;
96 * Status: user tried to create this page, but is not allowed to do that
97 * ( Title->userCan('create') == false )
99 const AS_NO_CREATE_PERMISSION
= 223;
102 * Status: user tried to create a blank page and wpIgnoreBlankArticle == false
104 const AS_BLANK_ARTICLE
= 224;
107 * Status: (non-resolvable) edit conflict
109 const AS_CONFLICT_DETECTED
= 225;
112 * Status: no edit summary given and the user has forceeditsummary set and the user is not
113 * editing in his own userspace or talkspace and wpIgnoreBlankSummary == false
115 const AS_SUMMARY_NEEDED
= 226;
118 * Status: user tried to create a new section without content
120 const AS_TEXTBOX_EMPTY
= 228;
123 * Status: article is too big (> $wgMaxArticleSize), after merging in the new section
125 const AS_MAX_ARTICLE_SIZE_EXCEEDED
= 229;
128 * Status: WikiPage::doEdit() was unsuccessful
133 * Status: summary contained spam according to one of the regexes in $wgSummarySpamRegex
135 const AS_SPAM_ERROR
= 232;
138 * Status: anonymous user is not allowed to upload (User::isAllowed('upload') == false)
140 const AS_IMAGE_REDIRECT_ANON
= 233;
143 * Status: logged in user is not allowed to upload (User::isAllowed('upload') == false)
145 const AS_IMAGE_REDIRECT_LOGGED
= 234;
148 * Status: user tried to modify the content model, but is not allowed to do that
149 * ( User::isAllowed('editcontentmodel') == false )
151 const AS_NO_CHANGE_CONTENT_MODEL
= 235;
154 * Status: user tried to create self-redirect (redirect to the same article) and
155 * wpIgnoreSelfRedirect == false
157 const AS_SELF_REDIRECT
= 236;
160 * Status: an error relating to change tagging. Look at the message key for
163 const AS_CHANGE_TAG_ERROR
= 237;
166 * Status: can't parse content
168 const AS_PARSE_ERROR
= 240;
171 * Status: when changing the content model is disallowed due to
172 * $wgContentHandlerUseDB being false
174 const AS_CANNOT_USE_CUSTOM_MODEL
= 241;
177 * HTML id and name for the beginning of the edit form.
179 const EDITFORM_ID
= 'editform';
182 * Prefix of key for cookie used to pass post-edit state.
183 * The revision id edited is added after this
185 const POST_EDIT_COOKIE_KEY_PREFIX
= 'PostEditRevision';
188 * Duration of PostEdit cookie, in seconds.
189 * The cookie will be removed instantly if the JavaScript runs.
191 * Otherwise, though, we don't want the cookies to accumulate.
192 * RFC 2109 ( https://www.ietf.org/rfc/rfc2109.txt ) specifies a possible
193 * limit of only 20 cookies per domain. This still applies at least to some
194 * versions of IE without full updates:
195 * https://blogs.msdn.com/b/ieinternals/archive/2009/08/20/wininet-ie-cookie-internals-faq.aspx
197 * A value of 20 minutes should be enough to take into account slow loads and minor
198 * clock skew while still avoiding cookie accumulation when JavaScript is turned off.
200 const POST_EDIT_COOKIE_DURATION
= 1200;
208 /** @var null|Title */
209 private $mContextTitle = null;
212 public $action = 'submit';
215 public $isConflict = false;
218 public $isCssJsSubpage = false;
221 public $isCssSubpage = false;
224 public $isJsSubpage = false;
227 public $isWrongCaseCssJsPage = false;
229 /** @var bool New page or new section */
230 public $isNew = false;
233 public $deletedSinceEdit;
241 /** @var bool|stdClass */
245 public $mTokenOk = false;
248 public $mTokenOkExceptSuffix = false;
251 public $mTriedSave = false;
254 public $incompleteForm = false;
257 public $tooBig = false;
260 public $kblength = false;
263 public $missingComment = false;
266 public $missingSummary = false;
269 public $allowBlankSummary = false;
272 protected $blankArticle = false;
275 protected $allowBlankArticle = false;
278 protected $selfRedirect = false;
281 protected $allowSelfRedirect = false;
284 public $autoSumm = '';
287 public $hookError = '';
289 /** @var ParserOutput */
290 public $mParserOutput;
292 /** @var bool Has a summary been preset using GET parameter &summary= ? */
293 public $hasPresetSummary = false;
296 public $mBaseRevision = false;
299 public $mShowSummaryField = true;
304 public $save = false;
307 public $preview = false;
310 public $diff = false;
313 public $minoredit = false;
316 public $watchthis = false;
319 public $recreate = false;
322 public $textbox1 = '';
325 public $textbox2 = '';
328 public $summary = '';
331 public $nosummary = false;
334 public $edittime = '';
337 public $section = '';
340 public $sectiontitle = '';
343 public $starttime = '';
349 public $parentRevId = 0;
352 public $editintro = '';
355 public $scrolltop = null;
360 /** @var null|string */
361 public $contentModel = null;
363 /** @var null|string */
364 public $contentFormat = null;
366 /** @var null|array */
367 public $changeTags = null;
369 # Placeholders for text injection by hooks (must be HTML)
370 # extensions should take care to _append_ to the present value
372 /** @var string Before even the preview */
373 public $editFormPageTop = '';
374 public $editFormTextTop = '';
375 public $editFormTextBeforeContent = '';
376 public $editFormTextAfterWarn = '';
377 public $editFormTextAfterTools = '';
378 public $editFormTextBottom = '';
379 public $editFormTextAfterContent = '';
380 public $previewTextAfterContent = '';
381 public $mPreloadContent = null;
383 /* $didSave should be set to true whenever an article was successfully altered. */
384 public $didSave = false;
385 public $undidRev = 0;
387 public $suppressIntro = false;
393 * @var bool Set in ApiEditPage, based on ContentHandler::allowsDirectApiEditing
395 private $enableApiEditOverride = false;
398 * @param Article $article
400 public function __construct( Article
$article ) {
401 $this->mArticle
= $article;
402 $this->mTitle
= $article->getTitle();
404 $this->contentModel
= $this->mTitle
->getContentModel();
406 $handler = ContentHandler
::getForModelID( $this->contentModel
);
407 $this->contentFormat
= $handler->getDefaultFormat();
413 public function getArticle() {
414 return $this->mArticle
;
421 public function getTitle() {
422 return $this->mTitle
;
426 * Set the context Title object
428 * @param Title|null $title Title object or null
430 public function setContextTitle( $title ) {
431 $this->mContextTitle
= $title;
435 * Get the context title object.
436 * If not set, $wgTitle will be returned. This behavior might change in
437 * the future to return $this->mTitle instead.
441 public function getContextTitle() {
442 if ( is_null( $this->mContextTitle
) ) {
446 return $this->mContextTitle
;
451 * Returns if the given content model is editable.
453 * @param string $modelId The ID of the content model to test. Use CONTENT_MODEL_XXX constants.
455 * @throws MWException If $modelId has no known handler
457 public function isSupportedContentModel( $modelId ) {
458 return $this->enableApiEditOverride
=== true ||
459 ContentHandler
::getForModelID( $modelId )->supportsDirectEditing();
463 * Allow editing of content that supports API direct editing, but not general
464 * direct editing. Set to false by default.
466 * @param bool $enableOverride
468 public function setApiEditOverride( $enableOverride ) {
469 $this->enableApiEditOverride
= $enableOverride;
477 * This is the function that gets called for "action=edit". It
478 * sets up various member variables, then passes execution to
479 * another function, usually showEditForm()
481 * The edit form is self-submitting, so that when things like
482 * preview and edit conflicts occur, we get the same form back
483 * with the extra stuff added. Only when the final submission
484 * is made and all is well do we actually save and redirect to
485 * the newly-edited page.
488 global $wgOut, $wgRequest, $wgUser;
489 // Allow extensions to modify/prevent this form or submission
490 if ( !Hooks
::run( 'AlternateEdit', array( $this ) ) ) {
494 wfDebug( __METHOD__
. ": enter\n" );
496 // If they used redlink=1 and the page exists, redirect to the main article
497 if ( $wgRequest->getBool( 'redlink' ) && $this->mTitle
->exists() ) {
498 $wgOut->redirect( $this->mTitle
->getFullURL() );
502 $this->importFormData( $wgRequest );
503 $this->firsttime
= false;
505 if ( wfReadOnly() && $this->save
) {
508 $this->preview
= true;
512 $this->formtype
= 'save';
513 } elseif ( $this->preview
) {
514 $this->formtype
= 'preview';
515 } elseif ( $this->diff
) {
516 $this->formtype
= 'diff';
517 } else { # First time through
518 $this->firsttime
= true;
519 if ( $this->previewOnOpen() ) {
520 $this->formtype
= 'preview';
522 $this->formtype
= 'initial';
526 $permErrors = $this->getEditPermissionErrors( $this->save ?
'secure' : 'full' );
528 wfDebug( __METHOD__
. ": User can't edit\n" );
529 // Auto-block user's IP if the account was "hard" blocked
531 DeferredUpdates
::addCallableUpdate( function() use ( $user ) {
532 $user->spreadAnyEditBlock();
535 $this->displayPermissionsError( $permErrors );
540 $this->isConflict
= false;
541 // css / js subpages of user pages get a special treatment
542 $this->isCssJsSubpage
= $this->mTitle
->isCssJsSubpage();
543 $this->isCssSubpage
= $this->mTitle
->isCssSubpage();
544 $this->isJsSubpage
= $this->mTitle
->isJsSubpage();
545 // @todo FIXME: Silly assignment.
546 $this->isWrongCaseCssJsPage
= $this->isWrongCaseCssJsPage();
548 # Show applicable editing introductions
549 if ( $this->formtype
== 'initial' ||
$this->firsttime
) {
553 # Attempt submission here. This will check for edit conflicts,
554 # and redundantly check for locked database, blocked IPs, etc.
555 # that edit() already checked just in case someone tries to sneak
556 # in the back door with a hand-edited submission URL.
558 if ( 'save' == $this->formtype
) {
559 $resultDetails = null;
560 $status = $this->attemptSave( $resultDetails );
561 if ( !$this->handleStatus( $status, $resultDetails ) ) {
566 # First time through: get contents, set time for conflict
568 if ( 'initial' == $this->formtype ||
$this->firsttime
) {
569 if ( $this->initialiseForm() === false ) {
570 $this->noSuchSectionPage();
574 if ( !$this->mTitle
->getArticleID() ) {
575 Hooks
::run( 'EditFormPreloadText', array( &$this->textbox1
, &$this->mTitle
) );
577 Hooks
::run( 'EditFormInitialText', array( $this ) );
582 $this->showEditForm();
586 * @param string $rigor Same format as Title::getUserPermissionErrors()
589 protected function getEditPermissionErrors( $rigor = 'secure' ) {
592 $permErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $wgUser, $rigor );
593 # Can this title be created?
594 if ( !$this->mTitle
->exists() ) {
595 $permErrors = array_merge(
598 $this->mTitle
->getUserPermissionsErrors( 'create', $wgUser, $rigor ),
603 # Ignore some permissions errors when a user is just previewing/viewing diffs
605 foreach ( $permErrors as $error ) {
606 if ( ( $this->preview ||
$this->diff
)
607 && ( $error[0] == 'blockedtext' ||
$error[0] == 'autoblockedtext' )
612 $permErrors = wfArrayDiff2( $permErrors, $remove );
618 * Display a permissions error page, like OutputPage::showPermissionsErrorPage(),
619 * but with the following differences:
620 * - If redlink=1, the user will be redirected to the page
621 * - If there is content to display or the error occurs while either saving,
622 * previewing or showing the difference, it will be a
623 * "View source for ..." page displaying the source code after the error message.
626 * @param array $permErrors Array of permissions errors, as returned by
627 * Title::getUserPermissionsErrors().
628 * @throws PermissionsError
630 protected function displayPermissionsError( array $permErrors ) {
631 global $wgRequest, $wgOut;
633 if ( $wgRequest->getBool( 'redlink' ) ) {
634 // The edit page was reached via a red link.
635 // Redirect to the article page and let them click the edit tab if
636 // they really want a permission error.
637 $wgOut->redirect( $this->mTitle
->getFullURL() );
641 $content = $this->getContentObject();
643 # Use the normal message if there's nothing to display
644 if ( $this->firsttime
&& ( !$content ||
$content->isEmpty() ) ) {
645 $action = $this->mTitle
->exists() ?
'edit' :
646 ( $this->mTitle
->isTalkPage() ?
'createtalk' : 'createpage' );
647 throw new PermissionsError( $action, $permErrors );
650 Hooks
::run( 'EditPage::showReadOnlyForm:initial', array( $this, &$wgOut ) );
652 $wgOut->setRobotPolicy( 'noindex,nofollow' );
653 $wgOut->setPageTitle( wfMessage(
655 $this->getContextTitle()->getPrefixedText()
657 $wgOut->addBacklinkSubtitle( $this->getContextTitle() );
658 $wgOut->addHTML( $this->editFormPageTop
);
659 $wgOut->addHTML( $this->editFormTextTop
);
661 $wgOut->addWikiText( $wgOut->formatPermissionsErrorMessage( $permErrors, 'edit' ) );
662 $wgOut->addHTML( "<hr />\n" );
664 # If the user made changes, preserve them when showing the markup
665 # (This happens when a user is blocked during edit, for instance)
666 if ( !$this->firsttime
) {
667 $text = $this->textbox1
;
668 $wgOut->addWikiMsg( 'viewyourtext' );
670 $text = $this->toEditText( $content );
671 $wgOut->addWikiMsg( 'viewsourcetext' );
674 $wgOut->addHTML( $this->editFormTextBeforeContent
);
675 $this->showTextbox( $text, 'wpTextbox1', array( 'readonly' ) );
676 $wgOut->addHTML( $this->editFormTextAfterContent
);
678 $wgOut->addHTML( Html
::rawElement( 'div', array( 'class' => 'templatesUsed' ),
679 Linker
::formatTemplates( $this->getTemplates() ) ) );
681 $wgOut->addModules( 'mediawiki.action.edit.collapsibleFooter' );
683 $wgOut->addHTML( $this->editFormTextBottom
);
684 if ( $this->mTitle
->exists() ) {
685 $wgOut->returnToMain( null, $this->mTitle
);
690 * Should we show a preview when the edit form is first shown?
694 protected function previewOnOpen() {
695 global $wgRequest, $wgUser, $wgPreviewOnOpenNamespaces;
696 if ( $wgRequest->getVal( 'preview' ) == 'yes' ) {
697 // Explicit override from request
699 } elseif ( $wgRequest->getVal( 'preview' ) == 'no' ) {
700 // Explicit override from request
702 } elseif ( $this->section
== 'new' ) {
703 // Nothing *to* preview for new sections
705 } elseif ( ( $wgRequest->getVal( 'preload' ) !== null ||
$this->mTitle
->exists() )
706 && $wgUser->getOption( 'previewonfirst' )
708 // Standard preference behavior
710 } elseif ( !$this->mTitle
->exists()
711 && isset( $wgPreviewOnOpenNamespaces[$this->mTitle
->getNamespace()] )
712 && $wgPreviewOnOpenNamespaces[$this->mTitle
->getNamespace()]
714 // Categories are special
722 * Checks whether the user entered a skin name in uppercase,
723 * e.g. "User:Example/Monobook.css" instead of "monobook.css"
727 protected function isWrongCaseCssJsPage() {
728 if ( $this->mTitle
->isCssJsSubpage() ) {
729 $name = $this->mTitle
->getSkinFromCssJsSubpage();
730 $skins = array_merge(
731 array_keys( Skin
::getSkinNames() ),
734 return !in_array( $name, $skins )
735 && in_array( strtolower( $name ), $skins );
742 * Returns whether section editing is supported for the current page.
743 * Subclasses may override this to replace the default behavior, which is
744 * to check ContentHandler::supportsSections.
746 * @return bool True if this edit page supports sections, false otherwise.
748 protected function isSectionEditSupported() {
749 $contentHandler = ContentHandler
::getForTitle( $this->mTitle
);
750 return $contentHandler->supportsSections();
754 * This function collects the form data and uses it to populate various member variables.
755 * @param WebRequest $request
756 * @throws ErrorPageError
758 function importFormData( &$request ) {
759 global $wgContLang, $wgUser;
761 # Section edit can come from either the form or a link
762 $this->section
= $request->getVal( 'wpSection', $request->getVal( 'section' ) );
764 if ( $this->section
!== null && $this->section
!== '' && !$this->isSectionEditSupported() ) {
765 throw new ErrorPageError( 'sectioneditnotsupported-title', 'sectioneditnotsupported-text' );
768 $this->isNew
= !$this->mTitle
->exists() ||
$this->section
== 'new';
770 if ( $request->wasPosted() ) {
771 # These fields need to be checked for encoding.
772 # Also remove trailing whitespace, but don't remove _initial_
773 # whitespace from the text boxes. This may be significant formatting.
774 $this->textbox1
= $this->safeUnicodeInput( $request, 'wpTextbox1' );
775 if ( !$request->getCheck( 'wpTextbox2' ) ) {
776 // Skip this if wpTextbox2 has input, it indicates that we came
777 // from a conflict page with raw page text, not a custom form
778 // modified by subclasses
779 $textbox1 = $this->importContentFormData( $request );
780 if ( $textbox1 !== null ) {
781 $this->textbox1
= $textbox1;
785 # Truncate for whole multibyte characters
786 $this->summary
= $wgContLang->truncate( $request->getText( 'wpSummary' ), 255 );
788 # If the summary consists of a heading, e.g. '==Foobar==', extract the title from the
789 # header syntax, e.g. 'Foobar'. This is mainly an issue when we are using wpSummary for
791 $this->summary
= preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->summary
);
793 # Treat sectiontitle the same way as summary.
794 # Note that wpSectionTitle is not yet a part of the actual edit form, as wpSummary is
795 # currently doing double duty as both edit summary and section title. Right now this
796 # is just to allow API edits to work around this limitation, but this should be
797 # incorporated into the actual edit form when EditPage is rewritten (Bugs 18654, 26312).
798 $this->sectiontitle
= $wgContLang->truncate( $request->getText( 'wpSectionTitle' ), 255 );
799 $this->sectiontitle
= preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->sectiontitle
);
801 $this->edittime
= $request->getVal( 'wpEdittime' );
802 $this->starttime
= $request->getVal( 'wpStarttime' );
804 $undidRev = $request->getInt( 'wpUndidRevision' );
806 $this->undidRev
= $undidRev;
809 $this->scrolltop
= $request->getIntOrNull( 'wpScrolltop' );
811 if ( $this->textbox1
=== '' && $request->getVal( 'wpTextbox1' ) === null ) {
812 // wpTextbox1 field is missing, possibly due to being "too big"
813 // according to some filter rules such as Suhosin's setting for
814 // suhosin.request.max_value_length (d'oh)
815 $this->incompleteForm
= true;
817 // If we receive the last parameter of the request, we can fairly
818 // claim the POST request has not been truncated.
820 // TODO: softened the check for cutover. Once we determine
821 // that it is safe, we should complete the transition by
822 // removing the "edittime" clause.
823 $this->incompleteForm
= ( !$request->getVal( 'wpUltimateParam' )
824 && is_null( $this->edittime
) );
826 if ( $this->incompleteForm
) {
827 # If the form is incomplete, force to preview.
828 wfDebug( __METHOD__
. ": Form data appears to be incomplete\n" );
829 wfDebug( "POST DATA: " . var_export( $_POST, true ) . "\n" );
830 $this->preview
= true;
832 $this->preview
= $request->getCheck( 'wpPreview' );
833 $this->diff
= $request->getCheck( 'wpDiff' );
835 // Remember whether a save was requested, so we can indicate
836 // if we forced preview due to session failure.
837 $this->mTriedSave
= !$this->preview
;
839 if ( $this->tokenOk( $request ) ) {
840 # Some browsers will not report any submit button
841 # if the user hits enter in the comment box.
842 # The unmarked state will be assumed to be a save,
843 # if the form seems otherwise complete.
844 wfDebug( __METHOD__
. ": Passed token check.\n" );
845 } elseif ( $this->diff
) {
846 # Failed token check, but only requested "Show Changes".
847 wfDebug( __METHOD__
. ": Failed token check; Show Changes requested.\n" );
849 # Page might be a hack attempt posted from
850 # an external site. Preview instead of saving.
851 wfDebug( __METHOD__
. ": Failed token check; forcing preview\n" );
852 $this->preview
= true;
855 $this->save
= !$this->preview
&& !$this->diff
;
856 if ( !preg_match( '/^\d{14}$/', $this->edittime
) ) {
857 $this->edittime
= null;
860 if ( !preg_match( '/^\d{14}$/', $this->starttime
) ) {
861 $this->starttime
= null;
864 $this->recreate
= $request->getCheck( 'wpRecreate' );
866 $this->minoredit
= $request->getCheck( 'wpMinoredit' );
867 $this->watchthis
= $request->getCheck( 'wpWatchthis' );
869 # Don't force edit summaries when a user is editing their own user or talk page
870 if ( ( $this->mTitle
->mNamespace
== NS_USER ||
$this->mTitle
->mNamespace
== NS_USER_TALK
)
871 && $this->mTitle
->getText() == $wgUser->getName()
873 $this->allowBlankSummary
= true;
875 $this->allowBlankSummary
= $request->getBool( 'wpIgnoreBlankSummary' )
876 ||
!$wgUser->getOption( 'forceeditsummary' );
879 $this->autoSumm
= $request->getText( 'wpAutoSummary' );
881 $this->allowBlankArticle
= $request->getBool( 'wpIgnoreBlankArticle' );
882 $this->allowSelfRedirect
= $request->getBool( 'wpIgnoreSelfRedirect' );
884 $changeTags = $request->getVal( 'wpChangeTags' );
885 if ( is_null( $changeTags ) ||
$changeTags === '' ) {
886 $this->changeTags
= array();
888 $this->changeTags
= array_filter( array_map( 'trim', explode( ',',
892 # Not a posted form? Start with nothing.
893 wfDebug( __METHOD__
. ": Not a posted form.\n" );
894 $this->textbox1
= '';
896 $this->sectiontitle
= '';
897 $this->edittime
= '';
898 $this->starttime
= wfTimestampNow();
900 $this->preview
= false;
903 $this->minoredit
= false;
904 // Watch may be overridden by request parameters
905 $this->watchthis
= $request->getBool( 'watchthis', false );
906 $this->recreate
= false;
908 // When creating a new section, we can preload a section title by passing it as the
909 // preloadtitle parameter in the URL (Bug 13100)
910 if ( $this->section
== 'new' && $request->getVal( 'preloadtitle' ) ) {
911 $this->sectiontitle
= $request->getVal( 'preloadtitle' );
912 // Once wpSummary isn't being use for setting section titles, we should delete this.
913 $this->summary
= $request->getVal( 'preloadtitle' );
914 } elseif ( $this->section
!= 'new' && $request->getVal( 'summary' ) ) {
915 $this->summary
= $request->getText( 'summary' );
916 if ( $this->summary
!== '' ) {
917 $this->hasPresetSummary
= true;
921 if ( $request->getVal( 'minor' ) ) {
922 $this->minoredit
= true;
926 $this->oldid
= $request->getInt( 'oldid' );
927 $this->parentRevId
= $request->getInt( 'parentRevId' );
929 $this->bot
= $request->getBool( 'bot', true );
930 $this->nosummary
= $request->getBool( 'nosummary' );
932 // May be overridden by revision.
933 $this->contentModel
= $request->getText( 'model', $this->contentModel
);
934 // May be overridden by revision.
935 $this->contentFormat
= $request->getText( 'format', $this->contentFormat
);
937 if ( !ContentHandler
::getForModelID( $this->contentModel
)
938 ->isSupportedFormat( $this->contentFormat
)
940 throw new ErrorPageError(
941 'editpage-notsupportedcontentformat-title',
942 'editpage-notsupportedcontentformat-text',
943 array( $this->contentFormat
, ContentHandler
::getLocalizedName( $this->contentModel
) )
948 * @todo Check if the desired model is allowed in this namespace, and if
949 * a transition from the page's current model to the new model is
953 $this->editintro
= $request->getText( 'editintro',
954 // Custom edit intro for new sections
955 $this->section
=== 'new' ?
'MediaWiki:addsection-editintro' : '' );
957 // Allow extensions to modify form data
958 Hooks
::run( 'EditPage::importFormData', array( $this, $request ) );
963 * Subpage overridable method for extracting the page content data from the
964 * posted form to be placed in $this->textbox1, if using customized input
965 * this method should be overridden and return the page text that will be used
966 * for saving, preview parsing and so on...
968 * @param WebRequest $request
970 protected function importContentFormData( &$request ) {
971 return; // Don't do anything, EditPage already extracted wpTextbox1
975 * Initialise form fields in the object
976 * Called on the first invocation, e.g. when a user clicks an edit link
977 * @return bool If the requested section is valid
979 function initialiseForm() {
981 $this->edittime
= $this->mArticle
->getTimestamp();
983 $content = $this->getContentObject( false ); # TODO: track content object?!
984 if ( $content === false ) {
987 $this->textbox1
= $this->toEditText( $content );
989 // activate checkboxes if user wants them to be always active
990 # Sort out the "watch" checkbox
991 if ( $wgUser->getOption( 'watchdefault' ) ) {
993 $this->watchthis
= true;
994 } elseif ( $wgUser->getOption( 'watchcreations' ) && !$this->mTitle
->exists() ) {
996 $this->watchthis
= true;
997 } elseif ( $wgUser->isWatched( $this->mTitle
) ) {
999 $this->watchthis
= true;
1001 if ( $wgUser->getOption( 'minordefault' ) && !$this->isNew
) {
1002 $this->minoredit
= true;
1004 if ( $this->textbox1
=== false ) {
1011 * @param Content|null $def_content The default value to return
1013 * @return Content|null Content on success, $def_content for invalid sections
1017 protected function getContentObject( $def_content = null ) {
1018 global $wgOut, $wgRequest, $wgUser, $wgContLang;
1022 // For message page not locally set, use the i18n message.
1023 // For other non-existent articles, use preload text if any.
1024 if ( !$this->mTitle
->exists() ||
$this->section
== 'new' ) {
1025 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
&& $this->section
!= 'new' ) {
1026 # If this is a system message, get the default text.
1027 $msg = $this->mTitle
->getDefaultMessageText();
1029 $content = $this->toEditContent( $msg );
1031 if ( $content === false ) {
1032 # If requested, preload some text.
1033 $preload = $wgRequest->getVal( 'preload',
1034 // Custom preload text for new sections
1035 $this->section
=== 'new' ?
'MediaWiki:addsection-preload' : '' );
1036 $params = $wgRequest->getArray( 'preloadparams', array() );
1038 $content = $this->getPreloadedContent( $preload, $params );
1040 // For existing pages, get text based on "undo" or section parameters.
1042 if ( $this->section
!= '' ) {
1043 // Get section edit text (returns $def_text for invalid sections)
1044 $orig = $this->getOriginalContent( $wgUser );
1045 $content = $orig ?
$orig->getSection( $this->section
) : null;
1048 $content = $def_content;
1051 $undoafter = $wgRequest->getInt( 'undoafter' );
1052 $undo = $wgRequest->getInt( 'undo' );
1054 if ( $undo > 0 && $undoafter > 0 ) {
1055 $undorev = Revision
::newFromId( $undo );
1056 $oldrev = Revision
::newFromId( $undoafter );
1058 # Sanity check, make sure it's the right page,
1059 # the revisions exist and they were not deleted.
1060 # Otherwise, $content will be left as-is.
1061 if ( !is_null( $undorev ) && !is_null( $oldrev ) &&
1062 !$undorev->isDeleted( Revision
::DELETED_TEXT
) &&
1063 !$oldrev->isDeleted( Revision
::DELETED_TEXT
)
1065 $content = $this->mArticle
->getUndoContent( $undorev, $oldrev );
1067 if ( $content === false ) {
1068 # Warn the user that something went wrong
1069 $undoMsg = 'failure';
1071 $oldContent = $this->mArticle
->getPage()->getContent( Revision
::RAW
);
1072 $popts = ParserOptions
::newFromUserAndLang( $wgUser, $wgContLang );
1073 $newContent = $content->preSaveTransform( $this->mTitle
, $wgUser, $popts );
1075 if ( $newContent->equals( $oldContent ) ) {
1076 # Tell the user that the undo results in no change,
1077 # i.e. the revisions were already undone.
1078 $undoMsg = 'nochange';
1081 # Inform the user of our success and set an automatic edit summary
1082 $undoMsg = 'success';
1084 # If we just undid one rev, use an autosummary
1085 $firstrev = $oldrev->getNext();
1086 if ( $firstrev && $firstrev->getId() == $undo ) {
1087 $userText = $undorev->getUserText();
1088 if ( $userText === '' ) {
1089 $undoSummary = wfMessage(
1090 'undo-summary-username-hidden',
1092 )->inContentLanguage()->text();
1094 $undoSummary = wfMessage(
1098 )->inContentLanguage()->text();
1100 if ( $this->summary
=== '' ) {
1101 $this->summary
= $undoSummary;
1103 $this->summary
= $undoSummary . wfMessage( 'colon-separator' )
1104 ->inContentLanguage()->text() . $this->summary
;
1106 $this->undidRev
= $undo;
1108 $this->formtype
= 'diff';
1112 // Failed basic sanity checks.
1113 // Older revisions may have been removed since the link
1114 // was created, or we may simply have got bogus input.
1118 // Messages: undo-success, undo-failure, undo-norev, undo-nochange
1119 $class = ( $undoMsg == 'success' ?
'' : 'error ' ) . "mw-undo-{$undoMsg}";
1120 $this->editFormPageTop
.= $wgOut->parse( "<div class=\"{$class}\">" .
1121 wfMessage( 'undo-' . $undoMsg )->plain() . '</div>', true, /* interface */true );
1124 if ( $content === false ) {
1125 $content = $this->getOriginalContent( $wgUser );
1134 * Get the content of the wanted revision, without section extraction.
1136 * The result of this function can be used to compare user's input with
1137 * section replaced in its context (using WikiPage::replaceSection())
1138 * to the original text of the edit.
1140 * This differs from Article::getContent() that when a missing revision is
1141 * encountered the result will be null and not the
1142 * 'missing-revision' message.
1145 * @param User $user The user to get the revision for
1146 * @return Content|null
1148 private function getOriginalContent( User
$user ) {
1149 if ( $this->section
== 'new' ) {
1150 return $this->getCurrentContent();
1152 $revision = $this->mArticle
->getRevisionFetched();
1153 if ( $revision === null ) {
1154 if ( !$this->contentModel
) {
1155 $this->contentModel
= $this->getTitle()->getContentModel();
1157 $handler = ContentHandler
::getForModelID( $this->contentModel
);
1159 return $handler->makeEmptyContent();
1161 $content = $revision->getContent( Revision
::FOR_THIS_USER
, $user );
1166 * Get the current content of the page. This is basically similar to
1167 * WikiPage::getContent( Revision::RAW ) except that when the page doesn't exist an empty
1168 * content object is returned instead of null.
1173 protected function getCurrentContent() {
1174 $rev = $this->mArticle
->getRevision();
1175 $content = $rev ?
$rev->getContent( Revision
::RAW
) : null;
1177 if ( $content === false ||
$content === null ) {
1178 if ( !$this->contentModel
) {
1179 $this->contentModel
= $this->getTitle()->getContentModel();
1181 $handler = ContentHandler
::getForModelID( $this->contentModel
);
1183 return $handler->makeEmptyContent();
1185 # nasty side-effect, but needed for consistency
1186 $this->contentModel
= $rev->getContentModel();
1187 $this->contentFormat
= $rev->getContentFormat();
1194 * Use this method before edit() to preload some content into the edit box
1196 * @param Content $content
1200 public function setPreloadedContent( Content
$content ) {
1201 $this->mPreloadContent
= $content;
1205 * Get the contents to be preloaded into the box, either set by
1206 * an earlier setPreloadText() or by loading the given page.
1208 * @param string $preload Representing the title to preload from.
1209 * @param array $params Parameters to use (interface-message style) in the preloaded text
1215 protected function getPreloadedContent( $preload, $params = array() ) {
1218 if ( !empty( $this->mPreloadContent
) ) {
1219 return $this->mPreloadContent
;
1222 $handler = ContentHandler
::getForTitle( $this->getTitle() );
1224 if ( $preload === '' ) {
1225 return $handler->makeEmptyContent();
1228 $title = Title
::newFromText( $preload );
1229 # Check for existence to avoid getting MediaWiki:Noarticletext
1230 if ( $title === null ||
!$title->exists() ||
!$title->userCan( 'read', $wgUser ) ) {
1231 // TODO: somehow show a warning to the user!
1232 return $handler->makeEmptyContent();
1235 $page = WikiPage
::factory( $title );
1236 if ( $page->isRedirect() ) {
1237 $title = $page->getRedirectTarget();
1239 if ( $title === null ||
!$title->exists() ||
!$title->userCan( 'read', $wgUser ) ) {
1240 // TODO: somehow show a warning to the user!
1241 return $handler->makeEmptyContent();
1243 $page = WikiPage
::factory( $title );
1246 $parserOptions = ParserOptions
::newFromUser( $wgUser );
1247 $content = $page->getContent( Revision
::RAW
);
1250 // TODO: somehow show a warning to the user!
1251 return $handler->makeEmptyContent();
1254 if ( $content->getModel() !== $handler->getModelID() ) {
1255 $converted = $content->convert( $handler->getModelID() );
1257 if ( !$converted ) {
1258 // TODO: somehow show a warning to the user!
1259 wfDebug( "Attempt to preload incompatible content: " .
1260 "can't convert " . $content->getModel() .
1261 " to " . $handler->getModelID() );
1263 return $handler->makeEmptyContent();
1266 $content = $converted;
1269 return $content->preloadTransform( $title, $parserOptions, $params );
1273 * Make sure the form isn't faking a user's credentials.
1275 * @param WebRequest $request
1279 function tokenOk( &$request ) {
1281 $token = $request->getVal( 'wpEditToken' );
1282 $this->mTokenOk
= $wgUser->matchEditToken( $token );
1283 $this->mTokenOkExceptSuffix
= $wgUser->matchEditTokenNoSuffix( $token );
1284 return $this->mTokenOk
;
1288 * Sets post-edit cookie indicating the user just saved a particular revision.
1290 * This uses a temporary cookie for each revision ID so separate saves will never
1291 * interfere with each other.
1293 * The cookie is deleted in the mediawiki.action.view.postEdit JS module after
1294 * the redirect. It must be clearable by JavaScript code, so it must not be
1295 * marked HttpOnly. The JavaScript code converts the cookie to a wgPostEdit config
1298 * If the variable were set on the server, it would be cached, which is unwanted
1299 * since the post-edit state should only apply to the load right after the save.
1301 * @param int $statusValue The status value (to check for new article status)
1303 protected function setPostEditCookie( $statusValue ) {
1304 $revisionId = $this->mArticle
->getLatest();
1305 $postEditKey = self
::POST_EDIT_COOKIE_KEY_PREFIX
. $revisionId;
1308 if ( $statusValue == self
::AS_SUCCESS_NEW_ARTICLE
) {
1310 } elseif ( $this->oldid
) {
1314 $response = RequestContext
::getMain()->getRequest()->response();
1315 $response->setCookie( $postEditKey, $val, time() + self
::POST_EDIT_COOKIE_DURATION
, array(
1316 'httpOnly' => false,
1321 * Attempt submission
1322 * @param array $resultDetails See docs for $result in internalAttemptSave
1323 * @throws UserBlockedError|ReadOnlyError|ThrottledError|PermissionsError
1324 * @return Status The resulting status object.
1326 public function attemptSave( &$resultDetails = false ) {
1329 # Allow bots to exempt some edits from bot flagging
1330 $bot = $wgUser->isAllowed( 'bot' ) && $this->bot
;
1331 $status = $this->internalAttemptSave( $resultDetails, $bot );
1333 Hooks
::run( 'EditPage::attemptSave:after', array( $this, $status, $resultDetails ) );
1339 * Handle status, such as after attempt save
1341 * @param Status $status
1342 * @param array|bool $resultDetails
1344 * @throws ErrorPageError
1345 * @return bool False, if output is done, true if rest of the form should be displayed
1347 private function handleStatus( Status
$status, $resultDetails ) {
1348 global $wgUser, $wgOut;
1351 * @todo FIXME: once the interface for internalAttemptSave() is made
1352 * nicer, this should use the message in $status
1354 if ( $status->value
== self
::AS_SUCCESS_UPDATE
1355 ||
$status->value
== self
::AS_SUCCESS_NEW_ARTICLE
1357 $this->didSave
= true;
1358 if ( !$resultDetails['nullEdit'] ) {
1359 $this->setPostEditCookie( $status->value
);
1363 switch ( $status->value
) {
1364 case self
::AS_HOOK_ERROR_EXPECTED
:
1365 case self
::AS_CONTENT_TOO_BIG
:
1366 case self
::AS_ARTICLE_WAS_DELETED
:
1367 case self
::AS_CONFLICT_DETECTED
:
1368 case self
::AS_SUMMARY_NEEDED
:
1369 case self
::AS_TEXTBOX_EMPTY
:
1370 case self
::AS_MAX_ARTICLE_SIZE_EXCEEDED
:
1372 case self
::AS_BLANK_ARTICLE
:
1373 case self
::AS_SELF_REDIRECT
:
1376 case self
::AS_HOOK_ERROR
:
1379 case self
::AS_CANNOT_USE_CUSTOM_MODEL
:
1380 case self
::AS_PARSE_ERROR
:
1381 $wgOut->addWikiText( '<div class="error">' . $status->getWikiText() . '</div>' );
1384 case self
::AS_SUCCESS_NEW_ARTICLE
:
1385 $query = $resultDetails['redirect'] ?
'redirect=no' : '';
1386 $anchor = isset( $resultDetails['sectionanchor'] ) ?
$resultDetails['sectionanchor'] : '';
1387 $wgOut->redirect( $this->mTitle
->getFullURL( $query ) . $anchor );
1390 case self
::AS_SUCCESS_UPDATE
:
1392 $sectionanchor = $resultDetails['sectionanchor'];
1394 // Give extensions a chance to modify URL query on update
1396 'ArticleUpdateBeforeRedirect',
1397 array( $this->mArticle
, &$sectionanchor, &$extraQuery )
1400 if ( $resultDetails['redirect'] ) {
1401 if ( $extraQuery == '' ) {
1402 $extraQuery = 'redirect=no';
1404 $extraQuery = 'redirect=no&' . $extraQuery;
1407 $wgOut->redirect( $this->mTitle
->getFullURL( $extraQuery ) . $sectionanchor );
1410 case self
::AS_SPAM_ERROR
:
1411 $this->spamPageWithContent( $resultDetails['spam'] );
1414 case self
::AS_BLOCKED_PAGE_FOR_USER
:
1415 throw new UserBlockedError( $wgUser->getBlock() );
1417 case self
::AS_IMAGE_REDIRECT_ANON
:
1418 case self
::AS_IMAGE_REDIRECT_LOGGED
:
1419 throw new PermissionsError( 'upload' );
1421 case self
::AS_READ_ONLY_PAGE_ANON
:
1422 case self
::AS_READ_ONLY_PAGE_LOGGED
:
1423 throw new PermissionsError( 'edit' );
1425 case self
::AS_READ_ONLY_PAGE
:
1426 throw new ReadOnlyError
;
1428 case self
::AS_RATE_LIMITED
:
1429 throw new ThrottledError();
1431 case self
::AS_NO_CREATE_PERMISSION
:
1432 $permission = $this->mTitle
->isTalkPage() ?
'createtalk' : 'createpage';
1433 throw new PermissionsError( $permission );
1435 case self
::AS_NO_CHANGE_CONTENT_MODEL
:
1436 throw new PermissionsError( 'editcontentmodel' );
1439 // We don't recognize $status->value. The only way that can happen
1440 // is if an extension hook aborted from inside ArticleSave.
1441 // Render the status object into $this->hookError
1442 // FIXME this sucks, we should just use the Status object throughout
1443 $this->hookError
= '<div class="error">' . $status->getWikitext() .
1450 * Run hooks that can filter edits just before they get saved.
1452 * @param Content $content The Content to filter.
1453 * @param Status $status For reporting the outcome to the caller
1454 * @param User $user The user performing the edit
1458 protected function runPostMergeFilters( Content
$content, Status
$status, User
$user ) {
1459 // Run old style post-section-merge edit filter
1460 if ( !ContentHandler
::runLegacyHooks( 'EditFilterMerged',
1461 array( $this, $content, &$this->hookError
, $this->summary
) )
1463 # Error messages etc. could be handled within the hook...
1464 $status->fatal( 'hookaborted' );
1465 $status->value
= self
::AS_HOOK_ERROR
;
1467 } elseif ( $this->hookError
!= '' ) {
1468 # ...or the hook could be expecting us to produce an error
1469 $status->fatal( 'hookaborted' );
1470 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1474 // Run new style post-section-merge edit filter
1475 if ( !Hooks
::run( 'EditFilterMergedContent',
1476 array( $this->mArticle
->getContext(), $content, $status, $this->summary
,
1477 $user, $this->minoredit
) )
1479 # Error messages etc. could be handled within the hook...
1480 if ( $status->isGood() ) {
1481 $status->fatal( 'hookaborted' );
1482 // Not setting $this->hookError here is a hack to allow the hook
1483 // to cause a return to the edit page without $this->hookError
1484 // being set. This is used by ConfirmEdit to display a captcha
1485 // without any error message cruft.
1487 $this->hookError
= $status->getWikiText();
1489 // Use the existing $status->value if the hook set it
1490 if ( !$status->value
) {
1491 $status->value
= self
::AS_HOOK_ERROR
;
1494 } elseif ( !$status->isOK() ) {
1495 # ...or the hook could be expecting us to produce an error
1496 // FIXME this sucks, we should just use the Status object throughout
1497 $this->hookError
= $status->getWikiText();
1498 $status->fatal( 'hookaborted' );
1499 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1507 * Return the summary to be used for a new section.
1509 * @param string $sectionanchor Set to the section anchor text
1512 private function newSectionSummary( &$sectionanchor = null ) {
1515 if ( $this->sectiontitle
!== '' ) {
1516 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $this->sectiontitle
);
1517 // If no edit summary was specified, create one automatically from the section
1518 // title and have it link to the new section. Otherwise, respect the summary as
1520 if ( $this->summary
=== '' ) {
1521 $cleanSectionTitle = $wgParser->stripSectionName( $this->sectiontitle
);
1522 return wfMessage( 'newsectionsummary' )
1523 ->rawParams( $cleanSectionTitle )->inContentLanguage()->text();
1525 } elseif ( $this->summary
!== '' ) {
1526 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $this->summary
);
1527 # This is a new section, so create a link to the new section
1528 # in the revision summary.
1529 $cleanSummary = $wgParser->stripSectionName( $this->summary
);
1530 return wfMessage( 'newsectionsummary' )
1531 ->rawParams( $cleanSummary )->inContentLanguage()->text();
1533 return $this->summary
;
1537 * Attempt submission (no UI)
1539 * @param array $result Array to add statuses to, currently with the
1541 * - spam (string): Spam string from content if any spam is detected by
1543 * - sectionanchor (string): Section anchor for a section save.
1544 * - nullEdit (boolean): Set if doEditContent is OK. True if null edit,
1546 * - redirect (bool): Set if doEditContent is OK. True if resulting
1547 * revision is a redirect.
1548 * @param bool $bot True if edit is being made under the bot right.
1550 * @return Status Status object, possibly with a message, but always with
1551 * one of the AS_* constants in $status->value,
1553 * @todo FIXME: This interface is TERRIBLE, but hard to get rid of due to
1554 * various error display idiosyncrasies. There are also lots of cases
1555 * where error metadata is set in the object and retrieved later instead
1556 * of being returned, e.g. AS_CONTENT_TOO_BIG and
1557 * AS_BLOCKED_PAGE_FOR_USER. All that stuff needs to be cleaned up some
1560 function internalAttemptSave( &$result, $bot = false ) {
1561 global $wgUser, $wgRequest, $wgParser, $wgMaxArticleSize;
1562 global $wgContentHandlerUseDB;
1564 $status = Status
::newGood();
1566 if ( !Hooks
::run( 'EditPage::attemptSave', array( $this ) ) ) {
1567 wfDebug( "Hook 'EditPage::attemptSave' aborted article saving\n" );
1568 $status->fatal( 'hookaborted' );
1569 $status->value
= self
::AS_HOOK_ERROR
;
1573 $spam = $wgRequest->getText( 'wpAntispam' );
1574 if ( $spam !== '' ) {
1577 $wgUser->getName() .
1579 $this->mTitle
->getPrefixedText() .
1580 '" submitted bogus field "' .
1584 $status->fatal( 'spamprotectionmatch', false );
1585 $status->value
= self
::AS_SPAM_ERROR
;
1590 # Construct Content object
1591 $textbox_content = $this->toEditContent( $this->textbox1
);
1592 } catch ( MWContentSerializationException
$ex ) {
1594 'content-failed-to-parse',
1595 $this->contentModel
,
1596 $this->contentFormat
,
1599 $status->value
= self
::AS_PARSE_ERROR
;
1603 # Check image redirect
1604 if ( $this->mTitle
->getNamespace() == NS_FILE
&&
1605 $textbox_content->isRedirect() &&
1606 !$wgUser->isAllowed( 'upload' )
1608 $code = $wgUser->isAnon() ? self
::AS_IMAGE_REDIRECT_ANON
: self
::AS_IMAGE_REDIRECT_LOGGED
;
1609 $status->setResult( false, $code );
1615 $match = self
::matchSummarySpamRegex( $this->summary
);
1616 if ( $match === false && $this->section
== 'new' ) {
1617 # $wgSpamRegex is enforced on this new heading/summary because, unlike
1618 # regular summaries, it is added to the actual wikitext.
1619 if ( $this->sectiontitle
!== '' ) {
1620 # This branch is taken when the API is used with the 'sectiontitle' parameter.
1621 $match = self
::matchSpamRegex( $this->sectiontitle
);
1623 # This branch is taken when the "Add Topic" user interface is used, or the API
1624 # is used with the 'summary' parameter.
1625 $match = self
::matchSpamRegex( $this->summary
);
1628 if ( $match === false ) {
1629 $match = self
::matchSpamRegex( $this->textbox1
);
1631 if ( $match !== false ) {
1632 $result['spam'] = $match;
1633 $ip = $wgRequest->getIP();
1634 $pdbk = $this->mTitle
->getPrefixedDBkey();
1635 $match = str_replace( "\n", '', $match );
1636 wfDebugLog( 'SpamRegex', "$ip spam regex hit [[$pdbk]]: \"$match\"" );
1637 $status->fatal( 'spamprotectionmatch', $match );
1638 $status->value
= self
::AS_SPAM_ERROR
;
1643 array( $this, $this->textbox1
, $this->section
, &$this->hookError
, $this->summary
) )
1645 # Error messages etc. could be handled within the hook...
1646 $status->fatal( 'hookaborted' );
1647 $status->value
= self
::AS_HOOK_ERROR
;
1649 } elseif ( $this->hookError
!= '' ) {
1650 # ...or the hook could be expecting us to produce an error
1651 $status->fatal( 'hookaborted' );
1652 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1656 if ( $wgUser->isBlockedFrom( $this->mTitle
, false ) ) {
1657 // Auto-block user's IP if the account was "hard" blocked
1658 $wgUser->spreadAnyEditBlock();
1659 # Check block state against master, thus 'false'.
1660 $status->setResult( false, self
::AS_BLOCKED_PAGE_FOR_USER
);
1664 $this->kblength
= (int)( strlen( $this->textbox1
) / 1024 );
1665 if ( $this->kblength
> $wgMaxArticleSize ) {
1666 // Error will be displayed by showEditForm()
1667 $this->tooBig
= true;
1668 $status->setResult( false, self
::AS_CONTENT_TOO_BIG
);
1672 if ( !$wgUser->isAllowed( 'edit' ) ) {
1673 if ( $wgUser->isAnon() ) {
1674 $status->setResult( false, self
::AS_READ_ONLY_PAGE_ANON
);
1677 $status->fatal( 'readonlytext' );
1678 $status->value
= self
::AS_READ_ONLY_PAGE_LOGGED
;
1683 $changingContentModel = false;
1684 if ( $this->contentModel
!== $this->mTitle
->getContentModel() ) {
1685 if ( !$wgContentHandlerUseDB ) {
1686 $status->fatal( 'editpage-cannot-use-custom-model' );
1687 $status->value
= self
::AS_CANNOT_USE_CUSTOM_MODEL
;
1689 } elseif ( !$wgUser->isAllowed( 'editcontentmodel' ) ) {
1690 $status->setResult( false, self
::AS_NO_CHANGE_CONTENT_MODEL
);
1694 $changingContentModel = true;
1695 $oldContentModel = $this->mTitle
->getContentModel();
1698 if ( $this->changeTags
) {
1699 $changeTagsStatus = ChangeTags
::canAddTagsAccompanyingChange(
1700 $this->changeTags
, $wgUser );
1701 if ( !$changeTagsStatus->isOK() ) {
1702 $changeTagsStatus->value
= self
::AS_CHANGE_TAG_ERROR
;
1703 return $changeTagsStatus;
1707 if ( wfReadOnly() ) {
1708 $status->fatal( 'readonlytext' );
1709 $status->value
= self
::AS_READ_ONLY_PAGE
;
1712 if ( $wgUser->pingLimiter() ||
$wgUser->pingLimiter( 'linkpurge', 0 ) ) {
1713 $status->fatal( 'actionthrottledtext' );
1714 $status->value
= self
::AS_RATE_LIMITED
;
1718 # If the article has been deleted while editing, don't save it without
1720 if ( $this->wasDeletedSinceLastEdit() && !$this->recreate
) {
1721 $status->setResult( false, self
::AS_ARTICLE_WAS_DELETED
);
1725 # Load the page data from the master. If anything changes in the meantime,
1726 # we detect it by using page_latest like a token in a 1 try compare-and-swap.
1727 $this->mArticle
->loadPageData( 'fromdbmaster' );
1728 $new = !$this->mArticle
->exists();
1731 // Late check for create permission, just in case *PARANOIA*
1732 if ( !$this->mTitle
->userCan( 'create', $wgUser ) ) {
1733 $status->fatal( 'nocreatetext' );
1734 $status->value
= self
::AS_NO_CREATE_PERMISSION
;
1735 wfDebug( __METHOD__
. ": no create permission\n" );
1739 // Don't save a new page if it's blank or if it's a MediaWiki:
1740 // message with content equivalent to default (allow empty pages
1741 // in this case to disable messages, see bug 50124)
1742 $defaultMessageText = $this->mTitle
->getDefaultMessageText();
1743 if ( $this->mTitle
->getNamespace() === NS_MEDIAWIKI
&& $defaultMessageText !== false ) {
1744 $defaultText = $defaultMessageText;
1749 if ( !$this->allowBlankArticle
&& $this->textbox1
=== $defaultText ) {
1750 $this->blankArticle
= true;
1751 $status->fatal( 'blankarticle' );
1752 $status->setResult( false, self
::AS_BLANK_ARTICLE
);
1756 if ( !$this->runPostMergeFilters( $textbox_content, $status, $wgUser ) ) {
1760 $content = $textbox_content;
1762 $result['sectionanchor'] = '';
1763 if ( $this->section
== 'new' ) {
1764 if ( $this->sectiontitle
!== '' ) {
1765 // Insert the section title above the content.
1766 $content = $content->addSectionHeader( $this->sectiontitle
);
1767 } elseif ( $this->summary
!== '' ) {
1768 // Insert the section title above the content.
1769 $content = $content->addSectionHeader( $this->summary
);
1771 $this->summary
= $this->newSectionSummary( $result['sectionanchor'] );
1774 $status->value
= self
::AS_SUCCESS_NEW_ARTICLE
;
1778 # Article exists. Check for edit conflict.
1780 $this->mArticle
->clear(); # Force reload of dates, etc.
1781 $timestamp = $this->mArticle
->getTimestamp();
1783 wfDebug( "timestamp: {$timestamp}, edittime: {$this->edittime}\n" );
1785 if ( $timestamp != $this->edittime
) {
1786 $this->isConflict
= true;
1787 if ( $this->section
== 'new' ) {
1788 if ( $this->mArticle
->getUserText() == $wgUser->getName() &&
1789 $this->mArticle
->getComment() == $this->newSectionSummary()
1791 // Probably a duplicate submission of a new comment.
1792 // This can happen when squid resends a request after
1793 // a timeout but the first one actually went through.
1795 . ": duplicate new section submission; trigger edit conflict!\n" );
1797 // New comment; suppress conflict.
1798 $this->isConflict
= false;
1799 wfDebug( __METHOD__
. ": conflict suppressed; new section\n" );
1801 } elseif ( $this->section
== ''
1802 && Revision
::userWasLastToEdit(
1803 DB_MASTER
, $this->mTitle
->getArticleID(),
1804 $wgUser->getId(), $this->edittime
1807 # Suppress edit conflict with self, except for section edits where merging is required.
1808 wfDebug( __METHOD__
. ": Suppressing edit conflict, same user.\n" );
1809 $this->isConflict
= false;
1813 // If sectiontitle is set, use it, otherwise use the summary as the section title.
1814 if ( $this->sectiontitle
!== '' ) {
1815 $sectionTitle = $this->sectiontitle
;
1817 $sectionTitle = $this->summary
;
1822 if ( $this->isConflict
) {
1824 . ": conflict! getting section '{$this->section}' for time '{$this->edittime}'"
1825 . " (article time '{$timestamp}')\n" );
1827 $content = $this->mArticle
->replaceSectionContent(
1834 wfDebug( __METHOD__
. ": getting section '{$this->section}'\n" );
1835 $content = $this->mArticle
->replaceSectionContent(
1842 if ( is_null( $content ) ) {
1843 wfDebug( __METHOD__
. ": activating conflict; section replace failed.\n" );
1844 $this->isConflict
= true;
1845 $content = $textbox_content; // do not try to merge here!
1846 } elseif ( $this->isConflict
) {
1848 if ( $this->mergeChangesIntoContent( $content ) ) {
1849 // Successful merge! Maybe we should tell the user the good news?
1850 $this->isConflict
= false;
1851 wfDebug( __METHOD__
. ": Suppressing edit conflict, successful merge.\n" );
1853 $this->section
= '';
1854 $this->textbox1
= ContentHandler
::getContentText( $content );
1855 wfDebug( __METHOD__
. ": Keeping edit conflict, failed merge.\n" );
1859 if ( $this->isConflict
) {
1860 $status->setResult( false, self
::AS_CONFLICT_DETECTED
);
1864 if ( !$this->runPostMergeFilters( $content, $status, $wgUser ) ) {
1868 if ( $this->section
== 'new' ) {
1869 // Handle the user preference to force summaries here
1870 if ( !$this->allowBlankSummary
&& trim( $this->summary
) == '' ) {
1871 $this->missingSummary
= true;
1872 $status->fatal( 'missingsummary' ); // or 'missingcommentheader' if $section == 'new'. Blegh
1873 $status->value
= self
::AS_SUMMARY_NEEDED
;
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
;
1884 } elseif ( !$this->allowBlankSummary
1885 && !$content->equals( $this->getOriginalContent( $wgUser ) )
1886 && !$content->isRedirect()
1887 && md5( $this->summary
) == $this->autoSumm
1889 $this->missingSummary
= true;
1890 $status->fatal( 'missingsummary' );
1891 $status->value
= self
::AS_SUMMARY_NEEDED
;
1896 $sectionanchor = '';
1897 if ( $this->section
== 'new' ) {
1898 $this->summary
= $this->newSectionSummary( $sectionanchor );
1899 } elseif ( $this->section
!= '' ) {
1900 # Try to get a section anchor from the section source, redirect
1901 # to edited section if header found.
1902 # XXX: Might be better to integrate this into Article::replaceSection
1903 # for duplicate heading checking and maybe parsing.
1904 $hasmatch = preg_match( "/^ *([=]{1,6})(.*?)(\\1) *\\n/i", $this->textbox1
, $matches );
1905 # We can't deal with anchors, includes, html etc in the header for now,
1906 # headline would need to be parsed to improve this.
1907 if ( $hasmatch && strlen( $matches[2] ) > 0 ) {
1908 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $matches[2] );
1911 $result['sectionanchor'] = $sectionanchor;
1913 // Save errors may fall down to the edit form, but we've now
1914 // merged the section into full text. Clear the section field
1915 // so that later submission of conflict forms won't try to
1916 // replace that into a duplicated mess.
1917 $this->textbox1
= $this->toEditText( $content );
1918 $this->section
= '';
1920 $status->value
= self
::AS_SUCCESS_UPDATE
;
1923 if ( !$this->allowSelfRedirect
1924 && $content->isRedirect()
1925 && $content->getRedirectTarget()->equals( $this->getTitle() )
1927 // If the page already redirects to itself, don't warn.
1928 $currentTarget = $this->getCurrentContent()->getRedirectTarget();
1929 if ( !$currentTarget ||
!$currentTarget->equals( $this->getTitle() ) ) {
1930 $this->selfRedirect
= true;
1931 $status->fatal( 'selfredirect' );
1932 $status->value
= self
::AS_SELF_REDIRECT
;
1937 // Check for length errors again now that the section is merged in
1938 $this->kblength
= (int)( strlen( $this->toEditText( $content ) ) / 1024 );
1939 if ( $this->kblength
> $wgMaxArticleSize ) {
1940 $this->tooBig
= true;
1941 $status->setResult( false, self
::AS_MAX_ARTICLE_SIZE_EXCEEDED
);
1945 $flags = EDIT_DEFER_UPDATES | EDIT_AUTOSUMMARY |
1946 ( $new ? EDIT_NEW
: EDIT_UPDATE
) |
1947 ( ( $this->minoredit
&& !$this->isNew
) ? EDIT_MINOR
: 0 ) |
1948 ( $bot ? EDIT_FORCE_BOT
: 0 );
1950 $doEditStatus = $this->mArticle
->doEditContent(
1956 $content->getDefaultFormat()
1959 if ( !$doEditStatus->isOK() ) {
1960 // Failure from doEdit()
1961 // Show the edit conflict page for certain recognized errors from doEdit(),
1962 // but don't show it for errors from extension hooks
1963 $errors = $doEditStatus->getErrorsArray();
1964 if ( in_array( $errors[0][0],
1965 array( 'edit-gone-missing', 'edit-conflict', 'edit-already-exists' ) )
1967 $this->isConflict
= true;
1968 // Destroys data doEdit() put in $status->value but who cares
1969 $doEditStatus->value
= self
::AS_END
;
1971 return $doEditStatus;
1974 $result['nullEdit'] = $doEditStatus->hasMessage( 'edit-no-change' );
1975 if ( $result['nullEdit'] ) {
1976 // We don't know if it was a null edit until now, so increment here
1977 $wgUser->pingLimiter( 'linkpurge' );
1979 $result['redirect'] = $content->isRedirect();
1981 $this->updateWatchlist();
1983 if ( $this->changeTags
&& isset( $doEditStatus->value
['revision'] ) ) {
1984 // If a revision was created, apply any change tags that were requested
1985 $addTags = $this->changeTags
;
1986 $revId = $doEditStatus->value
['revision']->getId();
1987 // Defer this both for performance and so that addTags() sees the rc_id
1988 // since the recentchange entry addition is deferred first (bug T100248)
1989 DeferredUpdates
::addCallableUpdate( function() use ( $addTags, $revId ) {
1990 ChangeTags
::addTags( $addTags, null, $revId );
1994 // If the content model changed, add a log entry
1995 if ( $changingContentModel ) {
1996 $this->addContentModelChangeLogEntry(
1999 $this->contentModel
,
2008 * @param Title $title
2009 * @param string $oldModel
2010 * @param string $newModel
2011 * @param string $reason
2013 protected function addContentModelChangeLogEntry( User
$user, $oldModel, $newModel, $reason ) {
2014 $log = new ManualLogEntry( 'contentmodel', 'change' );
2015 $log->setPerformer( $user );
2016 $log->setTarget( $this->mTitle
);
2017 $log->setComment( $reason );
2018 $log->setParameters( array(
2019 '4::oldmodel' => $oldModel,
2020 '5::newmodel' => $newModel
2022 $logid = $log->insert();
2023 $log->publish( $logid );
2028 * Register the change of watch status
2030 protected function updateWatchlist() {
2033 if ( $wgUser->isLoggedIn()
2034 && $this->watchthis
!= $wgUser->isWatched( $this->mTitle
, WatchedItem
::IGNORE_USER_RIGHTS
)
2036 $fname = __METHOD__
;
2037 $title = $this->mTitle
;
2038 $watch = $this->watchthis
;
2040 // Do this in its own transaction to reduce contention...
2041 $dbw = wfGetDB( DB_MASTER
);
2042 $dbw->onTransactionIdle( function () use ( $dbw, $title, $watch, $wgUser, $fname ) {
2043 WatchAction
::doWatchOrUnwatch( $watch, $title, $wgUser );
2049 * Attempts to do 3-way merge of edit content with a base revision
2050 * and current content, in case of edit conflict, in whichever way appropriate
2051 * for the content type.
2055 * @param Content $editContent
2059 private function mergeChangesIntoContent( &$editContent ) {
2061 $db = wfGetDB( DB_MASTER
);
2063 // This is the revision the editor started from
2064 $baseRevision = $this->getBaseRevision();
2065 $baseContent = $baseRevision ?
$baseRevision->getContent() : null;
2067 if ( is_null( $baseContent ) ) {
2071 // The current state, we want to merge updates into it
2072 $currentRevision = Revision
::loadFromTitle( $db, $this->mTitle
);
2073 $currentContent = $currentRevision ?
$currentRevision->getContent() : null;
2075 if ( is_null( $currentContent ) ) {
2079 $handler = ContentHandler
::getForModelID( $baseContent->getModel() );
2081 $result = $handler->merge3( $baseContent, $editContent, $currentContent );
2084 $editContent = $result;
2094 function getBaseRevision() {
2095 if ( !$this->mBaseRevision
) {
2096 $db = wfGetDB( DB_MASTER
);
2097 $this->mBaseRevision
= Revision
::loadFromTimestamp(
2098 $db, $this->mTitle
, $this->edittime
);
2100 return $this->mBaseRevision
;
2104 * Check given input text against $wgSpamRegex, and return the text of the first match.
2106 * @param string $text
2108 * @return string|bool Matching string or false
2110 public static function matchSpamRegex( $text ) {
2111 global $wgSpamRegex;
2112 // For back compatibility, $wgSpamRegex may be a single string or an array of regexes.
2113 $regexes = (array)$wgSpamRegex;
2114 return self
::matchSpamRegexInternal( $text, $regexes );
2118 * Check given input text against $wgSummarySpamRegex, and return the text of the first match.
2120 * @param string $text
2122 * @return string|bool Matching string or false
2124 public static function matchSummarySpamRegex( $text ) {
2125 global $wgSummarySpamRegex;
2126 $regexes = (array)$wgSummarySpamRegex;
2127 return self
::matchSpamRegexInternal( $text, $regexes );
2131 * @param string $text
2132 * @param array $regexes
2133 * @return bool|string
2135 protected static function matchSpamRegexInternal( $text, $regexes ) {
2136 foreach ( $regexes as $regex ) {
2138 if ( preg_match( $regex, $text, $matches ) ) {
2145 function setHeaders() {
2146 global $wgOut, $wgUser, $wgAjaxEditStash;
2148 $wgOut->addModules( 'mediawiki.action.edit' );
2149 $wgOut->addModuleStyles( 'mediawiki.action.edit.styles' );
2151 if ( $wgUser->getOption( 'showtoolbar' ) ) {
2152 // The addition of default buttons is handled by getEditToolbar() which
2153 // has its own dependency on this module. The call here ensures the module
2154 // is loaded in time (it has position "top") for other modules to register
2155 // buttons (e.g. extensions, gadgets, user scripts).
2156 $wgOut->addModules( 'mediawiki.toolbar' );
2159 if ( $wgUser->getOption( 'uselivepreview' ) ) {
2160 $wgOut->addModules( 'mediawiki.action.edit.preview' );
2163 if ( $wgUser->getOption( 'useeditwarning' ) ) {
2164 $wgOut->addModules( 'mediawiki.action.edit.editWarning' );
2167 if ( $wgAjaxEditStash ) {
2168 $wgOut->addModules( 'mediawiki.action.edit.stash' );
2171 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2173 # Enabled article-related sidebar, toplinks, etc.
2174 $wgOut->setArticleRelated( true );
2176 $contextTitle = $this->getContextTitle();
2177 if ( $this->isConflict
) {
2178 $msg = 'editconflict';
2179 } elseif ( $contextTitle->exists() && $this->section
!= '' ) {
2180 $msg = $this->section
== 'new' ?
'editingcomment' : 'editingsection';
2182 $msg = $contextTitle->exists()
2183 ||
( $contextTitle->getNamespace() == NS_MEDIAWIKI
2184 && $contextTitle->getDefaultMessageText() !== false
2190 # Use the title defined by DISPLAYTITLE magic word when present
2191 $displayTitle = isset( $this->mParserOutput
) ?
$this->mParserOutput
->getDisplayTitle() : false;
2192 if ( $displayTitle === false ) {
2193 $displayTitle = $contextTitle->getPrefixedText();
2195 $wgOut->setPageTitle( wfMessage( $msg, $displayTitle ) );
2196 # Transmit the name of the message to JavaScript for live preview
2197 # Keep Resources.php/mediawiki.action.edit.preview in sync with the possible keys
2198 $wgOut->addJsConfigVars( 'wgEditMessage', $msg );
2202 * Show all applicable editing introductions
2204 protected function showIntro() {
2205 global $wgOut, $wgUser;
2206 if ( $this->suppressIntro
) {
2210 $namespace = $this->mTitle
->getNamespace();
2212 if ( $namespace == NS_MEDIAWIKI
) {
2213 # Show a warning if editing an interface message
2214 $wgOut->wrapWikiMsg( "<div class='mw-editinginterface'>\n$1\n</div>", 'editinginterface' );
2215 # If this is a default message (but not css or js),
2216 # show a hint that it is translatable on translatewiki.net
2217 if ( !$this->mTitle
->hasContentModel( CONTENT_MODEL_CSS
)
2218 && !$this->mTitle
->hasContentModel( CONTENT_MODEL_JAVASCRIPT
)
2220 $defaultMessageText = $this->mTitle
->getDefaultMessageText();
2221 if ( $defaultMessageText !== false ) {
2222 $wgOut->wrapWikiMsg( "<div class='mw-translateinterface'>\n$1\n</div>",
2223 'translateinterface' );
2226 } elseif ( $namespace == NS_FILE
) {
2227 # Show a hint to shared repo
2228 $file = wfFindFile( $this->mTitle
);
2229 if ( $file && !$file->isLocal() ) {
2230 $descUrl = $file->getDescriptionUrl();
2231 # there must be a description url to show a hint to shared repo
2233 if ( !$this->mTitle
->exists() ) {
2234 $wgOut->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-create\">\n$1\n</div>", array(
2235 'sharedupload-desc-create', $file->getRepo()->getDisplayName(), $descUrl
2238 $wgOut->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-edit\">\n$1\n</div>", array(
2239 'sharedupload-desc-edit', $file->getRepo()->getDisplayName(), $descUrl
2246 # Show a warning message when someone creates/edits a user (talk) page but the user does not exist
2247 # Show log extract when the user is currently blocked
2248 if ( $namespace == NS_USER ||
$namespace == NS_USER_TALK
) {
2249 $parts = explode( '/', $this->mTitle
->getText(), 2 );
2250 $username = $parts[0];
2251 $user = User
::newFromName( $username, false /* allow IP users*/ );
2252 $ip = User
::isIP( $username );
2253 $block = Block
::newFromTarget( $user, $user );
2254 if ( !( $user && $user->isLoggedIn() ) && !$ip ) { # User does not exist
2255 $wgOut->wrapWikiMsg( "<div class=\"mw-userpage-userdoesnotexist error\">\n$1\n</div>",
2256 array( 'userpage-userdoesnotexist', wfEscapeWikiText( $username ) ) );
2257 } elseif ( !is_null( $block ) && $block->getType() != Block
::TYPE_AUTO
) {
2258 # Show log extract if the user is currently blocked
2259 LogEventsList
::showLogExtract(
2262 MWNamespace
::getCanonicalName( NS_USER
) . ':' . $block->getTarget(),
2266 'showIfEmpty' => false,
2268 'blocked-notice-logextract',
2269 $user->getName() # Support GENDER in notice
2275 # Try to add a custom edit intro, or use the standard one if this is not possible.
2276 if ( !$this->showCustomIntro() && !$this->mTitle
->exists() ) {
2277 $helpLink = wfExpandUrl( Skin
::makeInternalOrExternalUrl(
2278 wfMessage( 'helppage' )->inContentLanguage()->text()
2280 if ( $wgUser->isLoggedIn() ) {
2281 $wgOut->wrapWikiMsg(
2282 // Suppress the external link icon, consider the help url an internal one
2283 "<div class=\"mw-newarticletext plainlinks\">\n$1\n</div>",
2290 $wgOut->wrapWikiMsg(
2291 // Suppress the external link icon, consider the help url an internal one
2292 "<div class=\"mw-newarticletextanon plainlinks\">\n$1\n</div>",
2294 'newarticletextanon',
2300 # Give a notice if the user is editing a deleted/moved page...
2301 if ( !$this->mTitle
->exists() ) {
2302 LogEventsList
::showLogExtract( $wgOut, array( 'delete', 'move' ), $this->mTitle
,
2306 'conds' => array( "log_action != 'revision'" ),
2307 'showIfEmpty' => false,
2308 'msgKey' => array( 'recreate-moveddeleted-warn' )
2315 * Attempt to show a custom editing introduction, if supplied
2319 protected function showCustomIntro() {
2320 if ( $this->editintro
) {
2321 $title = Title
::newFromText( $this->editintro
);
2322 if ( $title instanceof Title
&& $title->exists() && $title->userCan( 'read' ) ) {
2324 // Added using template syntax, to take <noinclude>'s into account.
2325 $wgOut->addWikiTextTitleTidy(
2326 '<div class="mw-editintro">{{:' . $title->getFullText() . '}}</div>',
2336 * Gets an editable textual representation of $content.
2337 * The textual representation can be turned by into a Content object by the
2338 * toEditContent() method.
2340 * If $content is null or false or a string, $content is returned unchanged.
2342 * If the given Content object is not of a type that can be edited using
2343 * the text base EditPage, an exception will be raised. Set
2344 * $this->allowNonTextContent to true to allow editing of non-textual
2347 * @param Content|null|bool|string $content
2348 * @return string The editable text form of the content.
2350 * @throws MWException If $content is not an instance of TextContent and
2351 * $this->allowNonTextContent is not true.
2353 protected function toEditText( $content ) {
2354 if ( $content === null ||
$content === false ||
is_string( $content ) ) {
2358 if ( !$this->isSupportedContentModel( $content->getModel() ) ) {
2359 throw new MWException( 'This content model is not supported: '
2360 . ContentHandler
::getLocalizedName( $content->getModel() ) );
2363 return $content->serialize( $this->contentFormat
);
2367 * Turns the given text into a Content object by unserializing it.
2369 * If the resulting Content object is not of a type that can be edited using
2370 * the text base EditPage, an exception will be raised. Set
2371 * $this->allowNonTextContent to true to allow editing of non-textual
2374 * @param string|null|bool $text Text to unserialize
2375 * @return Content The content object created from $text. If $text was false
2376 * or null, false resp. null will be returned instead.
2378 * @throws MWException If unserializing the text results in a Content
2379 * object that is not an instance of TextContent and
2380 * $this->allowNonTextContent is not true.
2382 protected function toEditContent( $text ) {
2383 if ( $text === false ||
$text === null ) {
2387 $content = ContentHandler
::makeContent( $text, $this->getTitle(),
2388 $this->contentModel
, $this->contentFormat
);
2390 if ( !$this->isSupportedContentModel( $content->getModel() ) ) {
2391 throw new MWException( 'This content model is not supported: '
2392 . ContentHandler
::getLocalizedName( $content->getModel() ) );
2399 * Send the edit form and related headers to $wgOut
2400 * @param callable|null $formCallback That takes an OutputPage parameter; will be called
2401 * during form output near the top, for captchas and the like.
2403 * The $formCallback parameter is deprecated since MediaWiki 1.25. Please
2404 * use the EditPage::showEditForm:fields hook instead.
2406 function showEditForm( $formCallback = null ) {
2407 global $wgOut, $wgUser;
2409 # need to parse the preview early so that we know which templates are used,
2410 # otherwise users with "show preview after edit box" will get a blank list
2411 # we parse this near the beginning so that setHeaders can do the title
2412 # setting work instead of leaving it in getPreviewText
2413 $previewOutput = '';
2414 if ( $this->formtype
== 'preview' ) {
2415 $previewOutput = $this->getPreviewText();
2418 Hooks
::run( 'EditPage::showEditForm:initial', array( &$this, &$wgOut ) );
2420 $this->setHeaders();
2422 if ( $this->showHeader() === false ) {
2426 $wgOut->addHTML( $this->editFormPageTop
);
2428 if ( $wgUser->getOption( 'previewontop' ) ) {
2429 $this->displayPreviewArea( $previewOutput, true );
2432 $wgOut->addHTML( $this->editFormTextTop
);
2434 $showToolbar = true;
2435 if ( $this->wasDeletedSinceLastEdit() ) {
2436 if ( $this->formtype
== 'save' ) {
2437 // Hide the toolbar and edit area, user can click preview to get it back
2438 // Add an confirmation checkbox and explanation.
2439 $showToolbar = false;
2441 $wgOut->wrapWikiMsg( "<div class='error mw-deleted-while-editing'>\n$1\n</div>",
2442 'deletedwhileediting' );
2446 // @todo add EditForm plugin interface and use it here!
2447 // search for textarea1 and textares2, and allow EditForm to override all uses.
2448 $wgOut->addHTML( Html
::openElement(
2451 'id' => self
::EDITFORM_ID
,
2452 'name' => self
::EDITFORM_ID
,
2454 'action' => $this->getActionURL( $this->getContextTitle() ),
2455 'enctype' => 'multipart/form-data'
2459 if ( is_callable( $formCallback ) ) {
2460 wfWarn( 'The $formCallback parameter to ' . __METHOD__
. 'is deprecated' );
2461 call_user_func_array( $formCallback, array( &$wgOut ) );
2464 // Add an empty field to trip up spambots
2466 Xml
::openElement( 'div', array( 'id' => 'antispam-container', 'style' => 'display: none;' ) )
2469 array( 'for' => 'wpAntiSpam' ),
2470 wfMessage( 'simpleantispam-label' )->parse()
2476 'name' => 'wpAntispam',
2477 'id' => 'wpAntispam',
2481 . Xml
::closeElement( 'div' )
2484 Hooks
::run( 'EditPage::showEditForm:fields', array( &$this, &$wgOut ) );
2486 // Put these up at the top to ensure they aren't lost on early form submission
2487 $this->showFormBeforeText();
2489 if ( $this->wasDeletedSinceLastEdit() && 'save' == $this->formtype
) {
2490 $username = $this->lastDelete
->user_name
;
2491 $comment = $this->lastDelete
->log_comment
;
2493 // It is better to not parse the comment at all than to have templates expanded in the middle
2494 // TODO: can the checkLabel be moved outside of the div so that wrapWikiMsg could be used?
2495 $key = $comment === ''
2496 ?
'confirmrecreate-noreason'
2497 : 'confirmrecreate';
2499 '<div class="mw-confirm-recreate">' .
2500 wfMessage( $key, $username, "<nowiki>$comment</nowiki>" )->parse() .
2501 Xml
::checkLabel( wfMessage( 'recreate' )->text(), 'wpRecreate', 'wpRecreate', false,
2502 array( 'title' => Linker
::titleAttrib( 'recreate' ), 'tabindex' => 1, 'id' => 'wpRecreate' )
2508 # When the summary is hidden, also hide them on preview/show changes
2509 if ( $this->nosummary
) {
2510 $wgOut->addHTML( Html
::hidden( 'nosummary', true ) );
2513 # If a blank edit summary was previously provided, and the appropriate
2514 # user preference is active, pass a hidden tag as wpIgnoreBlankSummary. This will stop the
2515 # user being bounced back more than once in the event that a summary
2518 # For a bit more sophisticated detection of blank summaries, hash the
2519 # automatic one and pass that in the hidden field wpAutoSummary.
2520 if ( $this->missingSummary ||
( $this->section
== 'new' && $this->nosummary
) ) {
2521 $wgOut->addHTML( Html
::hidden( 'wpIgnoreBlankSummary', true ) );
2524 if ( $this->undidRev
) {
2525 $wgOut->addHTML( Html
::hidden( 'wpUndidRevision', $this->undidRev
) );
2528 if ( $this->selfRedirect
) {
2529 $wgOut->addHTML( Html
::hidden( 'wpIgnoreSelfRedirect', true ) );
2532 if ( $this->hasPresetSummary
) {
2533 // If a summary has been preset using &summary= we don't want to prompt for
2534 // a different summary. Only prompt for a summary if the summary is blanked.
2536 $this->autoSumm
= md5( '' );
2539 $autosumm = $this->autoSumm ?
$this->autoSumm
: md5( $this->summary
);
2540 $wgOut->addHTML( Html
::hidden( 'wpAutoSummary', $autosumm ) );
2542 $wgOut->addHTML( Html
::hidden( 'oldid', $this->oldid
) );
2543 $wgOut->addHTML( Html
::hidden( 'parentRevId',
2544 $this->parentRevId ?
: $this->mArticle
->getRevIdFetched() ) );
2546 $wgOut->addHTML( Html
::hidden( 'format', $this->contentFormat
) );
2547 $wgOut->addHTML( Html
::hidden( 'model', $this->contentModel
) );
2549 if ( $this->section
== 'new' ) {
2550 $this->showSummaryInput( true, $this->summary
);
2551 $wgOut->addHTML( $this->getSummaryPreview( true, $this->summary
) );
2554 $wgOut->addHTML( $this->editFormTextBeforeContent
);
2556 if ( !$this->isCssJsSubpage
&& $showToolbar && $wgUser->getOption( 'showtoolbar' ) ) {
2557 $wgOut->addHTML( EditPage
::getEditToolbar( $this->mTitle
) );
2560 if ( $this->blankArticle
) {
2561 $wgOut->addHTML( Html
::hidden( 'wpIgnoreBlankArticle', true ) );
2564 if ( $this->isConflict
) {
2565 // In an edit conflict bypass the overridable content form method
2566 // and fallback to the raw wpTextbox1 since editconflicts can't be
2567 // resolved between page source edits and custom ui edits using the
2569 $this->textbox2
= $this->textbox1
;
2571 $content = $this->getCurrentContent();
2572 $this->textbox1
= $this->toEditText( $content );
2574 $this->showTextbox1();
2576 $this->showContentForm();
2579 $wgOut->addHTML( $this->editFormTextAfterContent
);
2581 $this->showStandardInputs();
2583 $this->showFormAfterText();
2585 $this->showTosSummary();
2587 $this->showEditTools();
2589 $wgOut->addHTML( $this->editFormTextAfterTools
. "\n" );
2591 $wgOut->addHTML( Html
::rawElement( 'div', array( 'class' => 'templatesUsed' ),
2592 Linker
::formatTemplates( $this->getTemplates(), $this->preview
, $this->section
!= '' ) ) );
2594 $wgOut->addHTML( Html
::rawElement( 'div', array( 'class' => 'hiddencats' ),
2595 Linker
::formatHiddenCategories( $this->mArticle
->getHiddenCategories() ) ) );
2597 $wgOut->addHTML( Html
::rawElement( 'div', array( 'class' => 'limitreport' ),
2598 self
::getPreviewLimitReport( $this->mParserOutput
) ) );
2600 $wgOut->addModules( 'mediawiki.action.edit.collapsibleFooter' );
2602 if ( $this->isConflict
) {
2604 $this->showConflict();
2605 } catch ( MWContentSerializationException
$ex ) {
2606 // this can't really happen, but be nice if it does.
2608 'content-failed-to-parse',
2609 $this->contentModel
,
2610 $this->contentFormat
,
2613 $wgOut->addWikiText( '<div class="error">' . $msg->text() . '</div>' );
2617 // Marker for detecting truncated form data. This must be the last
2618 // parameter sent in order to be of use, so do not move me.
2619 $wgOut->addHTML( Html
::hidden( 'wpUltimateParam', true ) );
2620 $wgOut->addHTML( $this->editFormTextBottom
. "\n</form>\n" );
2622 if ( !$wgUser->getOption( 'previewontop' ) ) {
2623 $this->displayPreviewArea( $previewOutput, false );
2629 * Extract the section title from current section text, if any.
2631 * @param string $text
2632 * @return string|bool String or false
2634 public static function extractSectionTitle( $text ) {
2635 preg_match( "/^(=+)(.+)\\1\\s*(\n|$)/i", $text, $matches );
2636 if ( !empty( $matches[2] ) ) {
2638 return $wgParser->stripSectionName( trim( $matches[2] ) );
2647 protected function showHeader() {
2648 global $wgOut, $wgUser, $wgMaxArticleSize, $wgLang;
2649 global $wgAllowUserCss, $wgAllowUserJs;
2651 if ( $this->mTitle
->isTalkPage() ) {
2652 $wgOut->addWikiMsg( 'talkpagetext' );
2656 $editNotices = $this->mTitle
->getEditNotices( $this->oldid
);
2657 if ( count( $editNotices ) ) {
2658 $wgOut->addHTML( implode( "\n", $editNotices ) );
2660 $msg = wfMessage( 'editnotice-notext' );
2661 if ( !$msg->isDisabled() ) {
2663 '<div class="mw-editnotice-notext">'
2664 . $msg->parseAsBlock()
2670 if ( $this->isConflict
) {
2671 $wgOut->wrapWikiMsg( "<div class='mw-explainconflict'>\n$1\n</div>", 'explainconflict' );
2672 $this->edittime
= $this->mArticle
->getTimestamp();
2674 if ( $this->section
!= '' && !$this->isSectionEditSupported() ) {
2675 // We use $this->section to much before this and getVal('wgSection') directly in other places
2676 // at this point we can't reset $this->section to '' to fallback to non-section editing.
2677 // Someone is welcome to try refactoring though
2678 $wgOut->showErrorPage( 'sectioneditnotsupported-title', 'sectioneditnotsupported-text' );
2682 if ( $this->section
!= '' && $this->section
!= 'new' ) {
2683 if ( !$this->summary
&& !$this->preview
&& !$this->diff
) {
2684 $sectionTitle = self
::extractSectionTitle( $this->textbox1
); // FIXME: use Content object
2685 if ( $sectionTitle !== false ) {
2686 $this->summary
= "/* $sectionTitle */ ";
2691 if ( $this->missingComment
) {
2692 $wgOut->wrapWikiMsg( "<div id='mw-missingcommenttext'>\n$1\n</div>", 'missingcommenttext' );
2695 if ( $this->missingSummary
&& $this->section
!= 'new' ) {
2696 $wgOut->wrapWikiMsg( "<div id='mw-missingsummary'>\n$1\n</div>", 'missingsummary' );
2699 if ( $this->missingSummary
&& $this->section
== 'new' ) {
2700 $wgOut->wrapWikiMsg( "<div id='mw-missingcommentheader'>\n$1\n</div>", 'missingcommentheader' );
2703 if ( $this->blankArticle
) {
2704 $wgOut->wrapWikiMsg( "<div id='mw-blankarticle'>\n$1\n</div>", 'blankarticle' );
2707 if ( $this->selfRedirect
) {
2708 $wgOut->wrapWikiMsg( "<div id='mw-selfredirect'>\n$1\n</div>", 'selfredirect' );
2711 if ( $this->hookError
!== '' ) {
2712 $wgOut->addWikiText( $this->hookError
);
2715 if ( !$this->checkUnicodeCompliantBrowser() ) {
2716 $wgOut->addWikiMsg( 'nonunicodebrowser' );
2719 if ( $this->section
!= 'new' ) {
2720 $revision = $this->mArticle
->getRevisionFetched();
2722 // Let sysop know that this will make private content public if saved
2724 if ( !$revision->userCan( Revision
::DELETED_TEXT
, $wgUser ) ) {
2725 $wgOut->wrapWikiMsg(
2726 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
2727 'rev-deleted-text-permission'
2729 } elseif ( $revision->isDeleted( Revision
::DELETED_TEXT
) ) {
2730 $wgOut->wrapWikiMsg(
2731 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
2732 'rev-deleted-text-view'
2736 if ( !$revision->isCurrent() ) {
2737 $this->mArticle
->setOldSubtitle( $revision->getId() );
2738 $wgOut->addWikiMsg( 'editingold' );
2740 } elseif ( $this->mTitle
->exists() ) {
2741 // Something went wrong
2743 $wgOut->wrapWikiMsg( "<div class='errorbox'>\n$1\n</div>\n",
2744 array( 'missing-revision', $this->oldid
) );
2749 if ( wfReadOnly() ) {
2750 $wgOut->wrapWikiMsg(
2751 "<div id=\"mw-read-only-warning\">\n$1\n</div>",
2752 array( 'readonlywarning', wfReadOnlyReason() )
2754 } elseif ( $wgUser->isAnon() ) {
2755 if ( $this->formtype
!= 'preview' ) {
2756 $wgOut->wrapWikiMsg(
2757 "<div id='mw-anon-edit-warning'>\n$1\n</div>",
2758 array( 'anoneditwarning',
2760 '{{fullurl:Special:UserLogin|returnto={{FULLPAGENAMEE}}}}',
2762 '{{fullurl:Special:UserLogin/signup|returnto={{FULLPAGENAMEE}}}}' )
2765 $wgOut->wrapWikiMsg( "<div id=\"mw-anon-preview-warning\">\n$1</div>",
2766 'anonpreviewwarning'
2770 if ( $this->isCssJsSubpage
) {
2771 # Check the skin exists
2772 if ( $this->isWrongCaseCssJsPage
) {
2773 $wgOut->wrapWikiMsg(
2774 "<div class='error' id='mw-userinvalidcssjstitle'>\n$1\n</div>",
2775 array( 'userinvalidcssjstitle', $this->mTitle
->getSkinFromCssJsSubpage() )
2778 if ( $this->getTitle()->isSubpageOf( $wgUser->getUserPage() ) ) {
2779 if ( $this->formtype
!== 'preview' ) {
2780 if ( $this->isCssSubpage
&& $wgAllowUserCss ) {
2781 $wgOut->wrapWikiMsg(
2782 "<div id='mw-usercssyoucanpreview'>\n$1\n</div>",
2783 array( 'usercssyoucanpreview' )
2787 if ( $this->isJsSubpage
&& $wgAllowUserJs ) {
2788 $wgOut->wrapWikiMsg(
2789 "<div id='mw-userjsyoucanpreview'>\n$1\n</div>",
2790 array( 'userjsyoucanpreview' )
2798 if ( $this->mTitle
->isProtected( 'edit' ) &&
2799 MWNamespace
::getRestrictionLevels( $this->mTitle
->getNamespace() ) !== array( '' )
2801 # Is the title semi-protected?
2802 if ( $this->mTitle
->isSemiProtected() ) {
2803 $noticeMsg = 'semiprotectedpagewarning';
2805 # Then it must be protected based on static groups (regular)
2806 $noticeMsg = 'protectedpagewarning';
2808 LogEventsList
::showLogExtract( $wgOut, 'protect', $this->mTitle
, '',
2809 array( 'lim' => 1, 'msgKey' => array( $noticeMsg ) ) );
2811 if ( $this->mTitle
->isCascadeProtected() ) {
2812 # Is this page under cascading protection from some source pages?
2813 list( $cascadeSources, /* $restrictions */ ) = $this->mTitle
->getCascadeProtectionSources();
2814 $notice = "<div class='mw-cascadeprotectedwarning'>\n$1\n";
2815 $cascadeSourcesCount = count( $cascadeSources );
2816 if ( $cascadeSourcesCount > 0 ) {
2817 # Explain, and list the titles responsible
2818 foreach ( $cascadeSources as $page ) {
2819 $notice .= '* [[:' . $page->getPrefixedText() . "]]\n";
2822 $notice .= '</div>';
2823 $wgOut->wrapWikiMsg( $notice, array( 'cascadeprotectedwarning', $cascadeSourcesCount ) );
2825 if ( !$this->mTitle
->exists() && $this->mTitle
->getRestrictions( 'create' ) ) {
2826 LogEventsList
::showLogExtract( $wgOut, 'protect', $this->mTitle
, '',
2828 'showIfEmpty' => false,
2829 'msgKey' => array( 'titleprotectedwarning' ),
2830 'wrap' => "<div class=\"mw-titleprotectedwarning\">\n$1</div>" ) );
2833 if ( $this->kblength
=== false ) {
2834 $this->kblength
= (int)( strlen( $this->textbox1
) / 1024 );
2837 if ( $this->tooBig ||
$this->kblength
> $wgMaxArticleSize ) {
2838 $wgOut->wrapWikiMsg( "<div class='error' id='mw-edit-longpageerror'>\n$1\n</div>",
2841 $wgLang->formatNum( $this->kblength
),
2842 $wgLang->formatNum( $wgMaxArticleSize )
2846 if ( !wfMessage( 'longpage-hint' )->isDisabled() ) {
2847 $wgOut->wrapWikiMsg( "<div id='mw-edit-longpage-hint'>\n$1\n</div>",
2850 $wgLang->formatSize( strlen( $this->textbox1
) ),
2851 strlen( $this->textbox1
)
2856 # Add header copyright warning
2857 $this->showHeaderCopyrightWarning();
2863 * Standard summary input and label (wgSummary), abstracted so EditPage
2864 * subclasses may reorganize the form.
2865 * Note that you do not need to worry about the label's for=, it will be
2866 * inferred by the id given to the input. You can remove them both by
2867 * passing array( 'id' => false ) to $userInputAttrs.
2869 * @param string $summary The value of the summary input
2870 * @param string $labelText The html to place inside the label
2871 * @param array $inputAttrs Array of attrs to use on the input
2872 * @param array $spanLabelAttrs Array of attrs to use on the span inside the label
2874 * @return array An array in the format array( $label, $input )
2876 function getSummaryInput( $summary = "", $labelText = null,
2877 $inputAttrs = null, $spanLabelAttrs = null
2879 // Note: the maxlength is overridden in JS to 255 and to make it use UTF-8 bytes, not characters.
2880 $inputAttrs = ( is_array( $inputAttrs ) ?
$inputAttrs : array() ) +
array(
2881 'id' => 'wpSummary',
2882 'maxlength' => '200',
2885 'spellcheck' => 'true',
2886 ) + Linker
::tooltipAndAccesskeyAttribs( 'summary' );
2888 $spanLabelAttrs = ( is_array( $spanLabelAttrs ) ?
$spanLabelAttrs : array() ) +
array(
2889 'class' => $this->missingSummary ?
'mw-summarymissed' : 'mw-summary',
2890 'id' => "wpSummaryLabel"
2897 $inputAttrs['id'] ?
array( 'for' => $inputAttrs['id'] ) : null,
2900 $label = Xml
::tags( 'span', $spanLabelAttrs, $label );
2903 $input = Html
::input( 'wpSummary', $summary, 'text', $inputAttrs );
2905 return array( $label, $input );
2909 * @param bool $isSubjectPreview True if this is the section subject/title
2910 * up top, or false if this is the comment summary
2911 * down below the textarea
2912 * @param string $summary The text of the summary to display
2914 protected function showSummaryInput( $isSubjectPreview, $summary = "" ) {
2915 global $wgOut, $wgContLang;
2916 # Add a class if 'missingsummary' is triggered to allow styling of the summary line
2917 $summaryClass = $this->missingSummary ?
'mw-summarymissed' : 'mw-summary';
2918 if ( $isSubjectPreview ) {
2919 if ( $this->nosummary
) {
2923 if ( !$this->mShowSummaryField
) {
2927 $summary = $wgContLang->recodeForEdit( $summary );
2928 $labelText = wfMessage( $isSubjectPreview ?
'subject' : 'summary' )->parse();
2929 list( $label, $input ) = $this->getSummaryInput(
2932 array( 'class' => $summaryClass ),
2935 $wgOut->addHTML( "{$label} {$input}" );
2939 * @param bool $isSubjectPreview True if this is the section subject/title
2940 * up top, or false if this is the comment summary
2941 * down below the textarea
2942 * @param string $summary The text of the summary to display
2945 protected function getSummaryPreview( $isSubjectPreview, $summary = "" ) {
2946 // avoid spaces in preview, gets always trimmed on save
2947 $summary = trim( $summary );
2948 if ( !$summary ||
( !$this->preview
&& !$this->diff
) ) {
2954 if ( $isSubjectPreview ) {
2955 $summary = wfMessage( 'newsectionsummary' )->rawParams( $wgParser->stripSectionName( $summary ) )
2956 ->inContentLanguage()->text();
2959 $message = $isSubjectPreview ?
'subject-preview' : 'summary-preview';
2961 $summary = wfMessage( $message )->parse()
2962 . Linker
::commentBlock( $summary, $this->mTitle
, $isSubjectPreview );
2963 return Xml
::tags( 'div', array( 'class' => 'mw-summary-preview' ), $summary );
2966 protected function showFormBeforeText() {
2968 $section = htmlspecialchars( $this->section
);
2969 $wgOut->addHTML( <<<HTML
2970 <input type='hidden' value="{$section}" name="wpSection"/>
2971 <input type='hidden' value="{$this->starttime}" name="wpStarttime" />
2972 <input type='hidden' value="{$this->edittime}" name="wpEdittime" />
2973 <input type='hidden' value="{$this->scrolltop}" name="wpScrolltop" id="wpScrolltop" />
2977 if ( !$this->checkUnicodeCompliantBrowser() ) {
2978 $wgOut->addHTML( Html
::hidden( 'safemode', '1' ) );
2982 protected function showFormAfterText() {
2983 global $wgOut, $wgUser;
2985 * To make it harder for someone to slip a user a page
2986 * which submits an edit form to the wiki without their
2987 * knowledge, a random token is associated with the login
2988 * session. If it's not passed back with the submission,
2989 * we won't save the page, or render user JavaScript and
2992 * For anon editors, who may not have a session, we just
2993 * include the constant suffix to prevent editing from
2994 * broken text-mangling proxies.
2996 $wgOut->addHTML( "\n" . Html
::hidden( "wpEditToken", $wgUser->getEditToken() ) . "\n" );
3000 * Subpage overridable method for printing the form for page content editing
3001 * By default this simply outputs wpTextbox1
3002 * Subclasses can override this to provide a custom UI for editing;
3003 * be it a form, or simply wpTextbox1 with a modified content that will be
3004 * reverse modified when extracted from the post data.
3005 * Note that this is basically the inverse for importContentFormData
3007 protected function showContentForm() {
3008 $this->showTextbox1();
3012 * Method to output wpTextbox1
3013 * The $textoverride method can be used by subclasses overriding showContentForm
3014 * to pass back to this method.
3016 * @param array $customAttribs Array of html attributes to use in the textarea
3017 * @param string $textoverride Optional text to override $this->textarea1 with
3019 protected function showTextbox1( $customAttribs = null, $textoverride = null ) {
3020 if ( $this->wasDeletedSinceLastEdit() && $this->formtype
== 'save' ) {
3021 $attribs = array( 'style' => 'display:none;' );
3023 $classes = array(); // Textarea CSS
3024 if ( $this->mTitle
->isProtected( 'edit' ) &&
3025 MWNamespace
::getRestrictionLevels( $this->mTitle
->getNamespace() ) !== array( '' )
3027 # Is the title semi-protected?
3028 if ( $this->mTitle
->isSemiProtected() ) {
3029 $classes[] = 'mw-textarea-sprotected';
3031 # Then it must be protected based on static groups (regular)
3032 $classes[] = 'mw-textarea-protected';
3034 # Is the title cascade-protected?
3035 if ( $this->mTitle
->isCascadeProtected() ) {
3036 $classes[] = 'mw-textarea-cprotected';
3040 $attribs = array( 'tabindex' => 1 );
3042 if ( is_array( $customAttribs ) ) {
3043 $attribs +
= $customAttribs;
3046 if ( count( $classes ) ) {
3047 if ( isset( $attribs['class'] ) ) {
3048 $classes[] = $attribs['class'];
3050 $attribs['class'] = implode( ' ', $classes );
3055 $textoverride !== null ?
$textoverride : $this->textbox1
,
3061 protected function showTextbox2() {
3062 $this->showTextbox( $this->textbox2
, 'wpTextbox2', array( 'tabindex' => 6, 'readonly' ) );
3065 protected function showTextbox( $text, $name, $customAttribs = array() ) {
3066 global $wgOut, $wgUser;
3068 $wikitext = $this->safeUnicodeOutput( $text );
3069 if ( strval( $wikitext ) !== '' ) {
3070 // Ensure there's a newline at the end, otherwise adding lines
3072 // But don't add a newline if the ext is empty, or Firefox in XHTML
3073 // mode will show an extra newline. A bit annoying.
3077 $attribs = $customAttribs +
array(
3080 'cols' => $wgUser->getIntOption( 'cols' ),
3081 'rows' => $wgUser->getIntOption( 'rows' ),
3082 // Avoid PHP notices when appending preferences
3083 // (appending allows customAttribs['style'] to still work).
3087 $pageLang = $this->mTitle
->getPageLanguage();
3088 $attribs['lang'] = $pageLang->getHtmlCode();
3089 $attribs['dir'] = $pageLang->getDir();
3091 $wgOut->addHTML( Html
::textarea( $name, $wikitext, $attribs ) );
3094 protected function displayPreviewArea( $previewOutput, $isOnTop = false ) {
3098 $classes[] = 'ontop';
3101 $attribs = array( 'id' => 'wikiPreview', 'class' => implode( ' ', $classes ) );
3103 if ( $this->formtype
!= 'preview' ) {
3104 $attribs['style'] = 'display: none;';
3107 $wgOut->addHTML( Xml
::openElement( 'div', $attribs ) );
3109 if ( $this->formtype
== 'preview' ) {
3110 $this->showPreview( $previewOutput );
3112 // Empty content container for LivePreview
3113 $pageViewLang = $this->mTitle
->getPageViewLanguage();
3114 $attribs = array( 'lang' => $pageViewLang->getHtmlCode(), 'dir' => $pageViewLang->getDir(),
3115 'class' => 'mw-content-' . $pageViewLang->getDir() );
3116 $wgOut->addHTML( Html
::rawElement( 'div', $attribs ) );
3119 $wgOut->addHTML( '</div>' );
3121 if ( $this->formtype
== 'diff' ) {
3124 } catch ( MWContentSerializationException
$ex ) {
3126 'content-failed-to-parse',
3127 $this->contentModel
,
3128 $this->contentFormat
,
3131 $wgOut->addWikiText( '<div class="error">' . $msg->text() . '</div>' );
3137 * Append preview output to $wgOut.
3138 * Includes category rendering if this is a category page.
3140 * @param string $text The HTML to be output for the preview.
3142 protected function showPreview( $text ) {
3144 if ( $this->mTitle
->getNamespace() == NS_CATEGORY
) {
3145 $this->mArticle
->openShowCategory();
3147 # This hook seems slightly odd here, but makes things more
3148 # consistent for extensions.
3149 Hooks
::run( 'OutputPageBeforeHTML', array( &$wgOut, &$text ) );
3150 $wgOut->addHTML( $text );
3151 if ( $this->mTitle
->getNamespace() == NS_CATEGORY
) {
3152 $this->mArticle
->closeShowCategory();
3157 * Get a diff between the current contents of the edit box and the
3158 * version of the page we're editing from.
3160 * If this is a section edit, we'll replace the section as for final
3161 * save and then make a comparison.
3163 function showDiff() {
3164 global $wgUser, $wgContLang, $wgOut;
3166 $oldtitlemsg = 'currentrev';
3167 # if message does not exist, show diff against the preloaded default
3168 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
&& !$this->mTitle
->exists() ) {
3169 $oldtext = $this->mTitle
->getDefaultMessageText();
3170 if ( $oldtext !== false ) {
3171 $oldtitlemsg = 'defaultmessagetext';
3172 $oldContent = $this->toEditContent( $oldtext );
3177 $oldContent = $this->getCurrentContent();
3180 $textboxContent = $this->toEditContent( $this->textbox1
);
3182 $newContent = $this->mArticle
->replaceSectionContent(
3183 $this->section
, $textboxContent,
3184 $this->summary
, $this->edittime
);
3186 if ( $newContent ) {
3187 ContentHandler
::runLegacyHooks( 'EditPageGetDiffText', array( $this, &$newContent ) );
3188 Hooks
::run( 'EditPageGetDiffContent', array( $this, &$newContent ) );
3190 $popts = ParserOptions
::newFromUserAndLang( $wgUser, $wgContLang );
3191 $newContent = $newContent->preSaveTransform( $this->mTitle
, $wgUser, $popts );
3194 if ( ( $oldContent && !$oldContent->isEmpty() ) ||
( $newContent && !$newContent->isEmpty() ) ) {
3195 $oldtitle = wfMessage( $oldtitlemsg )->parse();
3196 $newtitle = wfMessage( 'yourtext' )->parse();
3198 if ( !$oldContent ) {
3199 $oldContent = $newContent->getContentHandler()->makeEmptyContent();
3202 if ( !$newContent ) {
3203 $newContent = $oldContent->getContentHandler()->makeEmptyContent();
3206 $de = $oldContent->getContentHandler()->createDifferenceEngine( $this->mArticle
->getContext() );
3207 $de->setContent( $oldContent, $newContent );
3209 $difftext = $de->getDiff( $oldtitle, $newtitle );
3210 $de->showDiffStyle();
3215 $wgOut->addHTML( '<div id="wikiDiff">' . $difftext . '</div>' );
3219 * Show the header copyright warning.
3221 protected function showHeaderCopyrightWarning() {
3222 $msg = 'editpage-head-copy-warn';
3223 if ( !wfMessage( $msg )->isDisabled() ) {
3225 $wgOut->wrapWikiMsg( "<div class='editpage-head-copywarn'>\n$1\n</div>",
3226 'editpage-head-copy-warn' );
3231 * Give a chance for site and per-namespace customizations of
3232 * terms of service summary link that might exist separately
3233 * from the copyright notice.
3235 * This will display between the save button and the edit tools,
3236 * so should remain short!
3238 protected function showTosSummary() {
3239 $msg = 'editpage-tos-summary';
3240 Hooks
::run( 'EditPageTosSummary', array( $this->mTitle
, &$msg ) );
3241 if ( !wfMessage( $msg )->isDisabled() ) {
3243 $wgOut->addHTML( '<div class="mw-tos-summary">' );
3244 $wgOut->addWikiMsg( $msg );
3245 $wgOut->addHTML( '</div>' );
3249 protected function showEditTools() {
3251 $wgOut->addHTML( '<div class="mw-editTools">' .
3252 wfMessage( 'edittools' )->inContentLanguage()->parse() .
3257 * Get the copyright warning
3259 * Renamed to getCopyrightWarning(), old name kept around for backwards compatibility
3262 protected function getCopywarn() {
3263 return self
::getCopyrightWarning( $this->mTitle
);
3267 * Get the copyright warning, by default returns wikitext
3269 * @param Title $title
3270 * @param string $format Output format, valid values are any function of a Message object
3273 public static function getCopyrightWarning( $title, $format = 'plain' ) {
3274 global $wgRightsText;
3275 if ( $wgRightsText ) {
3276 $copywarnMsg = array( 'copyrightwarning',
3277 '[[' . wfMessage( 'copyrightpage' )->inContentLanguage()->text() . ']]',
3280 $copywarnMsg = array( 'copyrightwarning2',
3281 '[[' . wfMessage( 'copyrightpage' )->inContentLanguage()->text() . ']]' );
3283 // Allow for site and per-namespace customization of contribution/copyright notice.
3284 Hooks
::run( 'EditPageCopyrightWarning', array( $title, &$copywarnMsg ) );
3286 return "<div id=\"editpage-copywarn\">\n" .
3287 call_user_func_array( 'wfMessage', $copywarnMsg )->$format() . "\n</div>";
3291 * Get the Limit report for page previews
3294 * @param ParserOutput $output ParserOutput object from the parse
3295 * @return string HTML
3297 public static function getPreviewLimitReport( $output ) {
3298 if ( !$output ||
!$output->getLimitReportData() ) {
3302 $limitReport = Html
::rawElement( 'div', array( 'class' => 'mw-limitReportExplanation' ),
3303 wfMessage( 'limitreport-title' )->parseAsBlock()
3306 // Show/hide animation doesn't work correctly on a table, so wrap it in a div.
3307 $limitReport .= Html
::openElement( 'div', array( 'class' => 'preview-limit-report-wrapper' ) );
3309 $limitReport .= Html
::openElement( 'table', array(
3310 'class' => 'preview-limit-report wikitable'
3312 Html
::openElement( 'tbody' );
3314 foreach ( $output->getLimitReportData() as $key => $value ) {
3315 if ( Hooks
::run( 'ParserLimitReportFormat',
3316 array( $key, &$value, &$limitReport, true, true )
3318 $keyMsg = wfMessage( $key );
3319 $valueMsg = wfMessage( array( "$key-value-html", "$key-value" ) );
3320 if ( !$valueMsg->exists() ) {
3321 $valueMsg = new RawMessage( '$1' );
3323 if ( !$keyMsg->isDisabled() && !$valueMsg->isDisabled() ) {
3324 $limitReport .= Html
::openElement( 'tr' ) .
3325 Html
::rawElement( 'th', null, $keyMsg->parse() ) .
3326 Html
::rawElement( 'td', null, $valueMsg->params( $value )->parse() ) .
3327 Html
::closeElement( 'tr' );
3332 $limitReport .= Html
::closeElement( 'tbody' ) .
3333 Html
::closeElement( 'table' ) .
3334 Html
::closeElement( 'div' );
3336 return $limitReport;
3339 protected function showStandardInputs( &$tabindex = 2 ) {
3341 $wgOut->addHTML( "<div class='editOptions'>\n" );
3343 if ( $this->section
!= 'new' ) {
3344 $this->showSummaryInput( false, $this->summary
);
3345 $wgOut->addHTML( $this->getSummaryPreview( false, $this->summary
) );
3348 $checkboxes = $this->getCheckboxes( $tabindex,
3349 array( 'minor' => $this->minoredit
, 'watch' => $this->watchthis
) );
3350 $wgOut->addHTML( "<div class='editCheckboxes'>" . implode( $checkboxes, "\n" ) . "</div>\n" );
3352 // Show copyright warning.
3353 $wgOut->addWikiText( $this->getCopywarn() );
3354 $wgOut->addHTML( $this->editFormTextAfterWarn
);
3356 $wgOut->addHTML( "<div class='editButtons'>\n" );
3357 $wgOut->addHTML( implode( $this->getEditButtons( $tabindex ), "\n" ) . "\n" );
3359 $cancel = $this->getCancelLink();
3360 if ( $cancel !== '' ) {
3361 $cancel .= Html
::element( 'span',
3362 array( 'class' => 'mw-editButtons-pipe-separator' ),
3363 wfMessage( 'pipe-separator' )->text() );
3366 $message = wfMessage( 'edithelppage' )->inContentLanguage()->text();
3367 $edithelpurl = Skin
::makeInternalOrExternalUrl( $message );
3369 'target' => 'helpwindow',
3370 'href' => $edithelpurl,
3372 $edithelp = Html
::linkButton( wfMessage( 'edithelp' )->text(),
3373 $attrs, array( 'mw-ui-quiet' ) ) .
3374 wfMessage( 'word-separator' )->escaped() .
3375 wfMessage( 'newwindow' )->parse();
3377 $wgOut->addHTML( " <span class='cancelLink'>{$cancel}</span>\n" );
3378 $wgOut->addHTML( " <span class='editHelp'>{$edithelp}</span>\n" );
3379 $wgOut->addHTML( "</div><!-- editButtons -->\n" );
3381 Hooks
::run( 'EditPage::showStandardInputs:options', array( $this, $wgOut, &$tabindex ) );
3383 $wgOut->addHTML( "</div><!-- editOptions -->\n" );
3387 * Show an edit conflict. textbox1 is already shown in showEditForm().
3388 * If you want to use another entry point to this function, be careful.
3390 protected function showConflict() {
3393 if ( Hooks
::run( 'EditPageBeforeConflictDiff', array( &$this, &$wgOut ) ) ) {
3394 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
3396 $content1 = $this->toEditContent( $this->textbox1
);
3397 $content2 = $this->toEditContent( $this->textbox2
);
3399 $handler = ContentHandler
::getForModelID( $this->contentModel
);
3400 $de = $handler->createDifferenceEngine( $this->mArticle
->getContext() );
3401 $de->setContent( $content2, $content1 );
3403 wfMessage( 'yourtext' )->parse(),
3404 wfMessage( 'storedversion' )->text()
3407 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
3408 $this->showTextbox2();
3415 public function getCancelLink() {
3416 $cancelParams = array();
3417 if ( !$this->isConflict
&& $this->oldid
> 0 ) {
3418 $cancelParams['oldid'] = $this->oldid
;
3420 $attrs = array( 'id' => 'mw-editform-cancel' );
3422 return Linker
::linkKnown(
3423 $this->getContextTitle(),
3424 wfMessage( 'cancel' )->parse(),
3425 Html
::buttonAttributes( $attrs, array( 'mw-ui-quiet' ) ),
3431 * Returns the URL to use in the form's action attribute.
3432 * This is used by EditPage subclasses when simply customizing the action
3433 * variable in the constructor is not enough. This can be used when the
3434 * EditPage lives inside of a Special page rather than a custom page action.
3436 * @param Title $title Title object for which is being edited (where we go to for &action= links)
3439 protected function getActionURL( Title
$title ) {
3440 return $title->getLocalURL( array( 'action' => $this->action
) );
3444 * Check if a page was deleted while the user was editing it, before submit.
3445 * Note that we rely on the logging table, which hasn't been always there,
3446 * but that doesn't matter, because this only applies to brand new
3450 protected function wasDeletedSinceLastEdit() {
3451 if ( $this->deletedSinceEdit
!== null ) {
3452 return $this->deletedSinceEdit
;
3455 $this->deletedSinceEdit
= false;
3457 if ( !$this->mTitle
->exists() && $this->mTitle
->isDeletedQuick() ) {
3458 $this->lastDelete
= $this->getLastDelete();
3459 if ( $this->lastDelete
) {
3460 $deleteTime = wfTimestamp( TS_MW
, $this->lastDelete
->log_timestamp
);
3461 if ( $deleteTime > $this->starttime
) {
3462 $this->deletedSinceEdit
= true;
3467 return $this->deletedSinceEdit
;
3471 * @return bool|stdClass
3473 protected function getLastDelete() {
3474 $dbr = wfGetDB( DB_SLAVE
);
3475 $data = $dbr->selectRow(
3476 array( 'logging', 'user' ),
3489 'log_namespace' => $this->mTitle
->getNamespace(),
3490 'log_title' => $this->mTitle
->getDBkey(),
3491 'log_type' => 'delete',
3492 'log_action' => 'delete',
3496 array( 'LIMIT' => 1, 'ORDER BY' => 'log_timestamp DESC' )
3498 // Quick paranoid permission checks...
3499 if ( is_object( $data ) ) {
3500 if ( $data->log_deleted
& LogPage
::DELETED_USER
) {
3501 $data->user_name
= wfMessage( 'rev-deleted-user' )->escaped();
3504 if ( $data->log_deleted
& LogPage
::DELETED_COMMENT
) {
3505 $data->log_comment
= wfMessage( 'rev-deleted-comment' )->escaped();
3513 * Get the rendered text for previewing.
3514 * @throws MWException
3517 function getPreviewText() {
3518 global $wgOut, $wgUser, $wgRawHtml, $wgLang;
3519 global $wgAllowUserCss, $wgAllowUserJs;
3521 $stats = $wgOut->getContext()->getStats();
3523 if ( $wgRawHtml && !$this->mTokenOk
) {
3524 // Could be an offsite preview attempt. This is very unsafe if
3525 // HTML is enabled, as it could be an attack.
3527 if ( $this->textbox1
!== '' ) {
3528 // Do not put big scary notice, if previewing the empty
3529 // string, which happens when you initially edit
3530 // a category page, due to automatic preview-on-open.
3531 $parsedNote = $wgOut->parse( "<div class='previewnote'>" .
3532 wfMessage( 'session_fail_preview_html' )->text() . "</div>", true, /* interface */true );
3534 $stats->increment( 'edit.failures.session_loss' );
3541 $content = $this->toEditContent( $this->textbox1
);
3545 'AlternateEditPreview',
3546 array( $this, &$content, &$previewHTML, &$this->mParserOutput
) )
3548 return $previewHTML;
3551 # provide a anchor link to the editform
3552 $continueEditing = '<span class="mw-continue-editing">' .
3553 '[[#' . self
::EDITFORM_ID
. '|' . $wgLang->getArrow() . ' ' .
3554 wfMessage( 'continue-editing' )->text() . ']]</span>';
3555 if ( $this->mTriedSave
&& !$this->mTokenOk
) {
3556 if ( $this->mTokenOkExceptSuffix
) {
3557 $note = wfMessage( 'token_suffix_mismatch' )->plain();
3558 $stats->increment( 'edit.failures.bad_token' );
3560 $note = wfMessage( 'session_fail_preview' )->plain();
3561 $stats->increment( 'edit.failures.session_loss' );
3563 } elseif ( $this->incompleteForm
) {
3564 $note = wfMessage( 'edit_form_incomplete' )->plain();
3565 if ( $this->mTriedSave
) {
3566 $stats->increment( 'edit.failures.incomplete_form' );
3569 $note = wfMessage( 'previewnote' )->plain() . ' ' . $continueEditing;
3572 $parserOptions = $this->mArticle
->makeParserOptions( $this->mArticle
->getContext() );
3573 $parserOptions->setIsPreview( true );
3574 $parserOptions->setIsSectionPreview( !is_null( $this->section
) && $this->section
!== '' );
3576 # don't parse non-wikitext pages, show message about preview
3577 if ( $this->mTitle
->isCssJsSubpage() ||
$this->mTitle
->isCssOrJsPage() ) {
3578 if ( $this->mTitle
->isCssJsSubpage() ) {
3580 } elseif ( $this->mTitle
->isCssOrJsPage() ) {
3586 if ( $content->getModel() == CONTENT_MODEL_CSS
) {
3588 if ( $level === 'user' && !$wgAllowUserCss ) {
3591 } elseif ( $content->getModel() == CONTENT_MODEL_JAVASCRIPT
) {
3593 if ( $level === 'user' && !$wgAllowUserJs ) {
3600 # Used messages to make sure grep find them:
3601 # Messages: usercsspreview, userjspreview, sitecsspreview, sitejspreview
3602 if ( $level && $format ) {
3603 $note = "<div id='mw-{$level}{$format}preview'>" .
3604 wfMessage( "{$level}{$format}preview" )->text() .
3605 ' ' . $continueEditing . "</div>";
3609 # If we're adding a comment, we need to show the
3610 # summary as the headline
3611 if ( $this->section
=== "new" && $this->summary
!== "" ) {
3612 $content = $content->addSectionHeader( $this->summary
);
3615 $hook_args = array( $this, &$content );
3616 ContentHandler
::runLegacyHooks( 'EditPageGetPreviewText', $hook_args );
3617 Hooks
::run( 'EditPageGetPreviewContent', $hook_args );
3619 $parserOptions->enableLimitReport();
3621 # For CSS/JS pages, we should have called the ShowRawCssJs hook here.
3622 # But it's now deprecated, so never mind
3624 $pstContent = $content->preSaveTransform( $this->mTitle
, $wgUser, $parserOptions );
3625 $scopedCallback = $parserOptions->setupFakeRevision(
3626 $this->mTitle
, $pstContent, $wgUser );
3627 $parserOutput = $pstContent->getParserOutput( $this->mTitle
, null, $parserOptions );
3629 # Try to stash the edit for the final submission step
3630 # @todo: different date format preferences cause cache misses
3631 ApiStashEdit
::stashEditFromPreview(
3632 $this->getArticle(), $content, $pstContent,
3633 $parserOutput, $parserOptions, $parserOptions, wfTimestampNow()
3636 $parserOutput->setEditSectionTokens( false ); // no section edit links
3637 $previewHTML = $parserOutput->getText();
3638 $this->mParserOutput
= $parserOutput;
3639 $wgOut->addParserOutputMetadata( $parserOutput );
3641 if ( count( $parserOutput->getWarnings() ) ) {
3642 $note .= "\n\n" . implode( "\n\n", $parserOutput->getWarnings() );
3644 } catch ( MWContentSerializationException
$ex ) {
3646 'content-failed-to-parse',
3647 $this->contentModel
,
3648 $this->contentFormat
,
3651 $note .= "\n\n" . $m->parse();
3655 if ( $this->isConflict
) {
3656 $conflict = '<h2 id="mw-previewconflict">'
3657 . wfMessage( 'previewconflict' )->escaped() . "</h2>\n";
3659 $conflict = '<hr />';
3662 $previewhead = "<div class='previewnote'>\n" .
3663 '<h2 id="mw-previewheader">' . wfMessage( 'preview' )->escaped() . "</h2>" .
3664 $wgOut->parse( $note, true, /* interface */true ) . $conflict . "</div>\n";
3666 $pageViewLang = $this->mTitle
->getPageViewLanguage();
3667 $attribs = array( 'lang' => $pageViewLang->getHtmlCode(), 'dir' => $pageViewLang->getDir(),
3668 'class' => 'mw-content-' . $pageViewLang->getDir() );
3669 $previewHTML = Html
::rawElement( 'div', $attribs, $previewHTML );
3671 return $previewhead . $previewHTML . $this->previewTextAfterContent
;
3677 function getTemplates() {
3678 if ( $this->preview ||
$this->section
!= '' ) {
3679 $templates = array();
3680 if ( !isset( $this->mParserOutput
) ) {
3683 foreach ( $this->mParserOutput
->getTemplates() as $ns => $template ) {
3684 foreach ( array_keys( $template ) as $dbk ) {
3685 $templates[] = Title
::makeTitle( $ns, $dbk );
3690 return $this->mTitle
->getTemplateLinksFrom();
3695 * Shows a bulletin board style toolbar for common editing functions.
3696 * It can be disabled in the user preferences.
3698 * @param $title Title object for the page being edited (optional)
3701 static function getEditToolbar( $title = null ) {
3702 global $wgContLang, $wgOut;
3703 global $wgEnableUploads, $wgForeignFileRepos;
3705 $imagesAvailable = $wgEnableUploads ||
count( $wgForeignFileRepos );
3706 $showSignature = true;
3708 $showSignature = MWNamespace
::wantSignatures( $title->getNamespace() );
3712 * $toolarray is an array of arrays each of which includes the
3713 * opening tag, the closing tag, optionally a sample text that is
3714 * inserted between the two when no selection is highlighted
3715 * and. The tip text is shown when the user moves the mouse
3718 * Images are defined in ResourceLoaderEditToolbarModule.
3722 'id' => 'mw-editbutton-bold',
3724 'close' => '\'\'\'',
3725 'sample' => wfMessage( 'bold_sample' )->text(),
3726 'tip' => wfMessage( 'bold_tip' )->text(),
3729 'id' => 'mw-editbutton-italic',
3732 'sample' => wfMessage( 'italic_sample' )->text(),
3733 'tip' => wfMessage( 'italic_tip' )->text(),
3736 'id' => 'mw-editbutton-link',
3739 'sample' => wfMessage( 'link_sample' )->text(),
3740 'tip' => wfMessage( 'link_tip' )->text(),
3743 'id' => 'mw-editbutton-extlink',
3746 'sample' => wfMessage( 'extlink_sample' )->text(),
3747 'tip' => wfMessage( 'extlink_tip' )->text(),
3750 'id' => 'mw-editbutton-headline',
3753 'sample' => wfMessage( 'headline_sample' )->text(),
3754 'tip' => wfMessage( 'headline_tip' )->text(),
3756 $imagesAvailable ?
array(
3757 'id' => 'mw-editbutton-image',
3758 'open' => '[[' . $wgContLang->getNsText( NS_FILE
) . ':',
3760 'sample' => wfMessage( 'image_sample' )->text(),
3761 'tip' => wfMessage( 'image_tip' )->text(),
3763 $imagesAvailable ?
array(
3764 'id' => 'mw-editbutton-media',
3765 'open' => '[[' . $wgContLang->getNsText( NS_MEDIA
) . ':',
3767 'sample' => wfMessage( 'media_sample' )->text(),
3768 'tip' => wfMessage( 'media_tip' )->text(),
3771 'id' => 'mw-editbutton-nowiki',
3772 'open' => "<nowiki>",
3773 'close' => "</nowiki>",
3774 'sample' => wfMessage( 'nowiki_sample' )->text(),
3775 'tip' => wfMessage( 'nowiki_tip' )->text(),
3777 $showSignature ?
array(
3778 'id' => 'mw-editbutton-signature',
3782 'tip' => wfMessage( 'sig_tip' )->text(),
3785 'id' => 'mw-editbutton-hr',
3786 'open' => "\n----\n",
3789 'tip' => wfMessage( 'hr_tip' )->text(),
3793 $script = 'mw.loader.using("mediawiki.toolbar", function () {';
3794 foreach ( $toolarray as $tool ) {
3800 // Images are defined in ResourceLoaderEditToolbarModule
3802 // Note that we use the tip both for the ALT tag and the TITLE tag of the image.
3803 // Older browsers show a "speedtip" type message only for ALT.
3804 // Ideally these should be different, realistically they
3805 // probably don't need to be.
3813 $script .= Xml
::encodeJsCall(
3814 'mw.toolbar.addButton',
3816 ResourceLoader
::inDebugMode()
3821 $wgOut->addScript( ResourceLoader
::makeInlineScript( $script ) );
3823 $toolbar = '<div id="toolbar"></div>';
3825 Hooks
::run( 'EditPageBeforeEditToolbar', array( &$toolbar ) );
3831 * Returns an array of html code of the following checkboxes:
3834 * @param int $tabindex Current tabindex
3835 * @param array $checked Array of checkbox => bool, where bool indicates the checked
3836 * status of the checkbox
3840 public function getCheckboxes( &$tabindex, $checked ) {
3841 global $wgUser, $wgUseMediaWikiUIEverywhere;
3843 $checkboxes = array();
3845 // don't show the minor edit checkbox if it's a new page or section
3846 if ( !$this->isNew
) {
3847 $checkboxes['minor'] = '';
3848 $minorLabel = wfMessage( 'minoredit' )->parse();
3849 if ( $wgUser->isAllowed( 'minoredit' ) ) {
3851 'tabindex' => ++
$tabindex,
3852 'accesskey' => wfMessage( 'accesskey-minoredit' )->text(),
3853 'id' => 'wpMinoredit',
3856 Xml
::check( 'wpMinoredit', $checked['minor'], $attribs ) .
3857 " <label for='wpMinoredit' id='mw-editpage-minoredit'" .
3858 Xml
::expandAttributes( array( 'title' => Linker
::titleAttrib( 'minoredit', 'withaccess' ) ) ) .
3859 ">{$minorLabel}</label>";
3861 if ( $wgUseMediaWikiUIEverywhere ) {
3862 $checkboxes['minor'] = Html
::openElement( 'div', array( 'class' => 'mw-ui-checkbox' ) ) .
3864 Html
::closeElement( 'div' );
3866 $checkboxes['minor'] = $minorEditHtml;
3871 $watchLabel = wfMessage( 'watchthis' )->parse();
3872 $checkboxes['watch'] = '';
3873 if ( $wgUser->isLoggedIn() ) {
3875 'tabindex' => ++
$tabindex,
3876 'accesskey' => wfMessage( 'accesskey-watch' )->text(),
3877 'id' => 'wpWatchthis',
3880 Xml
::check( 'wpWatchthis', $checked['watch'], $attribs ) .
3881 " <label for='wpWatchthis' id='mw-editpage-watch'" .
3882 Xml
::expandAttributes( array( 'title' => Linker
::titleAttrib( 'watch', 'withaccess' ) ) ) .
3883 ">{$watchLabel}</label>";
3884 if ( $wgUseMediaWikiUIEverywhere ) {
3885 $checkboxes['watch'] = Html
::openElement( 'div', array( 'class' => 'mw-ui-checkbox' ) ) .
3887 Html
::closeElement( 'div' );
3889 $checkboxes['watch'] = $watchThisHtml;
3892 Hooks
::run( 'EditPageBeforeEditChecks', array( &$this, &$checkboxes, &$tabindex ) );
3897 * Returns an array of html code of the following buttons:
3898 * save, diff, preview and live
3900 * @param int $tabindex Current tabindex
3904 public function getEditButtons( &$tabindex ) {
3910 'tabindex' => ++
$tabindex,
3911 ) + Linker
::tooltipAndAccesskeyAttribs( 'save' );
3912 $buttons['save'] = Html
::submitButton( wfMessage( 'savearticle' )->text(),
3913 $attribs, array( 'mw-ui-constructive' ) );
3915 ++
$tabindex; // use the same for preview and live preview
3917 'id' => 'wpPreview',
3918 'name' => 'wpPreview',
3919 'tabindex' => $tabindex,
3920 ) + Linker
::tooltipAndAccesskeyAttribs( 'preview' );
3921 $buttons['preview'] = Html
::submitButton( wfMessage( 'showpreview' )->text(),
3923 $buttons['live'] = '';
3928 'tabindex' => ++
$tabindex,
3929 ) + Linker
::tooltipAndAccesskeyAttribs( 'diff' );
3930 $buttons['diff'] = Html
::submitButton( wfMessage( 'showdiff' )->text(),
3933 Hooks
::run( 'EditPageBeforeEditButtons', array( &$this, &$buttons, &$tabindex ) );
3938 * Creates a basic error page which informs the user that
3939 * they have attempted to edit a nonexistent section.
3941 function noSuchSectionPage() {
3944 $wgOut->prepareErrorPage( wfMessage( 'nosuchsectiontitle' ) );
3946 $res = wfMessage( 'nosuchsectiontext', $this->section
)->parseAsBlock();
3947 Hooks
::run( 'EditPageNoSuchSection', array( &$this, &$res ) );
3948 $wgOut->addHTML( $res );
3950 $wgOut->returnToMain( false, $this->mTitle
);
3954 * Show "your edit contains spam" page with your diff and text
3956 * @param string|array|bool $match Text (or array of texts) which triggered one or more filters
3958 public function spamPageWithContent( $match = false ) {
3959 global $wgOut, $wgLang;
3960 $this->textbox2
= $this->textbox1
;
3962 if ( is_array( $match ) ) {
3963 $match = $wgLang->listToText( $match );
3965 $wgOut->prepareErrorPage( wfMessage( 'spamprotectiontitle' ) );
3967 $wgOut->addHTML( '<div id="spamprotected">' );
3968 $wgOut->addWikiMsg( 'spamprotectiontext' );
3970 $wgOut->addWikiMsg( 'spamprotectionmatch', wfEscapeWikiText( $match ) );
3972 $wgOut->addHTML( '</div>' );
3974 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
3977 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
3978 $this->showTextbox2();
3980 $wgOut->addReturnTo( $this->getContextTitle(), array( 'action' => 'edit' ) );
3984 * Check if the browser is on a blacklist of user-agents known to
3985 * mangle UTF-8 data on form submission. Returns true if Unicode
3986 * should make it through, false if it's known to be a problem.
3989 private function checkUnicodeCompliantBrowser() {
3990 global $wgBrowserBlackList, $wgRequest;
3992 $currentbrowser = $wgRequest->getHeader( 'User-Agent' );
3993 if ( $currentbrowser === false ) {
3994 // No User-Agent header sent? Trust it by default...
3998 foreach ( $wgBrowserBlackList as $browser ) {
3999 if ( preg_match( $browser, $currentbrowser ) ) {
4007 * Filter an input field through a Unicode de-armoring process if it
4008 * came from an old browser with known broken Unicode editing issues.
4010 * @param WebRequest $request
4011 * @param string $field
4014 protected function safeUnicodeInput( $request, $field ) {
4015 $text = rtrim( $request->getText( $field ) );
4016 return $request->getBool( 'safemode' )
4017 ?
$this->unmakeSafe( $text )
4022 * Filter an output field through a Unicode armoring process if it is
4023 * going to an old browser with known broken Unicode editing issues.
4025 * @param string $text
4028 protected function safeUnicodeOutput( $text ) {
4030 $codedText = $wgContLang->recodeForEdit( $text );
4031 return $this->checkUnicodeCompliantBrowser()
4033 : $this->makeSafe( $codedText );
4037 * A number of web browsers are known to corrupt non-ASCII characters
4038 * in a UTF-8 text editing environment. To protect against this,
4039 * detected browsers will be served an armored version of the text,
4040 * with non-ASCII chars converted to numeric HTML character references.
4042 * Preexisting such character references will have a 0 added to them
4043 * to ensure that round-trips do not alter the original data.
4045 * @param string $invalue
4048 private function makeSafe( $invalue ) {
4049 // Armor existing references for reversibility.
4050 $invalue = strtr( $invalue, array( "&#x" => "�" ) );
4055 $valueLength = strlen( $invalue );
4056 for ( $i = 0; $i < $valueLength; $i++
) {
4057 $bytevalue = ord( $invalue[$i] );
4058 if ( $bytevalue <= 0x7F ) { // 0xxx xxxx
4059 $result .= chr( $bytevalue );
4061 } elseif ( $bytevalue <= 0xBF ) { // 10xx xxxx
4062 $working = $working << 6;
4063 $working +
= ( $bytevalue & 0x3F );
4065 if ( $bytesleft <= 0 ) {
4066 $result .= "&#x" . strtoupper( dechex( $working ) ) . ";";
4068 } elseif ( $bytevalue <= 0xDF ) { // 110x xxxx
4069 $working = $bytevalue & 0x1F;
4071 } elseif ( $bytevalue <= 0xEF ) { // 1110 xxxx
4072 $working = $bytevalue & 0x0F;
4074 } else { // 1111 0xxx
4075 $working = $bytevalue & 0x07;
4083 * Reverse the previously applied transliteration of non-ASCII characters
4084 * back to UTF-8. Used to protect data from corruption by broken web browsers
4085 * as listed in $wgBrowserBlackList.
4087 * @param string $invalue
4090 private function unmakeSafe( $invalue ) {
4092 $valueLength = strlen( $invalue );
4093 for ( $i = 0; $i < $valueLength; $i++
) {
4094 if ( ( substr( $invalue, $i, 3 ) == "&#x" ) && ( $invalue[$i +
3] != '0' ) ) {
4098 $hexstring .= $invalue[$i];
4100 } while ( ctype_xdigit( $invalue[$i] ) && ( $i < strlen( $invalue ) ) );
4102 // Do some sanity checks. These aren't needed for reversibility,
4103 // but should help keep the breakage down if the editor
4104 // breaks one of the entities whilst editing.
4105 if ( ( substr( $invalue, $i, 1 ) == ";" ) && ( strlen( $hexstring ) <= 6 ) ) {
4106 $codepoint = hexdec( $hexstring );
4107 $result .= UtfNormal\Utils
::codepointToUtf8( $codepoint );
4109 $result .= "&#x" . $hexstring . substr( $invalue, $i, 1 );
4112 $result .= substr( $invalue, $i, 1 );
4115 // reverse the transform that we made for reversibility reasons.
4116 return strtr( $result, array( "�" => "&#x" ) );