3 * Page edition user interface.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
24 * The edit page/HTML interface (split from Article)
25 * The actual database and text munging is still in Article,
26 * but it should get easier to call those from alternate
29 * EditPage cares about two distinct titles:
30 * $this->mContextTitle is the page that forms submit to, links point to,
31 * redirects go to, etc. $this->mTitle (as well as $mArticle) is the
32 * page in the database that is actually being edited. These are
33 * usually the same, but they are now allowed to be different.
35 * Surgeon General's Warning: prolonged exposure to this class is known to cause
36 * headaches, which may be fatal.
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: User cannot edit? (not used)
72 const AS_USER_CANNOT_EDIT
= 217;
75 * Status: this anonymous user is not allowed to edit this page
77 const AS_READ_ONLY_PAGE_ANON
= 218;
80 * Status: this logged in user is not allowed to edit this page
82 const AS_READ_ONLY_PAGE_LOGGED
= 219;
85 * Status: wiki is in readonly mode (wfReadOnly() == true)
87 const AS_READ_ONLY_PAGE
= 220;
90 * Status: rate limiter for action 'edit' was tripped
92 const AS_RATE_LIMITED
= 221;
95 * Status: article was deleted while editing and param wpRecreate == false or form
98 const AS_ARTICLE_WAS_DELETED
= 222;
101 * Status: user tried to create this page, but is not allowed to do that
102 * ( Title->userCan('create') == false )
104 const AS_NO_CREATE_PERMISSION
= 223;
107 * Status: user tried to create a blank page
109 const AS_BLANK_ARTICLE
= 224;
112 * Status: (non-resolvable) edit conflict
114 const AS_CONFLICT_DETECTED
= 225;
117 * Status: no edit summary given and the user has forceeditsummary set and the user is not
118 * editing in his own userspace or talkspace and wpIgnoreBlankSummary == false
120 const AS_SUMMARY_NEEDED
= 226;
123 * Status: user tried to create a new section without content
125 const AS_TEXTBOX_EMPTY
= 228;
128 * Status: article is too big (> $wgMaxArticleSize), after merging in the new section
130 const AS_MAX_ARTICLE_SIZE_EXCEEDED
= 229;
138 * Status: WikiPage::doEdit() was unsuccessful
143 * Status: summary contained spam according to one of the regexes in $wgSummarySpamRegex
145 const AS_SPAM_ERROR
= 232;
148 * Status: anonymous user is not allowed to upload (User::isAllowed('upload') == false)
150 const AS_IMAGE_REDIRECT_ANON
= 233;
153 * Status: logged in user is not allowed to upload (User::isAllowed('upload') == false)
155 const AS_IMAGE_REDIRECT_LOGGED
= 234;
158 * Status: can't parse content
160 const AS_PARSE_ERROR
= 240;
163 * HTML id and name for the beginning of the edit form.
165 const EDITFORM_ID
= 'editform';
168 * Prefix of key for cookie used to pass post-edit state.
169 * The revision id edited is added after this
171 const POST_EDIT_COOKIE_KEY_PREFIX
= 'PostEditRevision';
174 * Duration of PostEdit cookie, in seconds.
175 * The cookie will be removed instantly if the JavaScript runs.
177 * Otherwise, though, we don't want the cookies to accumulate.
178 * RFC 2109 ( https://www.ietf.org/rfc/rfc2109.txt ) specifies a possible limit of only 20 cookies per domain.
179 * This still applies at least to some versions of IE without full updates:
180 * https://blogs.msdn.com/b/ieinternals/archive/2009/08/20/wininet-ie-cookie-internals-faq.aspx
182 * A value of 20 minutes should be enough to take into account slow loads and minor
183 * clock skew while still avoiding cookie accumulation when JavaScript is turned off.
185 const POST_EDIT_COOKIE_DURATION
= 1200;
196 private $mContextTitle = null;
197 var $action = 'submit';
198 var $isConflict = false;
199 var $isCssJsSubpage = false;
200 var $isCssSubpage = false;
201 var $isJsSubpage = false;
202 var $isWrongCaseCssJsPage = false;
203 var $isNew = false; // new page or new section
204 var $deletedSinceEdit;
208 var $mTokenOk = false;
209 var $mTokenOkExceptSuffix = false;
210 var $mTriedSave = false;
211 var $incompleteForm = false;
213 var $kblength = false;
214 var $missingComment = false;
215 var $missingSummary = false;
216 var $allowBlankSummary = false;
219 #var $mPreviewTemplates;
227 * Has a summary been preset using GET parameter &summary= ?
230 var $hasPresetSummary = false;
232 var $mBaseRevision = false;
233 var $mShowSummaryField = true;
236 var $save = false, $preview = false, $diff = false;
237 var $minoredit = false, $watchthis = false, $recreate = false;
238 var $textbox1 = '', $textbox2 = '', $summary = '', $nosummary = false;
239 var $edittime = '', $section = '', $sectiontitle = '', $starttime = '';
240 var $oldid = 0, $editintro = '', $scrolltop = null, $bot = true;
241 var $contentModel = null, $contentFormat = null;
243 # Placeholders for text injection by hooks (must be HTML)
244 # extensions should take care to _append_ to the present value
245 public $editFormPageTop = ''; // Before even the preview
246 public $editFormTextTop = '';
247 public $editFormTextBeforeContent = '';
248 public $editFormTextAfterWarn = '';
249 public $editFormTextAfterTools = '';
250 public $editFormTextBottom = '';
251 public $editFormTextAfterContent = '';
252 public $previewTextAfterContent = '';
253 public $mPreloadContent = null;
255 /* $didSave should be set to true whenever an article was successfully altered. */
256 public $didSave = false;
257 public $undidRev = 0;
259 public $suppressIntro = false;
262 * Set to true to allow editing of non-text content types.
266 public $allowNonTextContent = false;
269 * @param $article Article
271 public function __construct( Article
$article ) {
272 $this->mArticle
= $article;
273 $this->mTitle
= $article->getTitle();
275 $this->contentModel
= $this->mTitle
->getContentModel();
277 $handler = ContentHandler
::getForModelID( $this->contentModel
);
278 $this->contentFormat
= $handler->getDefaultFormat();
284 public function getArticle() {
285 return $this->mArticle
;
292 public function getTitle() {
293 return $this->mTitle
;
297 * Set the context Title object
299 * @param $title Title object or null
301 public function setContextTitle( $title ) {
302 $this->mContextTitle
= $title;
306 * Get the context title object.
307 * If not set, $wgTitle will be returned. This behavior might change in
308 * the future to return $this->mTitle instead.
310 * @return Title object
312 public function getContextTitle() {
313 if ( is_null( $this->mContextTitle
) ) {
317 return $this->mContextTitle
;
322 * Returns if the given content model is editable.
324 * @param string $modelId The ID of the content model to test. Use CONTENT_MODEL_XXX constants.
326 * @throws MWException if $modelId has no known handler
328 public function isSupportedContentModel( $modelId ) {
329 return $this->allowNonTextContent ||
330 ContentHandler
::getForModelID( $modelId ) instanceof TextContentHandler
;
338 * This is the function that gets called for "action=edit". It
339 * sets up various member variables, then passes execution to
340 * another function, usually showEditForm()
342 * The edit form is self-submitting, so that when things like
343 * preview and edit conflicts occur, we get the same form back
344 * with the extra stuff added. Only when the final submission
345 * is made and all is well do we actually save and redirect to
346 * the newly-edited page.
349 global $wgOut, $wgRequest, $wgUser;
350 // Allow extensions to modify/prevent this form or submission
351 if ( !wfRunHooks( 'AlternateEdit', array( $this ) ) ) {
355 wfProfileIn( __METHOD__
);
356 wfDebug( __METHOD__
. ": enter\n" );
358 // If they used redlink=1 and the page exists, redirect to the main article
359 if ( $wgRequest->getBool( 'redlink' ) && $this->mTitle
->exists() ) {
360 $wgOut->redirect( $this->mTitle
->getFullURL() );
361 wfProfileOut( __METHOD__
);
365 $this->importFormData( $wgRequest );
366 $this->firsttime
= false;
369 $this->livePreview();
370 wfProfileOut( __METHOD__
);
374 if ( wfReadOnly() && $this->save
) {
377 $this->preview
= true;
381 $this->formtype
= 'save';
382 } elseif ( $this->preview
) {
383 $this->formtype
= 'preview';
384 } elseif ( $this->diff
) {
385 $this->formtype
= 'diff';
386 } else { # First time through
387 $this->firsttime
= true;
388 if ( $this->previewOnOpen() ) {
389 $this->formtype
= 'preview';
391 $this->formtype
= 'initial';
395 $permErrors = $this->getEditPermissionErrors();
397 wfDebug( __METHOD__
. ": User can't edit\n" );
398 // Auto-block user's IP if the account was "hard" blocked
399 $wgUser->spreadAnyEditBlock();
401 $this->displayPermissionsError( $permErrors );
403 wfProfileOut( __METHOD__
);
407 wfProfileIn( __METHOD__
. "-business-end" );
409 $this->isConflict
= false;
410 // css / js subpages of user pages get a special treatment
411 $this->isCssJsSubpage
= $this->mTitle
->isCssJsSubpage();
412 $this->isCssSubpage
= $this->mTitle
->isCssSubpage();
413 $this->isJsSubpage
= $this->mTitle
->isJsSubpage();
414 $this->isWrongCaseCssJsPage
= $this->isWrongCaseCssJsPage();
416 # Show applicable editing introductions
417 if ( $this->formtype
== 'initial' ||
$this->firsttime
) {
421 # Attempt submission here. This will check for edit conflicts,
422 # and redundantly check for locked database, blocked IPs, etc.
423 # that edit() already checked just in case someone tries to sneak
424 # in the back door with a hand-edited submission URL.
426 if ( 'save' == $this->formtype
) {
427 if ( !$this->attemptSave() ) {
428 wfProfileOut( __METHOD__
. "-business-end" );
429 wfProfileOut( __METHOD__
);
434 # First time through: get contents, set time for conflict
436 if ( 'initial' == $this->formtype ||
$this->firsttime
) {
437 if ( $this->initialiseForm() === false ) {
438 $this->noSuchSectionPage();
439 wfProfileOut( __METHOD__
. "-business-end" );
440 wfProfileOut( __METHOD__
);
444 if ( !$this->mTitle
->getArticleID() ) {
445 wfRunHooks( 'EditFormPreloadText', array( &$this->textbox1
, &$this->mTitle
) );
447 wfRunHooks( 'EditFormInitialText', array( $this ) );
452 $this->showEditForm();
453 wfProfileOut( __METHOD__
. "-business-end" );
454 wfProfileOut( __METHOD__
);
460 protected function getEditPermissionErrors() {
462 $permErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $wgUser );
463 # Can this title be created?
464 if ( !$this->mTitle
->exists() ) {
465 $permErrors = array_merge( $permErrors,
466 wfArrayDiff2( $this->mTitle
->getUserPermissionsErrors( 'create', $wgUser ), $permErrors ) );
468 # Ignore some permissions errors when a user is just previewing/viewing diffs
470 foreach ( $permErrors as $error ) {
471 if ( ( $this->preview ||
$this->diff
)
472 && ( $error[0] == 'blockedtext' ||
$error[0] == 'autoblockedtext' )
477 $permErrors = wfArrayDiff2( $permErrors, $remove );
482 * Display a permissions error page, like OutputPage::showPermissionsErrorPage(),
483 * but with the following differences:
484 * - If redlink=1, the user will be redirected to the page
485 * - If there is content to display or the error occurs while either saving,
486 * previewing or showing the difference, it will be a
487 * "View source for ..." page displaying the source code after the error message.
490 * @param array $permErrors of permissions errors, as returned by
491 * Title::getUserPermissionsErrors().
492 * @throws PermissionsError
494 protected function displayPermissionsError( array $permErrors ) {
495 global $wgRequest, $wgOut;
497 if ( $wgRequest->getBool( 'redlink' ) ) {
498 // The edit page was reached via a red link.
499 // Redirect to the article page and let them click the edit tab if
500 // they really want a permission error.
501 $wgOut->redirect( $this->mTitle
->getFullURL() );
505 $content = $this->getContentObject();
507 # Use the normal message if there's nothing to display
508 if ( $this->firsttime
&& ( !$content ||
$content->isEmpty() ) ) {
509 $action = $this->mTitle
->exists() ?
'edit' :
510 ( $this->mTitle
->isTalkPage() ?
'createtalk' : 'createpage' );
511 throw new PermissionsError( $action, $permErrors );
514 $wgOut->setRobotPolicy( 'noindex,nofollow' );
515 $wgOut->setPageTitle( wfMessage( 'viewsource-title', $this->getContextTitle()->getPrefixedText() ) );
516 $wgOut->addBacklinkSubtitle( $this->getContextTitle() );
517 $wgOut->addWikiText( $wgOut->formatPermissionsErrorMessage( $permErrors, 'edit' ) );
518 $wgOut->addHTML( "<hr />\n" );
520 # If the user made changes, preserve them when showing the markup
521 # (This happens when a user is blocked during edit, for instance)
522 if ( !$this->firsttime
) {
523 $text = $this->textbox1
;
524 $wgOut->addWikiMsg( 'viewyourtext' );
526 $text = $this->toEditText( $content );
527 $wgOut->addWikiMsg( 'viewsourcetext' );
530 $this->showTextbox( $text, 'wpTextbox1', array( 'readonly' ) );
532 $wgOut->addHTML( Html
::rawElement( 'div', array( 'class' => 'templatesUsed' ),
533 Linker
::formatTemplates( $this->getTemplates() ) ) );
535 $wgOut->addModules( 'mediawiki.action.edit.collapsibleFooter' );
537 if ( $this->mTitle
->exists() ) {
538 $wgOut->returnToMain( null, $this->mTitle
);
543 * Show a read-only error
544 * Parameters are the same as OutputPage:readOnlyPage()
545 * Redirect to the article page if redlink=1
546 * @deprecated in 1.19; use displayPermissionsError() instead
548 function readOnlyPage( $source = null, $protected = false, $reasons = array(), $action = null ) {
549 wfDeprecated( __METHOD__
, '1.19' );
551 global $wgRequest, $wgOut;
552 if ( $wgRequest->getBool( 'redlink' ) ) {
553 // The edit page was reached via a red link.
554 // Redirect to the article page and let them click the edit tab if
555 // they really want a permission error.
556 $wgOut->redirect( $this->mTitle
->getFullURL() );
558 $wgOut->readOnlyPage( $source, $protected, $reasons, $action );
563 * Should we show a preview when the edit form is first shown?
567 protected function previewOnOpen() {
568 global $wgRequest, $wgUser, $wgPreviewOnOpenNamespaces;
569 if ( $wgRequest->getVal( 'preview' ) == 'yes' ) {
570 // Explicit override from request
572 } elseif ( $wgRequest->getVal( 'preview' ) == 'no' ) {
573 // Explicit override from request
575 } elseif ( $this->section
== 'new' ) {
576 // Nothing *to* preview for new sections
578 } elseif ( ( $wgRequest->getVal( 'preload' ) !== null ||
$this->mTitle
->exists() ) && $wgUser->getOption( 'previewonfirst' ) ) {
579 // Standard preference behavior
581 } elseif ( !$this->mTitle
->exists()
582 && isset( $wgPreviewOnOpenNamespaces[$this->mTitle
->getNamespace()] )
583 && $wgPreviewOnOpenNamespaces[$this->mTitle
->getNamespace()]
585 // Categories are special
593 * Checks whether the user entered a skin name in uppercase,
594 * e.g. "User:Example/Monobook.css" instead of "monobook.css"
598 protected function isWrongCaseCssJsPage() {
599 if ( $this->mTitle
->isCssJsSubpage() ) {
600 $name = $this->mTitle
->getSkinFromCssJsSubpage();
601 $skins = array_merge(
602 array_keys( Skin
::getSkinNames() ),
605 return !in_array( $name, $skins )
606 && in_array( strtolower( $name ), $skins );
613 * Returns whether section editing is supported for the current page.
614 * Subclasses may override this to replace the default behavior, which is
615 * to check ContentHandler::supportsSections.
617 * @return bool true if this edit page supports sections, false otherwise.
619 protected function isSectionEditSupported() {
620 $contentHandler = ContentHandler
::getForTitle( $this->mTitle
);
621 return $contentHandler->supportsSections();
625 * This function collects the form data and uses it to populate various member variables.
626 * @param $request WebRequest
627 * @throws ErrorPageError
629 function importFormData( &$request ) {
630 global $wgContLang, $wgUser;
632 wfProfileIn( __METHOD__
);
634 # Section edit can come from either the form or a link
635 $this->section
= $request->getVal( 'wpSection', $request->getVal( 'section' ) );
637 if ( $this->section
!== null && $this->section
!== '' && !$this->isSectionEditSupported() ) {
638 wfProfileOut( __METHOD__
);
639 throw new ErrorPageError( 'sectioneditnotsupported-title', 'sectioneditnotsupported-text' );
642 $this->isNew
= !$this->mTitle
->exists() ||
$this->section
== 'new';
644 if ( $request->wasPosted() ) {
645 # These fields need to be checked for encoding.
646 # Also remove trailing whitespace, but don't remove _initial_
647 # whitespace from the text boxes. This may be significant formatting.
648 $this->textbox1
= $this->safeUnicodeInput( $request, 'wpTextbox1' );
649 if ( !$request->getCheck( 'wpTextbox2' ) ) {
650 // Skip this if wpTextbox2 has input, it indicates that we came
651 // from a conflict page with raw page text, not a custom form
652 // modified by subclasses
653 wfProfileIn( get_class( $this ) . "::importContentFormData" );
654 $textbox1 = $this->importContentFormData( $request );
655 if ( $textbox1 !== null ) {
656 $this->textbox1
= $textbox1;
659 wfProfileOut( get_class( $this ) . "::importContentFormData" );
662 # Truncate for whole multibyte characters
663 $this->summary
= $wgContLang->truncate( $request->getText( 'wpSummary' ), 255 );
665 # If the summary consists of a heading, e.g. '==Foobar==', extract the title from the
666 # header syntax, e.g. 'Foobar'. This is mainly an issue when we are using wpSummary for
668 $this->summary
= preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->summary
);
670 # Treat sectiontitle the same way as summary.
671 # Note that wpSectionTitle is not yet a part of the actual edit form, as wpSummary is
672 # currently doing double duty as both edit summary and section title. Right now this
673 # is just to allow API edits to work around this limitation, but this should be
674 # incorporated into the actual edit form when EditPage is rewritten (Bugs 18654, 26312).
675 $this->sectiontitle
= $wgContLang->truncate( $request->getText( 'wpSectionTitle' ), 255 );
676 $this->sectiontitle
= preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->sectiontitle
);
678 $this->edittime
= $request->getVal( 'wpEdittime' );
679 $this->starttime
= $request->getVal( 'wpStarttime' );
681 $undidRev = $request->getInt( 'wpUndidRevision' );
683 $this->undidRev
= $undidRev;
686 $this->scrolltop
= $request->getIntOrNull( 'wpScrolltop' );
688 if ( $this->textbox1
=== '' && $request->getVal( 'wpTextbox1' ) === null ) {
689 // wpTextbox1 field is missing, possibly due to being "too big"
690 // according to some filter rules such as Suhosin's setting for
691 // suhosin.request.max_value_length (d'oh)
692 $this->incompleteForm
= true;
694 // edittime should be one of our last fields; if it's missing,
695 // the submission probably broke somewhere in the middle.
696 $this->incompleteForm
= is_null( $this->edittime
);
698 if ( $this->incompleteForm
) {
699 # If the form is incomplete, force to preview.
700 wfDebug( __METHOD__
. ": Form data appears to be incomplete\n" );
701 wfDebug( "POST DATA: " . var_export( $_POST, true ) . "\n" );
702 $this->preview
= true;
704 /* Fallback for live preview */
705 $this->preview
= $request->getCheck( 'wpPreview' ) ||
$request->getCheck( 'wpLivePreview' );
706 $this->diff
= $request->getCheck( 'wpDiff' );
708 // Remember whether a save was requested, so we can indicate
709 // if we forced preview due to session failure.
710 $this->mTriedSave
= !$this->preview
;
712 if ( $this->tokenOk( $request ) ) {
713 # Some browsers will not report any submit button
714 # if the user hits enter in the comment box.
715 # The unmarked state will be assumed to be a save,
716 # if the form seems otherwise complete.
717 wfDebug( __METHOD__
. ": Passed token check.\n" );
718 } elseif ( $this->diff
) {
719 # Failed token check, but only requested "Show Changes".
720 wfDebug( __METHOD__
. ": Failed token check; Show Changes requested.\n" );
722 # Page might be a hack attempt posted from
723 # an external site. Preview instead of saving.
724 wfDebug( __METHOD__
. ": Failed token check; forcing preview\n" );
725 $this->preview
= true;
728 $this->save
= !$this->preview
&& !$this->diff
;
729 if ( !preg_match( '/^\d{14}$/', $this->edittime
) ) {
730 $this->edittime
= null;
733 if ( !preg_match( '/^\d{14}$/', $this->starttime
) ) {
734 $this->starttime
= null;
737 $this->recreate
= $request->getCheck( 'wpRecreate' );
739 $this->minoredit
= $request->getCheck( 'wpMinoredit' );
740 $this->watchthis
= $request->getCheck( 'wpWatchthis' );
742 # Don't force edit summaries when a user is editing their own user or talk page
743 if ( ( $this->mTitle
->mNamespace
== NS_USER ||
$this->mTitle
->mNamespace
== NS_USER_TALK
)
744 && $this->mTitle
->getText() == $wgUser->getName()
746 $this->allowBlankSummary
= true;
748 $this->allowBlankSummary
= $request->getBool( 'wpIgnoreBlankSummary' ) ||
!$wgUser->getOption( 'forceeditsummary' );
751 $this->autoSumm
= $request->getText( 'wpAutoSummary' );
753 # Not a posted form? Start with nothing.
754 wfDebug( __METHOD__
. ": Not a posted form.\n" );
755 $this->textbox1
= '';
757 $this->sectiontitle
= '';
758 $this->edittime
= '';
759 $this->starttime
= wfTimestampNow();
761 $this->preview
= false;
764 $this->minoredit
= false;
765 $this->watchthis
= $request->getBool( 'watchthis', false ); // Watch may be overridden by request parameters
766 $this->recreate
= false;
768 // When creating a new section, we can preload a section title by passing it as the
769 // preloadtitle parameter in the URL (Bug 13100)
770 if ( $this->section
== 'new' && $request->getVal( 'preloadtitle' ) ) {
771 $this->sectiontitle
= $request->getVal( 'preloadtitle' );
772 // Once wpSummary isn't being use for setting section titles, we should delete this.
773 $this->summary
= $request->getVal( 'preloadtitle' );
774 } elseif ( $this->section
!= 'new' && $request->getVal( 'summary' ) ) {
775 $this->summary
= $request->getText( 'summary' );
776 if ( $this->summary
!== '' ) {
777 $this->hasPresetSummary
= true;
781 if ( $request->getVal( 'minor' ) ) {
782 $this->minoredit
= true;
786 $this->oldid
= $request->getInt( 'oldid' );
788 $this->bot
= $request->getBool( 'bot', true );
789 $this->nosummary
= $request->getBool( 'nosummary' );
791 $this->contentModel
= $request->getText( 'model', $this->contentModel
); #may be overridden by revision
792 $this->contentFormat
= $request->getText( 'format', $this->contentFormat
); #may be overridden by revision
794 if ( !ContentHandler
::getForModelID( $this->contentModel
)->isSupportedFormat( $this->contentFormat
) ) {
795 throw new ErrorPageError(
796 'editpage-notsupportedcontentformat-title',
797 'editpage-notsupportedcontentformat-text',
798 array( $this->contentFormat
, ContentHandler
::getLocalizedName( $this->contentModel
) )
801 #TODO: check if the desired model is allowed in this namespace, and if a transition from the page's current model to the new model is allowed
803 $this->live
= $request->getCheck( 'live' );
804 $this->editintro
= $request->getText( 'editintro',
805 // Custom edit intro for new sections
806 $this->section
=== 'new' ?
'MediaWiki:addsection-editintro' : '' );
808 // Allow extensions to modify form data
809 wfRunHooks( 'EditPage::importFormData', array( $this, $request ) );
811 wfProfileOut( __METHOD__
);
815 * Subpage overridable method for extracting the page content data from the
816 * posted form to be placed in $this->textbox1, if using customized input
817 * this method should be overridden and return the page text that will be used
818 * for saving, preview parsing and so on...
820 * @param $request WebRequest
822 protected function importContentFormData( &$request ) {
823 return; // Don't do anything, EditPage already extracted wpTextbox1
827 * Initialise form fields in the object
828 * Called on the first invocation, e.g. when a user clicks an edit link
829 * @return bool -- if the requested section is valid
831 function initialiseForm() {
833 $this->edittime
= $this->mArticle
->getTimestamp();
835 $content = $this->getContentObject( false ); #TODO: track content object?!
836 if ( $content === false ) {
839 $this->textbox1
= $this->toEditText( $content );
841 // activate checkboxes if user wants them to be always active
842 # Sort out the "watch" checkbox
843 if ( $wgUser->getOption( 'watchdefault' ) ) {
845 $this->watchthis
= true;
846 } elseif ( $wgUser->getOption( 'watchcreations' ) && !$this->mTitle
->exists() ) {
848 $this->watchthis
= true;
849 } elseif ( $wgUser->isWatched( $this->mTitle
) ) {
851 $this->watchthis
= true;
853 if ( $wgUser->getOption( 'minordefault' ) && !$this->isNew
) {
854 $this->minoredit
= true;
856 if ( $this->textbox1
=== false ) {
863 * Fetch initial editing page content.
865 * @param $def_text string|bool
866 * @return mixed string on success, $def_text for invalid sections
868 * @deprecated since 1.21, get WikiPage::getContent() instead.
870 function getContent( $def_text = false ) {
871 ContentHandler
::deprecated( __METHOD__
, '1.21' );
873 if ( $def_text !== null && $def_text !== false && $def_text !== '' ) {
874 $def_content = $this->toEditContent( $def_text );
876 $def_content = false;
879 $content = $this->getContentObject( $def_content );
881 // Note: EditPage should only be used with text based content anyway.
882 return $this->toEditText( $content );
886 * @param Content|null $def_content The default value to return
888 * @return mixed Content on success, $def_content for invalid sections
892 protected function getContentObject( $def_content = null ) {
893 global $wgOut, $wgRequest, $wgUser, $wgContLang;
895 wfProfileIn( __METHOD__
);
899 // For message page not locally set, use the i18n message.
900 // For other non-existent articles, use preload text if any.
901 if ( !$this->mTitle
->exists() ||
$this->section
== 'new' ) {
902 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
&& $this->section
!= 'new' ) {
903 # If this is a system message, get the default text.
904 $msg = $this->mTitle
->getDefaultMessageText();
906 $content = $this->toEditContent( $msg );
908 if ( $content === false ) {
909 # If requested, preload some text.
910 $preload = $wgRequest->getVal( 'preload',
911 // Custom preload text for new sections
912 $this->section
=== 'new' ?
'MediaWiki:addsection-preload' : '' );
913 $params = $wgRequest->getArray( 'preloadparams', array() );
915 $content = $this->getPreloadedContent( $preload, $params );
917 // For existing pages, get text based on "undo" or section parameters.
919 if ( $this->section
!= '' ) {
920 // Get section edit text (returns $def_text for invalid sections)
921 $orig = $this->getOriginalContent();
922 $content = $orig ?
$orig->getSection( $this->section
) : null;
925 $content = $def_content;
928 $undoafter = $wgRequest->getInt( 'undoafter' );
929 $undo = $wgRequest->getInt( 'undo' );
931 if ( $undo > 0 && $undoafter > 0 ) {
933 $undorev = Revision
::newFromId( $undo );
934 $oldrev = Revision
::newFromId( $undoafter );
936 # Sanity check, make sure it's the right page,
937 # the revisions exist and they were not deleted.
938 # Otherwise, $content will be left as-is.
939 if ( !is_null( $undorev ) && !is_null( $oldrev ) &&
940 !$undorev->isDeleted( Revision
::DELETED_TEXT
) &&
941 !$oldrev->isDeleted( Revision
::DELETED_TEXT
) ) {
943 $content = $this->mArticle
->getUndoContent( $undorev, $oldrev );
945 if ( $content === false ) {
946 # Warn the user that something went wrong
947 $undoMsg = 'failure';
949 $oldContent = $this->mArticle
->getPage()->getContent( Revision
::RAW
);
950 $popts = ParserOptions
::newFromUserAndLang( $wgUser, $wgContLang );
951 $newContent = $content->preSaveTransform( $this->mTitle
, $wgUser, $popts );
953 if ( $newContent->equals( $oldContent ) ) {
954 # Tell the user that the undo results in no change,
955 # i.e. the revisions were already undone.
956 $undoMsg = 'nochange';
959 # Inform the user of our success and set an automatic edit summary
960 $undoMsg = 'success';
962 # If we just undid one rev, use an autosummary
963 $firstrev = $oldrev->getNext();
964 if ( $firstrev && $firstrev->getId() == $undo ) {
965 $userText = $undorev->getUserText();
966 if ( $userText === '' ) {
967 $undoSummary = wfMessage(
968 'undo-summary-username-hidden',
970 )->inContentLanguage()->text();
972 $undoSummary = wfMessage(
976 )->inContentLanguage()->text();
978 if ( $this->summary
=== '' ) {
979 $this->summary
= $undoSummary;
981 $this->summary
= $undoSummary . wfMessage( 'colon-separator' )
982 ->inContentLanguage()->text() . $this->summary
;
984 $this->undidRev
= $undo;
986 $this->formtype
= 'diff';
990 // Failed basic sanity checks.
991 // Older revisions may have been removed since the link
992 // was created, or we may simply have got bogus input.
996 // Messages: undo-success, undo-failure, undo-norev, undo-nochange
997 $class = ( $undoMsg == 'success' ?
'' : 'error ' ) . "mw-undo-{$undoMsg}";
998 $this->editFormPageTop
.= $wgOut->parse( "<div class=\"{$class}\">" .
999 wfMessage( 'undo-' . $undoMsg )->plain() . '</div>', true, /* interface */true );
1002 if ( $content === false ) {
1003 $content = $this->getOriginalContent();
1008 wfProfileOut( __METHOD__
);
1013 * Get the content of the wanted revision, without section extraction.
1015 * The result of this function can be used to compare user's input with
1016 * section replaced in its context (using WikiPage::replaceSection())
1017 * to the original text of the edit.
1019 * This differs from Article::getContent() that when a missing revision is
1020 * encountered the result will be null and not the
1021 * 'missing-revision' message.
1024 * @return Content|null
1026 private function getOriginalContent() {
1027 if ( $this->section
== 'new' ) {
1028 return $this->getCurrentContent();
1030 $revision = $this->mArticle
->getRevisionFetched();
1031 if ( $revision === null ) {
1032 if ( !$this->contentModel
) {
1033 $this->contentModel
= $this->getTitle()->getContentModel();
1035 $handler = ContentHandler
::getForModelID( $this->contentModel
);
1037 return $handler->makeEmptyContent();
1039 $content = $revision->getContent();
1044 * Get the current content of the page. This is basically similar to
1045 * WikiPage::getContent( Revision::RAW ) except that when the page doesn't exist an empty
1046 * content object is returned instead of null.
1051 protected function getCurrentContent() {
1052 $rev = $this->mArticle
->getRevision();
1053 $content = $rev ?
$rev->getContent( Revision
::RAW
) : null;
1055 if ( $content === false ||
$content === null ) {
1056 if ( !$this->contentModel
) {
1057 $this->contentModel
= $this->getTitle()->getContentModel();
1059 $handler = ContentHandler
::getForModelID( $this->contentModel
);
1061 return $handler->makeEmptyContent();
1063 # nasty side-effect, but needed for consistency
1064 $this->contentModel
= $rev->getContentModel();
1065 $this->contentFormat
= $rev->getContentFormat();
1072 * Use this method before edit() to preload some text into the edit box
1074 * @param $text string
1075 * @deprecated since 1.21, use setPreloadedContent() instead.
1077 public function setPreloadedText( $text ) {
1078 ContentHandler
::deprecated( __METHOD__
, "1.21" );
1080 $content = $this->toEditContent( $text );
1082 $this->setPreloadedContent( $content );
1086 * Use this method before edit() to preload some content into the edit box
1088 * @param $content Content
1092 public function setPreloadedContent( Content
$content ) {
1093 $this->mPreloadContent
= $content;
1097 * Get the contents to be preloaded into the box, either set by
1098 * an earlier setPreloadText() or by loading the given page.
1100 * @param string $preload representing the title to preload from.
1104 * @deprecated since 1.21, use getPreloadedContent() instead
1106 protected function getPreloadedText( $preload ) {
1107 ContentHandler
::deprecated( __METHOD__
, "1.21" );
1109 $content = $this->getPreloadedContent( $preload );
1110 $text = $this->toEditText( $content );
1116 * Get the contents to be preloaded into the box, either set by
1117 * an earlier setPreloadText() or by loading the given page.
1119 * @param string $preload representing the title to preload from.
1120 * @param Array $params Parameters to use (interface-message style) in the preloaded text
1126 protected function getPreloadedContent( $preload, $params = array() ) {
1129 if ( !empty( $this->mPreloadContent
) ) {
1130 return $this->mPreloadContent
;
1133 $handler = ContentHandler
::getForTitle( $this->getTitle() );
1135 if ( $preload === '' ) {
1136 return $handler->makeEmptyContent();
1139 $title = Title
::newFromText( $preload );
1140 # Check for existence to avoid getting MediaWiki:Noarticletext
1141 if ( $title === null ||
!$title->exists() ||
!$title->userCan( 'read', $wgUser ) ) {
1142 //TODO: somehow show a warning to the user!
1143 return $handler->makeEmptyContent();
1146 $page = WikiPage
::factory( $title );
1147 if ( $page->isRedirect() ) {
1148 $title = $page->getRedirectTarget();
1150 if ( $title === null ||
!$title->exists() ||
!$title->userCan( 'read', $wgUser ) ) {
1151 //TODO: somehow show a warning to the user!
1152 return $handler->makeEmptyContent();
1154 $page = WikiPage
::factory( $title );
1157 $parserOptions = ParserOptions
::newFromUser( $wgUser );
1158 $content = $page->getContent( Revision
::RAW
);
1161 //TODO: somehow show a warning to the user!
1162 return $handler->makeEmptyContent();
1165 if ( $content->getModel() !== $handler->getModelID() ) {
1166 $converted = $content->convert( $handler->getModelID() );
1168 if ( !$converted ) {
1169 //TODO: somehow show a warning to the user!
1170 wfDebug( "Attempt to preload incompatible content: "
1171 . "can't convert " . $content->getModel()
1172 . " to " . $handler->getModelID() );
1174 return $handler->makeEmptyContent();
1177 $content = $converted;
1180 return $content->preloadTransform( $title, $parserOptions, $params );
1184 * Make sure the form isn't faking a user's credentials.
1186 * @param $request WebRequest
1190 function tokenOk( &$request ) {
1192 $token = $request->getVal( 'wpEditToken' );
1193 $this->mTokenOk
= $wgUser->matchEditToken( $token );
1194 $this->mTokenOkExceptSuffix
= $wgUser->matchEditTokenNoSuffix( $token );
1195 return $this->mTokenOk
;
1199 * Sets post-edit cookie indicating the user just saved a particular revision.
1201 * This uses a temporary cookie for each revision ID so separate saves will never
1202 * interfere with each other.
1204 * The cookie is deleted in the mediawiki.action.view.postEdit JS module after
1205 * the redirect. It must be clearable by JavaScript code, so it must not be
1206 * marked HttpOnly. The JavaScript code converts the cookie to a wgPostEdit config
1209 * We use a path of '/' since wgCookiePath is not exposed to JS
1211 * If the variable were set on the server, it would be cached, which is unwanted
1212 * since the post-edit state should only apply to the load right after the save.
1214 protected function setPostEditCookie() {
1215 $revisionId = $this->mArticle
->getLatest();
1216 $postEditKey = self
::POST_EDIT_COOKIE_KEY_PREFIX
. $revisionId;
1218 $response = RequestContext
::getMain()->getRequest()->response();
1219 $response->setcookie( $postEditKey, '1', time() + self
::POST_EDIT_COOKIE_DURATION
, array(
1221 'httpOnly' => false,
1226 * Attempt submission
1227 * @throws UserBlockedError|ReadOnlyError|ThrottledError|PermissionsError
1228 * @return bool false if output is done, true if the rest of the form should be displayed
1230 public function attemptSave() {
1233 $resultDetails = false;
1234 # Allow bots to exempt some edits from bot flagging
1235 $bot = $wgUser->isAllowed( 'bot' ) && $this->bot
;
1236 $status = $this->internalAttemptSave( $resultDetails, $bot );
1238 return $this->handleStatus( $status, $resultDetails );
1242 * Handle status, such as after attempt save
1244 * @param Status $status
1245 * @param array|bool $resultDetails
1247 * @throws ErrorPageError
1248 * return bool false, if output is done, true if rest of the form should be displayed
1250 private function handleStatus( Status
$status, $resultDetails ) {
1251 global $wgUser, $wgOut;
1253 // FIXME: once the interface for internalAttemptSave() is made nicer, this should use the message in $status
1254 if ( $status->value
== self
::AS_SUCCESS_UPDATE ||
$status->value
== self
::AS_SUCCESS_NEW_ARTICLE
) {
1255 $this->didSave
= true;
1256 if ( !$resultDetails['nullEdit'] ) {
1257 $this->setPostEditCookie();
1261 switch ( $status->value
) {
1262 case self
::AS_HOOK_ERROR_EXPECTED
:
1263 case self
::AS_CONTENT_TOO_BIG
:
1264 case self
::AS_ARTICLE_WAS_DELETED
:
1265 case self
::AS_CONFLICT_DETECTED
:
1266 case self
::AS_SUMMARY_NEEDED
:
1267 case self
::AS_TEXTBOX_EMPTY
:
1268 case self
::AS_MAX_ARTICLE_SIZE_EXCEEDED
:
1272 case self
::AS_HOOK_ERROR
:
1275 case self
::AS_PARSE_ERROR
:
1276 $wgOut->addWikiText( '<div class="error">' . $status->getWikiText() . '</div>' );
1279 case self
::AS_SUCCESS_NEW_ARTICLE
:
1280 $query = $resultDetails['redirect'] ?
'redirect=no' : '';
1281 $anchor = isset( $resultDetails['sectionanchor'] ) ?
$resultDetails['sectionanchor'] : '';
1282 $wgOut->redirect( $this->mTitle
->getFullURL( $query ) . $anchor );
1285 case self
::AS_SUCCESS_UPDATE
:
1287 $sectionanchor = $resultDetails['sectionanchor'];
1289 // Give extensions a chance to modify URL query on update
1290 wfRunHooks( 'ArticleUpdateBeforeRedirect', array( $this->mArticle
, &$sectionanchor, &$extraQuery ) );
1292 if ( $resultDetails['redirect'] ) {
1293 if ( $extraQuery == '' ) {
1294 $extraQuery = 'redirect=no';
1296 $extraQuery = 'redirect=no&' . $extraQuery;
1299 $wgOut->redirect( $this->mTitle
->getFullURL( $extraQuery ) . $sectionanchor );
1302 case self
::AS_BLANK_ARTICLE
:
1303 $wgOut->redirect( $this->getContextTitle()->getFullURL() );
1306 case self
::AS_SPAM_ERROR
:
1307 $this->spamPageWithContent( $resultDetails['spam'] );
1310 case self
::AS_BLOCKED_PAGE_FOR_USER
:
1311 throw new UserBlockedError( $wgUser->getBlock() );
1313 case self
::AS_IMAGE_REDIRECT_ANON
:
1314 case self
::AS_IMAGE_REDIRECT_LOGGED
:
1315 throw new PermissionsError( 'upload' );
1317 case self
::AS_READ_ONLY_PAGE_ANON
:
1318 case self
::AS_READ_ONLY_PAGE_LOGGED
:
1319 throw new PermissionsError( 'edit' );
1321 case self
::AS_READ_ONLY_PAGE
:
1322 throw new ReadOnlyError
;
1324 case self
::AS_RATE_LIMITED
:
1325 throw new ThrottledError();
1327 case self
::AS_NO_CREATE_PERMISSION
:
1328 $permission = $this->mTitle
->isTalkPage() ?
'createtalk' : 'createpage';
1329 throw new PermissionsError( $permission );
1332 // We don't recognize $status->value. The only way that can happen
1333 // is if an extension hook aborted from inside ArticleSave.
1334 // Render the status object into $this->hookError
1335 // FIXME this sucks, we should just use the Status object throughout
1336 $this->hookError
= '<div class="error">' . $status->getWikitext() .
1343 * Run hooks that can filter edits just before they get saved.
1345 * @param Content $content the Content to filter.
1346 * @param Status $status for reporting the outcome to the caller
1347 * @param User $user the user performing the edit
1351 protected function runPostMergeFilters( Content
$content, Status
$status, User
$user ) {
1352 // Run old style post-section-merge edit filter
1353 if ( !ContentHandler
::runLegacyHooks( 'EditFilterMerged',
1354 array( $this, $content, &$this->hookError
, $this->summary
) ) ) {
1356 # Error messages etc. could be handled within the hook...
1357 $status->fatal( 'hookaborted' );
1358 $status->value
= self
::AS_HOOK_ERROR
;
1360 } elseif ( $this->hookError
!= '' ) {
1361 # ...or the hook could be expecting us to produce an error
1362 $status->fatal( 'hookaborted' );
1363 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1367 // Run new style post-section-merge edit filter
1368 if ( !wfRunHooks( 'EditFilterMergedContent',
1369 array( $this->mArticle
->getContext(), $content, $status, $this->summary
,
1370 $user, $this->minoredit
) ) ) {
1372 # Error messages etc. could be handled within the hook...
1373 // XXX: $status->value may already be something informative...
1374 $this->hookError
= $status->getWikiText();
1375 $status->fatal( 'hookaborted' );
1376 $status->value
= self
::AS_HOOK_ERROR
;
1378 } elseif ( !$status->isOK() ) {
1379 # ...or the hook could be expecting us to produce an error
1380 // FIXME this sucks, we should just use the Status object throughout
1381 $this->hookError
= $status->getWikiText();
1382 $status->fatal( 'hookaborted' );
1383 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1391 * Attempt submission (no UI)
1393 * @param array $result array to add statuses to, currently with the possible keys:
1394 * spam - string - Spam string from content if any spam is detected by matchSpamRegex
1395 * sectionanchor - string - Section anchor for a section save
1396 * nullEdit - boolean - Set if doEditContent is OK. True if null edit, false otherwise.
1397 * redirect - boolean - Set if doEditContent is OK. True if resulting revision is a redirect
1398 * @param bool $bot True if edit is being made under the bot right.
1400 * @return Status object, possibly with a message, but always with one of the AS_* constants in $status->value,
1402 * FIXME: This interface is TERRIBLE, but hard to get rid of due to various error display idiosyncrasies. There are
1403 * also lots of cases where error metadata is set in the object and retrieved later instead of being returned, e.g.
1404 * AS_CONTENT_TOO_BIG and AS_BLOCKED_PAGE_FOR_USER. All that stuff needs to be cleaned up some time.
1406 function internalAttemptSave( &$result, $bot = false ) {
1407 global $wgUser, $wgRequest, $wgParser, $wgMaxArticleSize;
1409 $status = Status
::newGood();
1411 wfProfileIn( __METHOD__
);
1412 wfProfileIn( __METHOD__
. '-checks' );
1414 if ( !wfRunHooks( 'EditPage::attemptSave', array( $this ) ) ) {
1415 wfDebug( "Hook 'EditPage::attemptSave' aborted article saving\n" );
1416 $status->fatal( 'hookaborted' );
1417 $status->value
= self
::AS_HOOK_ERROR
;
1418 wfProfileOut( __METHOD__
. '-checks' );
1419 wfProfileOut( __METHOD__
);
1423 $spam = $wgRequest->getText( 'wpAntispam' );
1424 if ( $spam !== '' ) {
1427 $wgUser->getName() .
1429 $this->mTitle
->getPrefixedText() .
1430 '" submitted bogus field "' .
1434 $status->fatal( 'spamprotectionmatch', false );
1435 $status->value
= self
::AS_SPAM_ERROR
;
1436 wfProfileOut( __METHOD__
. '-checks' );
1437 wfProfileOut( __METHOD__
);
1442 # Construct Content object
1443 $textbox_content = $this->toEditContent( $this->textbox1
);
1444 } catch ( MWContentSerializationException
$ex ) {
1445 $status->fatal( 'content-failed-to-parse', $this->contentModel
, $this->contentFormat
, $ex->getMessage() );
1446 $status->value
= self
::AS_PARSE_ERROR
;
1447 wfProfileOut( __METHOD__
. '-checks' );
1448 wfProfileOut( __METHOD__
);
1452 # Check image redirect
1453 if ( $this->mTitle
->getNamespace() == NS_FILE
&&
1454 $textbox_content->isRedirect() &&
1455 !$wgUser->isAllowed( 'upload' ) ) {
1456 $code = $wgUser->isAnon() ? self
::AS_IMAGE_REDIRECT_ANON
: self
::AS_IMAGE_REDIRECT_LOGGED
;
1457 $status->setResult( false, $code );
1459 wfProfileOut( __METHOD__
. '-checks' );
1460 wfProfileOut( __METHOD__
);
1466 $match = self
::matchSummarySpamRegex( $this->summary
);
1467 if ( $match === false && $this->section
== 'new' ) {
1468 # $wgSpamRegex is enforced on this new heading/summary because, unlike
1469 # regular summaries, it is added to the actual wikitext.
1470 if ( $this->sectiontitle
!== '' ) {
1471 # This branch is taken when the API is used with the 'sectiontitle' parameter.
1472 $match = self
::matchSpamRegex( $this->sectiontitle
);
1474 # This branch is taken when the "Add Topic" user interface is used, or the API
1475 # is used with the 'summary' parameter.
1476 $match = self
::matchSpamRegex( $this->summary
);
1479 if ( $match === false ) {
1480 $match = self
::matchSpamRegex( $this->textbox1
);
1482 if ( $match !== false ) {
1483 $result['spam'] = $match;
1484 $ip = $wgRequest->getIP();
1485 $pdbk = $this->mTitle
->getPrefixedDBkey();
1486 $match = str_replace( "\n", '', $match );
1487 wfDebugLog( 'SpamRegex', "$ip spam regex hit [[$pdbk]]: \"$match\"" );
1488 $status->fatal( 'spamprotectionmatch', $match );
1489 $status->value
= self
::AS_SPAM_ERROR
;
1490 wfProfileOut( __METHOD__
. '-checks' );
1491 wfProfileOut( __METHOD__
);
1494 if ( !wfRunHooks( 'EditFilter', array( $this, $this->textbox1
, $this->section
, &$this->hookError
, $this->summary
) ) ) {
1495 # Error messages etc. could be handled within the hook...
1496 $status->fatal( 'hookaborted' );
1497 $status->value
= self
::AS_HOOK_ERROR
;
1498 wfProfileOut( __METHOD__
. '-checks' );
1499 wfProfileOut( __METHOD__
);
1501 } elseif ( $this->hookError
!= '' ) {
1502 # ...or the hook could be expecting us to produce an error
1503 $status->fatal( 'hookaborted' );
1504 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1505 wfProfileOut( __METHOD__
. '-checks' );
1506 wfProfileOut( __METHOD__
);
1510 if ( $wgUser->isBlockedFrom( $this->mTitle
, false ) ) {
1511 // Auto-block user's IP if the account was "hard" blocked
1512 $wgUser->spreadAnyEditBlock();
1513 # Check block state against master, thus 'false'.
1514 $status->setResult( false, self
::AS_BLOCKED_PAGE_FOR_USER
);
1515 wfProfileOut( __METHOD__
. '-checks' );
1516 wfProfileOut( __METHOD__
);
1520 $this->kblength
= (int)( strlen( $this->textbox1
) / 1024 );
1521 if ( $this->kblength
> $wgMaxArticleSize ) {
1522 // Error will be displayed by showEditForm()
1523 $this->tooBig
= true;
1524 $status->setResult( false, self
::AS_CONTENT_TOO_BIG
);
1525 wfProfileOut( __METHOD__
. '-checks' );
1526 wfProfileOut( __METHOD__
);
1530 if ( !$wgUser->isAllowed( 'edit' ) ) {
1531 if ( $wgUser->isAnon() ) {
1532 $status->setResult( false, self
::AS_READ_ONLY_PAGE_ANON
);
1533 wfProfileOut( __METHOD__
. '-checks' );
1534 wfProfileOut( __METHOD__
);
1537 $status->fatal( 'readonlytext' );
1538 $status->value
= self
::AS_READ_ONLY_PAGE_LOGGED
;
1539 wfProfileOut( __METHOD__
. '-checks' );
1540 wfProfileOut( __METHOD__
);
1545 if ( wfReadOnly() ) {
1546 $status->fatal( 'readonlytext' );
1547 $status->value
= self
::AS_READ_ONLY_PAGE
;
1548 wfProfileOut( __METHOD__
. '-checks' );
1549 wfProfileOut( __METHOD__
);
1552 if ( $wgUser->pingLimiter() ||
$wgUser->pingLimiter( 'linkpurge', 0 ) ) {
1553 $status->fatal( 'actionthrottledtext' );
1554 $status->value
= self
::AS_RATE_LIMITED
;
1555 wfProfileOut( __METHOD__
. '-checks' );
1556 wfProfileOut( __METHOD__
);
1560 # If the article has been deleted while editing, don't save it without
1562 if ( $this->wasDeletedSinceLastEdit() && !$this->recreate
) {
1563 $status->setResult( false, self
::AS_ARTICLE_WAS_DELETED
);
1564 wfProfileOut( __METHOD__
. '-checks' );
1565 wfProfileOut( __METHOD__
);
1569 wfProfileOut( __METHOD__
. '-checks' );
1571 # Load the page data from the master. If anything changes in the meantime,
1572 # we detect it by using page_latest like a token in a 1 try compare-and-swap.
1573 $this->mArticle
->loadPageData( 'fromdbmaster' );
1574 $new = !$this->mArticle
->exists();
1577 // Late check for create permission, just in case *PARANOIA*
1578 if ( !$this->mTitle
->userCan( 'create', $wgUser ) ) {
1579 $status->fatal( 'nocreatetext' );
1580 $status->value
= self
::AS_NO_CREATE_PERMISSION
;
1581 wfDebug( __METHOD__
. ": no create permission\n" );
1582 wfProfileOut( __METHOD__
);
1586 // Don't save a new page if it's blank or if it's a MediaWiki:
1587 // message with content equivalent to default (allow empty pages
1588 // in this case to disable messages, see bug 50124)
1589 $defaultMessageText = $this->mTitle
->getDefaultMessageText();
1590 if ( $this->mTitle
->getNamespace() === NS_MEDIAWIKI
&& $defaultMessageText !== false ) {
1591 $defaultText = $defaultMessageText;
1596 if ( $this->textbox1
=== $defaultText ) {
1597 $status->setResult( false, self
::AS_BLANK_ARTICLE
);
1598 wfProfileOut( __METHOD__
);
1602 if ( !$this->runPostMergeFilters( $textbox_content, $status, $wgUser ) ) {
1603 wfProfileOut( __METHOD__
);
1607 $content = $textbox_content;
1609 $result['sectionanchor'] = '';
1610 if ( $this->section
== 'new' ) {
1611 if ( $this->sectiontitle
!== '' ) {
1612 // Insert the section title above the content.
1613 $content = $content->addSectionHeader( $this->sectiontitle
);
1615 // Jump to the new section
1616 $result['sectionanchor'] = $wgParser->guessLegacySectionNameFromWikiText( $this->sectiontitle
);
1618 // If no edit summary was specified, create one automatically from the section
1619 // title and have it link to the new section. Otherwise, respect the summary as
1621 if ( $this->summary
=== '' ) {
1622 $cleanSectionTitle = $wgParser->stripSectionName( $this->sectiontitle
);
1623 $this->summary
= wfMessage( 'newsectionsummary' )
1624 ->rawParams( $cleanSectionTitle )->inContentLanguage()->text();
1626 } elseif ( $this->summary
!== '' ) {
1627 // Insert the section title above the content.
1628 $content = $content->addSectionHeader( $this->summary
);
1630 // Jump to the new section
1631 $result['sectionanchor'] = $wgParser->guessLegacySectionNameFromWikiText( $this->summary
);
1633 // Create a link to the new section from the edit summary.
1634 $cleanSummary = $wgParser->stripSectionName( $this->summary
);
1635 $this->summary
= wfMessage( 'newsectionsummary' )
1636 ->rawParams( $cleanSummary )->inContentLanguage()->text();
1640 $status->value
= self
::AS_SUCCESS_NEW_ARTICLE
;
1644 # Article exists. Check for edit conflict.
1646 $this->mArticle
->clear(); # Force reload of dates, etc.
1647 $timestamp = $this->mArticle
->getTimestamp();
1649 wfDebug( "timestamp: {$timestamp}, edittime: {$this->edittime}\n" );
1651 if ( $timestamp != $this->edittime
) {
1652 $this->isConflict
= true;
1653 if ( $this->section
== 'new' ) {
1654 if ( $this->mArticle
->getUserText() == $wgUser->getName() &&
1655 $this->mArticle
->getComment() == $this->summary
) {
1656 // Probably a duplicate submission of a new comment.
1657 // This can happen when squid resends a request after
1658 // a timeout but the first one actually went through.
1659 wfDebug( __METHOD__
. ": duplicate new section submission; trigger edit conflict!\n" );
1661 // New comment; suppress conflict.
1662 $this->isConflict
= false;
1663 wfDebug( __METHOD__
. ": conflict suppressed; new section\n" );
1665 } elseif ( $this->section
== '' && Revision
::userWasLastToEdit( DB_MASTER
, $this->mTitle
->getArticleID(),
1666 $wgUser->getId(), $this->edittime
) ) {
1667 # Suppress edit conflict with self, except for section edits where merging is required.
1668 wfDebug( __METHOD__
. ": Suppressing edit conflict, same user.\n" );
1669 $this->isConflict
= false;
1673 // If sectiontitle is set, use it, otherwise use the summary as the section title.
1674 if ( $this->sectiontitle
!== '' ) {
1675 $sectionTitle = $this->sectiontitle
;
1677 $sectionTitle = $this->summary
;
1682 if ( $this->isConflict
) {
1683 wfDebug( __METHOD__
. ": conflict! getting section '{$this->section}' for time '{$this->edittime}'"
1684 . " (article time '{$timestamp}')\n" );
1686 $content = $this->mArticle
->replaceSectionContent( $this->section
, $textbox_content, $sectionTitle, $this->edittime
);
1688 wfDebug( __METHOD__
. ": getting section '{$this->section}'\n" );
1689 $content = $this->mArticle
->replaceSectionContent( $this->section
, $textbox_content, $sectionTitle );
1692 if ( is_null( $content ) ) {
1693 wfDebug( __METHOD__
. ": activating conflict; section replace failed.\n" );
1694 $this->isConflict
= true;
1695 $content = $textbox_content; // do not try to merge here!
1696 } elseif ( $this->isConflict
) {
1698 if ( $this->mergeChangesIntoContent( $content ) ) {
1699 // Successful merge! Maybe we should tell the user the good news?
1700 $this->isConflict
= false;
1701 wfDebug( __METHOD__
. ": Suppressing edit conflict, successful merge.\n" );
1703 $this->section
= '';
1704 $this->textbox1
= ContentHandler
::getContentText( $content );
1705 wfDebug( __METHOD__
. ": Keeping edit conflict, failed merge.\n" );
1709 if ( $this->isConflict
) {
1710 $status->setResult( false, self
::AS_CONFLICT_DETECTED
);
1711 wfProfileOut( __METHOD__
);
1715 if ( !$this->runPostMergeFilters( $content, $status, $wgUser ) ) {
1716 wfProfileOut( __METHOD__
);
1720 if ( $this->section
== 'new' ) {
1721 // Handle the user preference to force summaries here
1722 if ( !$this->allowBlankSummary
&& trim( $this->summary
) == '' ) {
1723 $this->missingSummary
= true;
1724 $status->fatal( 'missingsummary' ); // or 'missingcommentheader' if $section == 'new'. Blegh
1725 $status->value
= self
::AS_SUMMARY_NEEDED
;
1726 wfProfileOut( __METHOD__
);
1730 // Do not allow the user to post an empty comment
1731 if ( $this->textbox1
== '' ) {
1732 $this->missingComment
= true;
1733 $status->fatal( 'missingcommenttext' );
1734 $status->value
= self
::AS_TEXTBOX_EMPTY
;
1735 wfProfileOut( __METHOD__
);
1738 } elseif ( !$this->allowBlankSummary
1739 && !$content->equals( $this->getOriginalContent() )
1740 && !$content->isRedirect()
1741 && md5( $this->summary
) == $this->autoSumm
1743 $this->missingSummary
= true;
1744 $status->fatal( 'missingsummary' );
1745 $status->value
= self
::AS_SUMMARY_NEEDED
;
1746 wfProfileOut( __METHOD__
);
1751 wfProfileIn( __METHOD__
. '-sectionanchor' );
1752 $sectionanchor = '';
1753 if ( $this->section
== 'new' ) {
1754 if ( $this->sectiontitle
!== '' ) {
1755 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $this->sectiontitle
);
1756 // If no edit summary was specified, create one automatically from the section
1757 // title and have it link to the new section. Otherwise, respect the summary as
1759 if ( $this->summary
=== '' ) {
1760 $cleanSectionTitle = $wgParser->stripSectionName( $this->sectiontitle
);
1761 $this->summary
= wfMessage( 'newsectionsummary' )
1762 ->rawParams( $cleanSectionTitle )->inContentLanguage()->text();
1764 } elseif ( $this->summary
!== '' ) {
1765 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $this->summary
);
1766 # This is a new section, so create a link to the new section
1767 # in the revision summary.
1768 $cleanSummary = $wgParser->stripSectionName( $this->summary
);
1769 $this->summary
= wfMessage( 'newsectionsummary' )
1770 ->rawParams( $cleanSummary )->inContentLanguage()->text();
1772 } elseif ( $this->section
!= '' ) {
1773 # Try to get a section anchor from the section source, redirect to edited section if header found
1774 # XXX: might be better to integrate this into Article::replaceSection
1775 # for duplicate heading checking and maybe parsing
1776 $hasmatch = preg_match( "/^ *([=]{1,6})(.*?)(\\1) *\\n/i", $this->textbox1
, $matches );
1777 # we can't deal with anchors, includes, html etc in the header for now,
1778 # headline would need to be parsed to improve this
1779 if ( $hasmatch && strlen( $matches[2] ) > 0 ) {
1780 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $matches[2] );
1783 $result['sectionanchor'] = $sectionanchor;
1784 wfProfileOut( __METHOD__
. '-sectionanchor' );
1786 // Save errors may fall down to the edit form, but we've now
1787 // merged the section into full text. Clear the section field
1788 // so that later submission of conflict forms won't try to
1789 // replace that into a duplicated mess.
1790 $this->textbox1
= $this->toEditText( $content );
1791 $this->section
= '';
1793 $status->value
= self
::AS_SUCCESS_UPDATE
;
1796 // Check for length errors again now that the section is merged in
1797 $this->kblength
= (int)( strlen( $this->toEditText( $content ) ) / 1024 );
1798 if ( $this->kblength
> $wgMaxArticleSize ) {
1799 $this->tooBig
= true;
1800 $status->setResult( false, self
::AS_MAX_ARTICLE_SIZE_EXCEEDED
);
1801 wfProfileOut( __METHOD__
);
1805 $flags = EDIT_DEFER_UPDATES | EDIT_AUTOSUMMARY |
1806 ( $new ? EDIT_NEW
: EDIT_UPDATE
) |
1807 ( ( $this->minoredit
&& !$this->isNew
) ? EDIT_MINOR
: 0 ) |
1808 ( $bot ? EDIT_FORCE_BOT
: 0 );
1810 $doEditStatus = $this->mArticle
->doEditContent( $content, $this->summary
, $flags,
1811 false, null, $this->contentFormat
);
1813 if ( !$doEditStatus->isOK() ) {
1814 // Failure from doEdit()
1815 // Show the edit conflict page for certain recognized errors from doEdit(),
1816 // but don't show it for errors from extension hooks
1817 $errors = $doEditStatus->getErrorsArray();
1818 if ( in_array( $errors[0][0],
1819 array( 'edit-gone-missing', 'edit-conflict', 'edit-already-exists' ) )
1821 $this->isConflict
= true;
1822 // Destroys data doEdit() put in $status->value but who cares
1823 $doEditStatus->value
= self
::AS_END
;
1825 wfProfileOut( __METHOD__
);
1826 return $doEditStatus;
1829 $result['nullEdit'] = $doEditStatus->hasMessage( 'edit-no-change' );
1830 if ( $result['nullEdit'] ) {
1831 // We don't know if it was a null edit until now, so increment here
1832 $wgUser->pingLimiter( 'linkpurge' );
1834 $result['redirect'] = $content->isRedirect();
1835 $this->updateWatchlist();
1836 wfProfileOut( __METHOD__
);
1841 * Register the change of watch status
1843 protected function updateWatchlist() {
1846 if ( $wgUser->isLoggedIn()
1847 && $this->watchthis
!= $wgUser->isWatched( $this->mTitle
, WatchedItem
::IGNORE_USER_RIGHTS
)
1849 $fname = __METHOD__
;
1850 $title = $this->mTitle
;
1851 $watch = $this->watchthis
;
1853 // Do this in its own transaction to reduce contention...
1854 $dbw = wfGetDB( DB_MASTER
);
1855 $dbw->onTransactionIdle( function() use ( $dbw, $title, $watch, $wgUser, $fname ) {
1856 $dbw->begin( $fname );
1857 WatchAction
::doWatchOrUnwatch( $watch, $title, $wgUser );
1858 $dbw->commit( $fname );
1864 * Attempts to merge text content with base and current revisions
1866 * @param $editText string
1869 * @deprecated since 1.21, use mergeChangesIntoContent() instead
1871 function mergeChangesInto( &$editText ) {
1872 ContentHandler
::deprecated( __METHOD__
, "1.21" );
1874 $editContent = $this->toEditContent( $editText );
1876 $ok = $this->mergeChangesIntoContent( $editContent );
1879 $editText = $this->toEditText( $editContent );
1886 * Attempts to do 3-way merge of edit content with a base revision
1887 * and current content, in case of edit conflict, in whichever way appropriate
1888 * for the content type.
1892 * @param $editContent
1896 private function mergeChangesIntoContent( &$editContent ) {
1897 wfProfileIn( __METHOD__
);
1899 $db = wfGetDB( DB_MASTER
);
1901 // This is the revision the editor started from
1902 $baseRevision = $this->getBaseRevision();
1903 $baseContent = $baseRevision ?
$baseRevision->getContent() : null;
1905 if ( is_null( $baseContent ) ) {
1906 wfProfileOut( __METHOD__
);
1910 // The current state, we want to merge updates into it
1911 $currentRevision = Revision
::loadFromTitle( $db, $this->mTitle
);
1912 $currentContent = $currentRevision ?
$currentRevision->getContent() : null;
1914 if ( is_null( $currentContent ) ) {
1915 wfProfileOut( __METHOD__
);
1919 $handler = ContentHandler
::getForModelID( $baseContent->getModel() );
1921 $result = $handler->merge3( $baseContent, $editContent, $currentContent );
1924 $editContent = $result;
1925 wfProfileOut( __METHOD__
);
1929 wfProfileOut( __METHOD__
);
1936 function getBaseRevision() {
1937 if ( !$this->mBaseRevision
) {
1938 $db = wfGetDB( DB_MASTER
);
1939 $this->mBaseRevision
= Revision
::loadFromTimestamp(
1940 $db, $this->mTitle
, $this->edittime
);
1942 return $this->mBaseRevision
;
1946 * Check given input text against $wgSpamRegex, and return the text of the first match.
1948 * @param $text string
1950 * @return string|bool matching string or false
1952 public static function matchSpamRegex( $text ) {
1953 global $wgSpamRegex;
1954 // For back compatibility, $wgSpamRegex may be a single string or an array of regexes.
1955 $regexes = (array)$wgSpamRegex;
1956 return self
::matchSpamRegexInternal( $text, $regexes );
1960 * Check given input text against $wgSummarySpamRegex, and return the text of the first match.
1962 * @param $text string
1964 * @return string|bool matching string or false
1966 public static function matchSummarySpamRegex( $text ) {
1967 global $wgSummarySpamRegex;
1968 $regexes = (array)$wgSummarySpamRegex;
1969 return self
::matchSpamRegexInternal( $text, $regexes );
1973 * @param $text string
1974 * @param $regexes array
1975 * @return bool|string
1977 protected static function matchSpamRegexInternal( $text, $regexes ) {
1978 foreach ( $regexes as $regex ) {
1980 if ( preg_match( $regex, $text, $matches ) ) {
1987 function setHeaders() {
1988 global $wgOut, $wgUser;
1990 $wgOut->addModules( 'mediawiki.action.edit' );
1991 $wgOut->addModuleStyles( 'mediawiki.action.edit.styles' );
1993 if ( $wgUser->getOption( 'uselivepreview', false ) ) {
1994 $wgOut->addModules( 'mediawiki.action.edit.preview' );
1997 if ( $wgUser->getOption( 'useeditwarning', false ) ) {
1998 $wgOut->addModules( 'mediawiki.action.edit.editWarning' );
2001 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2003 # Enabled article-related sidebar, toplinks, etc.
2004 $wgOut->setArticleRelated( true );
2006 $contextTitle = $this->getContextTitle();
2007 if ( $this->isConflict
) {
2008 $msg = 'editconflict';
2009 } elseif ( $contextTitle->exists() && $this->section
!= '' ) {
2010 $msg = $this->section
== 'new' ?
'editingcomment' : 'editingsection';
2012 $msg = $contextTitle->exists() ||
( $contextTitle->getNamespace() == NS_MEDIAWIKI
&& $contextTitle->getDefaultMessageText() !== false ) ?
2013 'editing' : 'creating';
2015 # Use the title defined by DISPLAYTITLE magic word when present
2016 $displayTitle = isset( $this->mParserOutput
) ?
$this->mParserOutput
->getDisplayTitle() : false;
2017 if ( $displayTitle === false ) {
2018 $displayTitle = $contextTitle->getPrefixedText();
2020 $wgOut->setPageTitle( wfMessage( $msg, $displayTitle ) );
2024 * Show all applicable editing introductions
2026 protected function showIntro() {
2027 global $wgOut, $wgUser;
2028 if ( $this->suppressIntro
) {
2032 $namespace = $this->mTitle
->getNamespace();
2034 if ( $namespace == NS_MEDIAWIKI
) {
2035 # Show a warning if editing an interface message
2036 $wgOut->wrapWikiMsg( "<div class='mw-editinginterface'>\n$1\n</div>", 'editinginterface' );
2037 } elseif ( $namespace == NS_FILE
) {
2038 # Show a hint to shared repo
2039 $file = wfFindFile( $this->mTitle
);
2040 if ( $file && !$file->isLocal() ) {
2041 $descUrl = $file->getDescriptionUrl();
2042 # there must be a description url to show a hint to shared repo
2044 if ( !$this->mTitle
->exists() ) {
2045 $wgOut->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-create\">\n$1\n</div>", array(
2046 'sharedupload-desc-create', $file->getRepo()->getDisplayName(), $descUrl
2049 $wgOut->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-edit\">\n$1\n</div>", array(
2050 'sharedupload-desc-edit', $file->getRepo()->getDisplayName(), $descUrl
2057 # Show a warning message when someone creates/edits a user (talk) page but the user does not exist
2058 # Show log extract when the user is currently blocked
2059 if ( $namespace == NS_USER ||
$namespace == NS_USER_TALK
) {
2060 $parts = explode( '/', $this->mTitle
->getText(), 2 );
2061 $username = $parts[0];
2062 $user = User
::newFromName( $username, false /* allow IP users*/ );
2063 $ip = User
::isIP( $username );
2064 if ( !( $user && $user->isLoggedIn() ) && !$ip ) { # User does not exist
2065 $wgOut->wrapWikiMsg( "<div class=\"mw-userpage-userdoesnotexist error\">\n$1\n</div>",
2066 array( 'userpage-userdoesnotexist', wfEscapeWikiText( $username ) ) );
2067 } elseif ( $user->isBlocked() ) { # Show log extract if the user is currently blocked
2068 LogEventsList
::showLogExtract(
2071 $user->getUserPage(),
2075 'showIfEmpty' => false,
2077 'blocked-notice-logextract',
2078 $user->getName() # Support GENDER in notice
2084 # Try to add a custom edit intro, or use the standard one if this is not possible.
2085 if ( !$this->showCustomIntro() && !$this->mTitle
->exists() ) {
2086 $helpLink = wfExpandUrl( Skin
::makeInternalOrExternalUrl(
2087 wfMessage( 'helppage' )->inContentLanguage()->text()
2089 if ( $wgUser->isLoggedIn() ) {
2090 $wgOut->wrapWikiMsg(
2091 // Suppress the external link icon, consider the help url an internal one
2092 "<div class=\"mw-newarticletext plainlinks\">\n$1\n</div>",
2099 $wgOut->wrapWikiMsg(
2100 // Suppress the external link icon, consider the help url an internal one
2101 "<div class=\"mw-newarticletextanon plainlinks\">\n$1\n</div>",
2103 'newarticletextanon',
2109 # Give a notice if the user is editing a deleted/moved page...
2110 if ( !$this->mTitle
->exists() ) {
2111 LogEventsList
::showLogExtract( $wgOut, array( 'delete', 'move' ), $this->mTitle
,
2115 'conds' => array( "log_action != 'revision'" ),
2116 'showIfEmpty' => false,
2117 'msgKey' => array( 'recreate-moveddeleted-warn' )
2124 * Attempt to show a custom editing introduction, if supplied
2128 protected function showCustomIntro() {
2129 if ( $this->editintro
) {
2130 $title = Title
::newFromText( $this->editintro
);
2131 if ( $title instanceof Title
&& $title->exists() && $title->userCan( 'read' ) ) {
2133 // Added using template syntax, to take <noinclude>'s into account.
2134 $wgOut->addWikiTextTitleTidy( '{{:' . $title->getFullText() . '}}', $this->mTitle
);
2142 * Gets an editable textual representation of $content.
2143 * The textual representation can be turned by into a Content object by the
2144 * toEditContent() method.
2146 * If $content is null or false or a string, $content is returned unchanged.
2148 * If the given Content object is not of a type that can be edited using the text base EditPage,
2149 * an exception will be raised. Set $this->allowNonTextContent to true to allow editing of non-textual
2152 * @param Content|null|bool|string $content
2153 * @return String the editable text form of the content.
2155 * @throws MWException if $content is not an instance of TextContent and $this->allowNonTextContent is not true.
2157 protected function toEditText( $content ) {
2158 if ( $content === null ||
$content === false ) {
2162 if ( is_string( $content ) ) {
2166 if ( !$this->isSupportedContentModel( $content->getModel() ) ) {
2167 throw new MWException( 'This content model is not supported: '
2168 . ContentHandler
::getLocalizedName( $content->getModel() ) );
2171 return $content->serialize( $this->contentFormat
);
2175 * Turns the given text into a Content object by unserializing it.
2177 * If the resulting Content object is not of a type that can be edited using the text base EditPage,
2178 * an exception will be raised. Set $this->allowNonTextContent to true to allow editing of non-textual
2181 * @param string|null|bool $text Text to unserialize
2182 * @return Content The content object created from $text. If $text was false or null, false resp. null will be
2185 * @throws MWException if unserializing the text results in a Content object that is not an instance of TextContent
2186 * and $this->allowNonTextContent is not true.
2188 protected function toEditContent( $text ) {
2189 if ( $text === false ||
$text === null ) {
2193 $content = ContentHandler
::makeContent( $text, $this->getTitle(),
2194 $this->contentModel
, $this->contentFormat
);
2196 if ( !$this->isSupportedContentModel( $content->getModel() ) ) {
2197 throw new MWException( 'This content model is not supported: '
2198 . ContentHandler
::getLocalizedName( $content->getModel() ) );
2205 * Send the edit form and related headers to $wgOut
2206 * @param $formCallback Callback|null that takes an OutputPage parameter; will be called
2207 * during form output near the top, for captchas and the like.
2209 function showEditForm( $formCallback = null ) {
2210 global $wgOut, $wgUser;
2212 wfProfileIn( __METHOD__
);
2214 # need to parse the preview early so that we know which templates are used,
2215 # otherwise users with "show preview after edit box" will get a blank list
2216 # we parse this near the beginning so that setHeaders can do the title
2217 # setting work instead of leaving it in getPreviewText
2218 $previewOutput = '';
2219 if ( $this->formtype
== 'preview' ) {
2220 $previewOutput = $this->getPreviewText();
2223 wfRunHooks( 'EditPage::showEditForm:initial', array( &$this, &$wgOut ) );
2225 $this->setHeaders();
2227 if ( $this->showHeader() === false ) {
2228 wfProfileOut( __METHOD__
);
2232 $wgOut->addHTML( $this->editFormPageTop
);
2234 if ( $wgUser->getOption( 'previewontop' ) ) {
2235 $this->displayPreviewArea( $previewOutput, true );
2238 $wgOut->addHTML( $this->editFormTextTop
);
2240 $showToolbar = true;
2241 if ( $this->wasDeletedSinceLastEdit() ) {
2242 if ( $this->formtype
== 'save' ) {
2243 // Hide the toolbar and edit area, user can click preview to get it back
2244 // Add an confirmation checkbox and explanation.
2245 $showToolbar = false;
2247 $wgOut->wrapWikiMsg( "<div class='error mw-deleted-while-editing'>\n$1\n</div>",
2248 'deletedwhileediting' );
2252 // @todo add EditForm plugin interface and use it here!
2253 // search for textarea1 and textares2, and allow EditForm to override all uses.
2254 $wgOut->addHTML( Html
::openElement( 'form', array( 'id' => self
::EDITFORM_ID
, 'name' => self
::EDITFORM_ID
,
2255 'method' => 'post', 'action' => $this->getActionURL( $this->getContextTitle() ),
2256 'enctype' => 'multipart/form-data' ) ) );
2258 if ( is_callable( $formCallback ) ) {
2259 call_user_func_array( $formCallback, array( &$wgOut ) );
2262 // Add an empty field to trip up spambots
2264 Xml
::openElement( 'div', array( 'id' => 'antispam-container', 'style' => 'display: none;' ) )
2265 . Html
::rawElement( 'label', array( 'for' => 'wpAntiSpam' ), wfMessage( 'simpleantispam-label' )->parse() )
2266 . Xml
::element( 'input', array( 'type' => 'text', 'name' => 'wpAntispam', 'id' => 'wpAntispam', 'value' => '' ) )
2267 . Xml
::closeElement( 'div' )
2270 wfRunHooks( 'EditPage::showEditForm:fields', array( &$this, &$wgOut ) );
2272 // Put these up at the top to ensure they aren't lost on early form submission
2273 $this->showFormBeforeText();
2275 if ( $this->wasDeletedSinceLastEdit() && 'save' == $this->formtype
) {
2276 $username = $this->lastDelete
->user_name
;
2277 $comment = $this->lastDelete
->log_comment
;
2279 // It is better to not parse the comment at all than to have templates expanded in the middle
2280 // TODO: can the checkLabel be moved outside of the div so that wrapWikiMsg could be used?
2281 $key = $comment === ''
2282 ?
'confirmrecreate-noreason'
2283 : 'confirmrecreate';
2285 '<div class="mw-confirm-recreate">' .
2286 wfMessage( $key, $username, "<nowiki>$comment</nowiki>" )->parse() .
2287 Xml
::checkLabel( wfMessage( 'recreate' )->text(), 'wpRecreate', 'wpRecreate', false,
2288 array( 'title' => Linker
::titleAttrib( 'recreate' ), 'tabindex' => 1, 'id' => 'wpRecreate' )
2294 # When the summary is hidden, also hide them on preview/show changes
2295 if ( $this->nosummary
) {
2296 $wgOut->addHTML( Html
::hidden( 'nosummary', true ) );
2299 # If a blank edit summary was previously provided, and the appropriate
2300 # user preference is active, pass a hidden tag as wpIgnoreBlankSummary. This will stop the
2301 # user being bounced back more than once in the event that a summary
2304 # For a bit more sophisticated detection of blank summaries, hash the
2305 # automatic one and pass that in the hidden field wpAutoSummary.
2306 if ( $this->missingSummary ||
( $this->section
== 'new' && $this->nosummary
) ) {
2307 $wgOut->addHTML( Html
::hidden( 'wpIgnoreBlankSummary', true ) );
2310 if ( $this->undidRev
) {
2311 $wgOut->addHTML( Html
::hidden( 'wpUndidRevision', $this->undidRev
) );
2314 if ( $this->hasPresetSummary
) {
2315 // If a summary has been preset using &summary= we don't want to prompt for
2316 // a different summary. Only prompt for a summary if the summary is blanked.
2318 $this->autoSumm
= md5( '' );
2321 $autosumm = $this->autoSumm ?
$this->autoSumm
: md5( $this->summary
);
2322 $wgOut->addHTML( Html
::hidden( 'wpAutoSummary', $autosumm ) );
2324 $wgOut->addHTML( Html
::hidden( 'oldid', $this->oldid
) );
2326 $wgOut->addHTML( Html
::hidden( 'format', $this->contentFormat
) );
2327 $wgOut->addHTML( Html
::hidden( 'model', $this->contentModel
) );
2329 if ( $this->section
== 'new' ) {
2330 $this->showSummaryInput( true, $this->summary
);
2331 $wgOut->addHTML( $this->getSummaryPreview( true, $this->summary
) );
2334 $wgOut->addHTML( $this->editFormTextBeforeContent
);
2336 if ( !$this->isCssJsSubpage
&& $showToolbar && $wgUser->getOption( 'showtoolbar' ) ) {
2337 $wgOut->addHTML( EditPage
::getEditToolbar() );
2340 if ( $this->isConflict
) {
2341 // In an edit conflict bypass the overridable content form method
2342 // and fallback to the raw wpTextbox1 since editconflicts can't be
2343 // resolved between page source edits and custom ui edits using the
2345 $this->textbox2
= $this->textbox1
;
2347 $content = $this->getCurrentContent();
2348 $this->textbox1
= $this->toEditText( $content );
2350 $this->showTextbox1();
2352 $this->showContentForm();
2355 $wgOut->addHTML( $this->editFormTextAfterContent
);
2357 $this->showStandardInputs();
2359 $this->showFormAfterText();
2361 $this->showTosSummary();
2363 $this->showEditTools();
2365 $wgOut->addHTML( $this->editFormTextAfterTools
. "\n" );
2367 $wgOut->addHTML( Html
::rawElement( 'div', array( 'class' => 'templatesUsed' ),
2368 Linker
::formatTemplates( $this->getTemplates(), $this->preview
, $this->section
!= '' ) ) );
2370 $wgOut->addHTML( Html
::rawElement( 'div', array( 'class' => 'hiddencats' ),
2371 Linker
::formatHiddenCategories( $this->mArticle
->getHiddenCategories() ) ) );
2373 $wgOut->addHTML( Html
::rawElement( 'div', array( 'class' => 'limitreport' ),
2374 self
::getPreviewLimitReport( $this->mParserOutput
) ) );
2376 $wgOut->addModules( 'mediawiki.action.edit.collapsibleFooter' );
2378 if ( $this->isConflict
) {
2380 $this->showConflict();
2381 } catch ( MWContentSerializationException
$ex ) {
2382 // this can't really happen, but be nice if it does.
2383 $msg = wfMessage( 'content-failed-to-parse', $this->contentModel
, $this->contentFormat
, $ex->getMessage() );
2384 $wgOut->addWikiText( '<div class="error">' . $msg->text() . '</div>' );
2388 $wgOut->addHTML( $this->editFormTextBottom
. "\n</form>\n" );
2390 if ( !$wgUser->getOption( 'previewontop' ) ) {
2391 $this->displayPreviewArea( $previewOutput, false );
2394 wfProfileOut( __METHOD__
);
2398 * Extract the section title from current section text, if any.
2400 * @param string $text
2401 * @return Mixed|string or false
2403 public static function extractSectionTitle( $text ) {
2404 preg_match( "/^(=+)(.+)\\1\\s*(\n|$)/i", $text, $matches );
2405 if ( !empty( $matches[2] ) ) {
2407 return $wgParser->stripSectionName( trim( $matches[2] ) );
2413 protected function showHeader() {
2414 global $wgOut, $wgUser, $wgMaxArticleSize, $wgLang;
2416 if ( $this->mTitle
->isTalkPage() ) {
2417 $wgOut->addWikiMsg( 'talkpagetext' );
2421 $wgOut->addHTML( implode( "\n", $this->mTitle
->getEditNotices( $this->oldid
) ) );
2423 if ( $this->isConflict
) {
2424 $wgOut->wrapWikiMsg( "<div class='mw-explainconflict'>\n$1\n</div>", 'explainconflict' );
2425 $this->edittime
= $this->mArticle
->getTimestamp();
2427 if ( $this->section
!= '' && !$this->isSectionEditSupported() ) {
2428 // We use $this->section to much before this and getVal('wgSection') directly in other places
2429 // at this point we can't reset $this->section to '' to fallback to non-section editing.
2430 // Someone is welcome to try refactoring though
2431 $wgOut->showErrorPage( 'sectioneditnotsupported-title', 'sectioneditnotsupported-text' );
2435 if ( $this->section
!= '' && $this->section
!= 'new' ) {
2436 if ( !$this->summary
&& !$this->preview
&& !$this->diff
) {
2437 $sectionTitle = self
::extractSectionTitle( $this->textbox1
); //FIXME: use Content object
2438 if ( $sectionTitle !== false ) {
2439 $this->summary
= "/* $sectionTitle */ ";
2444 if ( $this->missingComment
) {
2445 $wgOut->wrapWikiMsg( "<div id='mw-missingcommenttext'>\n$1\n</div>", 'missingcommenttext' );
2448 if ( $this->missingSummary
&& $this->section
!= 'new' ) {
2449 $wgOut->wrapWikiMsg( "<div id='mw-missingsummary'>\n$1\n</div>", 'missingsummary' );
2452 if ( $this->missingSummary
&& $this->section
== 'new' ) {
2453 $wgOut->wrapWikiMsg( "<div id='mw-missingcommentheader'>\n$1\n</div>", 'missingcommentheader' );
2456 if ( $this->hookError
!== '' ) {
2457 $wgOut->addWikiText( $this->hookError
);
2460 if ( !$this->checkUnicodeCompliantBrowser() ) {
2461 $wgOut->addWikiMsg( 'nonunicodebrowser' );
2464 if ( $this->section
!= 'new' ) {
2465 $revision = $this->mArticle
->getRevisionFetched();
2467 // Let sysop know that this will make private content public if saved
2469 if ( !$revision->userCan( Revision
::DELETED_TEXT
, $wgUser ) ) {
2470 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n", 'rev-deleted-text-permission' );
2471 } elseif ( $revision->isDeleted( Revision
::DELETED_TEXT
) ) {
2472 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n", 'rev-deleted-text-view' );
2475 if ( !$revision->isCurrent() ) {
2476 $this->mArticle
->setOldSubtitle( $revision->getId() );
2477 $wgOut->addWikiMsg( 'editingold' );
2479 } elseif ( $this->mTitle
->exists() ) {
2480 // Something went wrong
2482 $wgOut->wrapWikiMsg( "<div class='errorbox'>\n$1\n</div>\n",
2483 array( 'missing-revision', $this->oldid
) );
2488 if ( wfReadOnly() ) {
2489 $wgOut->wrapWikiMsg( "<div id=\"mw-read-only-warning\">\n$1\n</div>", array( 'readonlywarning', wfReadOnlyReason() ) );
2490 } elseif ( $wgUser->isAnon() ) {
2491 if ( $this->formtype
!= 'preview' ) {
2492 $wgOut->wrapWikiMsg( "<div id=\"mw-anon-edit-warning\">\n$1</div>", 'anoneditwarning' );
2494 $wgOut->wrapWikiMsg( "<div id=\"mw-anon-preview-warning\">\n$1</div>", 'anonpreviewwarning' );
2497 if ( $this->isCssJsSubpage
) {
2498 # Check the skin exists
2499 if ( $this->isWrongCaseCssJsPage
) {
2500 $wgOut->wrapWikiMsg( "<div class='error' id='mw-userinvalidcssjstitle'>\n$1\n</div>", array( 'userinvalidcssjstitle', $this->mTitle
->getSkinFromCssJsSubpage() ) );
2502 if ( $this->formtype
!== 'preview' ) {
2503 if ( $this->isCssSubpage
) {
2504 $wgOut->wrapWikiMsg( "<div id='mw-usercssyoucanpreview'>\n$1\n</div>", array( 'usercssyoucanpreview' ) );
2507 if ( $this->isJsSubpage
) {
2508 $wgOut->wrapWikiMsg( "<div id='mw-userjsyoucanpreview'>\n$1\n</div>", array( 'userjsyoucanpreview' ) );
2514 if ( $this->mTitle
->isProtected( 'edit' ) &&
2515 MWNamespace
::getRestrictionLevels( $this->mTitle
->getNamespace() ) !== array( '' )
2517 # Is the title semi-protected?
2518 if ( $this->mTitle
->isSemiProtected() ) {
2519 $noticeMsg = 'semiprotectedpagewarning';
2521 # Then it must be protected based on static groups (regular)
2522 $noticeMsg = 'protectedpagewarning';
2524 LogEventsList
::showLogExtract( $wgOut, 'protect', $this->mTitle
, '',
2525 array( 'lim' => 1, 'msgKey' => array( $noticeMsg ) ) );
2527 if ( $this->mTitle
->isCascadeProtected() ) {
2528 # Is this page under cascading protection from some source pages?
2529 list( $cascadeSources, /* $restrictions */ ) = $this->mTitle
->getCascadeProtectionSources();
2530 $notice = "<div class='mw-cascadeprotectedwarning'>\n$1\n";
2531 $cascadeSourcesCount = count( $cascadeSources );
2532 if ( $cascadeSourcesCount > 0 ) {
2533 # Explain, and list the titles responsible
2534 foreach ( $cascadeSources as $page ) {
2535 $notice .= '* [[:' . $page->getPrefixedText() . "]]\n";
2538 $notice .= '</div>';
2539 $wgOut->wrapWikiMsg( $notice, array( 'cascadeprotectedwarning', $cascadeSourcesCount ) );
2541 if ( !$this->mTitle
->exists() && $this->mTitle
->getRestrictions( 'create' ) ) {
2542 LogEventsList
::showLogExtract( $wgOut, 'protect', $this->mTitle
, '',
2544 'showIfEmpty' => false,
2545 'msgKey' => array( 'titleprotectedwarning' ),
2546 'wrap' => "<div class=\"mw-titleprotectedwarning\">\n$1</div>" ) );
2549 if ( $this->kblength
=== false ) {
2550 $this->kblength
= (int)( strlen( $this->textbox1
) / 1024 );
2553 if ( $this->tooBig ||
$this->kblength
> $wgMaxArticleSize ) {
2554 $wgOut->wrapWikiMsg( "<div class='error' id='mw-edit-longpageerror'>\n$1\n</div>",
2555 array( 'longpageerror', $wgLang->formatNum( $this->kblength
), $wgLang->formatNum( $wgMaxArticleSize ) ) );
2557 if ( !wfMessage( 'longpage-hint' )->isDisabled() ) {
2558 $wgOut->wrapWikiMsg( "<div id='mw-edit-longpage-hint'>\n$1\n</div>",
2559 array( 'longpage-hint', $wgLang->formatSize( strlen( $this->textbox1
) ), strlen( $this->textbox1
) )
2563 # Add header copyright warning
2564 $this->showHeaderCopyrightWarning();
2568 * Standard summary input and label (wgSummary), abstracted so EditPage
2569 * subclasses may reorganize the form.
2570 * Note that you do not need to worry about the label's for=, it will be
2571 * inferred by the id given to the input. You can remove them both by
2572 * passing array( 'id' => false ) to $userInputAttrs.
2574 * @param string $summary The value of the summary input
2575 * @param string $labelText The html to place inside the label
2576 * @param array $inputAttrs of attrs to use on the input
2577 * @param array $spanLabelAttrs of attrs to use on the span inside the label
2579 * @return array An array in the format array( $label, $input )
2581 function getSummaryInput( $summary = "", $labelText = null, $inputAttrs = null, $spanLabelAttrs = null ) {
2582 // Note: the maxlength is overridden in JS to 255 and to make it use UTF-8 bytes, not characters.
2583 $inputAttrs = ( is_array( $inputAttrs ) ?
$inputAttrs : array() ) +
array(
2584 'id' => 'wpSummary',
2585 'maxlength' => '200',
2588 'spellcheck' => 'true',
2589 ) + Linker
::tooltipAndAccesskeyAttribs( 'summary' );
2591 $spanLabelAttrs = ( is_array( $spanLabelAttrs ) ?
$spanLabelAttrs : array() ) +
array(
2592 'class' => $this->missingSummary ?
'mw-summarymissed' : 'mw-summary',
2593 'id' => "wpSummaryLabel"
2598 $label = Xml
::tags( 'label', $inputAttrs['id'] ?
array( 'for' => $inputAttrs['id'] ) : null, $labelText );
2599 $label = Xml
::tags( 'span', $spanLabelAttrs, $label );
2602 $input = Html
::input( 'wpSummary', $summary, 'text', $inputAttrs );
2604 return array( $label, $input );
2608 * @param $isSubjectPreview Boolean: true if this is the section subject/title
2609 * up top, or false if this is the comment summary
2610 * down below the textarea
2611 * @param string $summary The text of the summary to display
2614 protected function showSummaryInput( $isSubjectPreview, $summary = "" ) {
2615 global $wgOut, $wgContLang;
2616 # Add a class if 'missingsummary' is triggered to allow styling of the summary line
2617 $summaryClass = $this->missingSummary ?
'mw-summarymissed' : 'mw-summary';
2618 if ( $isSubjectPreview ) {
2619 if ( $this->nosummary
) {
2623 if ( !$this->mShowSummaryField
) {
2627 $summary = $wgContLang->recodeForEdit( $summary );
2628 $labelText = wfMessage( $isSubjectPreview ?
'subject' : 'summary' )->parse();
2629 list( $label, $input ) = $this->getSummaryInput( $summary, $labelText, array( 'class' => $summaryClass ), array() );
2630 $wgOut->addHTML( "{$label} {$input}" );
2634 * @param $isSubjectPreview Boolean: true if this is the section subject/title
2635 * up top, or false if this is the comment summary
2636 * down below the textarea
2637 * @param string $summary the text of the summary to display
2640 protected function getSummaryPreview( $isSubjectPreview, $summary = "" ) {
2641 // avoid spaces in preview, gets always trimmed on save
2642 $summary = trim( $summary );
2643 if ( !$summary ||
( !$this->preview
&& !$this->diff
) ) {
2649 if ( $isSubjectPreview ) {
2650 $summary = wfMessage( 'newsectionsummary' )->rawParams( $wgParser->stripSectionName( $summary ) )
2651 ->inContentLanguage()->text();
2654 $message = $isSubjectPreview ?
'subject-preview' : 'summary-preview';
2656 $summary = wfMessage( $message )->parse() . Linker
::commentBlock( $summary, $this->mTitle
, $isSubjectPreview );
2657 return Xml
::tags( 'div', array( 'class' => 'mw-summary-preview' ), $summary );
2660 protected function showFormBeforeText() {
2662 $section = htmlspecialchars( $this->section
);
2663 $wgOut->addHTML( <<<HTML
2664 <input type='hidden' value="{$section}" name="wpSection" />
2665 <input type='hidden' value="{$this->starttime}" name="wpStarttime" />
2666 <input type='hidden' value="{$this->edittime}" name="wpEdittime" />
2667 <input type='hidden' value="{$this->scrolltop}" name="wpScrolltop" id="wpScrolltop" />
2671 if ( !$this->checkUnicodeCompliantBrowser() ) {
2672 $wgOut->addHTML( Html
::hidden( 'safemode', '1' ) );
2676 protected function showFormAfterText() {
2677 global $wgOut, $wgUser;
2679 * To make it harder for someone to slip a user a page
2680 * which submits an edit form to the wiki without their
2681 * knowledge, a random token is associated with the login
2682 * session. If it's not passed back with the submission,
2683 * we won't save the page, or render user JavaScript and
2686 * For anon editors, who may not have a session, we just
2687 * include the constant suffix to prevent editing from
2688 * broken text-mangling proxies.
2690 $wgOut->addHTML( "\n" . Html
::hidden( "wpEditToken", $wgUser->getEditToken() ) . "\n" );
2694 * Subpage overridable method for printing the form for page content editing
2695 * By default this simply outputs wpTextbox1
2696 * Subclasses can override this to provide a custom UI for editing;
2697 * be it a form, or simply wpTextbox1 with a modified content that will be
2698 * reverse modified when extracted from the post data.
2699 * Note that this is basically the inverse for importContentFormData
2701 protected function showContentForm() {
2702 $this->showTextbox1();
2706 * Method to output wpTextbox1
2707 * The $textoverride method can be used by subclasses overriding showContentForm
2708 * to pass back to this method.
2710 * @param array $customAttribs of html attributes to use in the textarea
2711 * @param string $textoverride optional text to override $this->textarea1 with
2713 protected function showTextbox1( $customAttribs = null, $textoverride = null ) {
2714 if ( $this->wasDeletedSinceLastEdit() && $this->formtype
== 'save' ) {
2715 $attribs = array( 'style' => 'display:none;' );
2717 $classes = array(); // Textarea CSS
2718 if ( $this->mTitle
->isProtected( 'edit' ) &&
2719 MWNamespace
::getRestrictionLevels( $this->mTitle
->getNamespace() ) !== array( '' )
2721 # Is the title semi-protected?
2722 if ( $this->mTitle
->isSemiProtected() ) {
2723 $classes[] = 'mw-textarea-sprotected';
2725 # Then it must be protected based on static groups (regular)
2726 $classes[] = 'mw-textarea-protected';
2728 # Is the title cascade-protected?
2729 if ( $this->mTitle
->isCascadeProtected() ) {
2730 $classes[] = 'mw-textarea-cprotected';
2734 $attribs = array( 'tabindex' => 1 );
2736 if ( is_array( $customAttribs ) ) {
2737 $attribs +
= $customAttribs;
2740 if ( count( $classes ) ) {
2741 if ( isset( $attribs['class'] ) ) {
2742 $classes[] = $attribs['class'];
2744 $attribs['class'] = implode( ' ', $classes );
2748 $this->showTextbox( $textoverride !== null ?
$textoverride : $this->textbox1
, 'wpTextbox1', $attribs );
2751 protected function showTextbox2() {
2752 $this->showTextbox( $this->textbox2
, 'wpTextbox2', array( 'tabindex' => 6, 'readonly' ) );
2755 protected function showTextbox( $text, $name, $customAttribs = array() ) {
2756 global $wgOut, $wgUser;
2758 $wikitext = $this->safeUnicodeOutput( $text );
2759 if ( strval( $wikitext ) !== '' ) {
2760 // Ensure there's a newline at the end, otherwise adding lines
2762 // But don't add a newline if the ext is empty, or Firefox in XHTML
2763 // mode will show an extra newline. A bit annoying.
2767 $attribs = $customAttribs +
array(
2770 'cols' => $wgUser->getIntOption( 'cols' ),
2771 'rows' => $wgUser->getIntOption( 'rows' ),
2772 'style' => '' // avoid php notices when appending preferences (appending allows customAttribs['style'] to still work
2775 $pageLang = $this->mTitle
->getPageLanguage();
2776 $attribs['lang'] = $pageLang->getCode();
2777 $attribs['dir'] = $pageLang->getDir();
2779 $wgOut->addHTML( Html
::textarea( $name, $wikitext, $attribs ) );
2782 protected function displayPreviewArea( $previewOutput, $isOnTop = false ) {
2786 $classes[] = 'ontop';
2789 $attribs = array( 'id' => 'wikiPreview', 'class' => implode( ' ', $classes ) );
2791 if ( $this->formtype
!= 'preview' ) {
2792 $attribs['style'] = 'display: none;';
2795 $wgOut->addHTML( Xml
::openElement( 'div', $attribs ) );
2797 if ( $this->formtype
== 'preview' ) {
2798 $this->showPreview( $previewOutput );
2801 $wgOut->addHTML( '</div>' );
2803 if ( $this->formtype
== 'diff' ) {
2806 } catch ( MWContentSerializationException
$ex ) {
2807 $msg = wfMessage( 'content-failed-to-parse', $this->contentModel
, $this->contentFormat
, $ex->getMessage() );
2808 $wgOut->addWikiText( '<div class="error">' . $msg->text() . '</div>' );
2814 * Append preview output to $wgOut.
2815 * Includes category rendering if this is a category page.
2817 * @param string $text the HTML to be output for the preview.
2819 protected function showPreview( $text ) {
2821 if ( $this->mTitle
->getNamespace() == NS_CATEGORY
) {
2822 $this->mArticle
->openShowCategory();
2824 # This hook seems slightly odd here, but makes things more
2825 # consistent for extensions.
2826 wfRunHooks( 'OutputPageBeforeHTML', array( &$wgOut, &$text ) );
2827 $wgOut->addHTML( $text );
2828 if ( $this->mTitle
->getNamespace() == NS_CATEGORY
) {
2829 $this->mArticle
->closeShowCategory();
2834 * Get a diff between the current contents of the edit box and the
2835 * version of the page we're editing from.
2837 * If this is a section edit, we'll replace the section as for final
2838 * save and then make a comparison.
2840 function showDiff() {
2841 global $wgUser, $wgContLang, $wgOut;
2843 $oldtitlemsg = 'currentrev';
2844 # if message does not exist, show diff against the preloaded default
2845 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
&& !$this->mTitle
->exists() ) {
2846 $oldtext = $this->mTitle
->getDefaultMessageText();
2847 if ( $oldtext !== false ) {
2848 $oldtitlemsg = 'defaultmessagetext';
2849 $oldContent = $this->toEditContent( $oldtext );
2854 $oldContent = $this->getCurrentContent();
2857 $textboxContent = $this->toEditContent( $this->textbox1
);
2859 $newContent = $this->mArticle
->replaceSectionContent(
2860 $this->section
, $textboxContent,
2861 $this->summary
, $this->edittime
);
2863 if ( $newContent ) {
2864 ContentHandler
::runLegacyHooks( 'EditPageGetDiffText', array( $this, &$newContent ) );
2865 wfRunHooks( 'EditPageGetDiffContent', array( $this, &$newContent ) );
2867 $popts = ParserOptions
::newFromUserAndLang( $wgUser, $wgContLang );
2868 $newContent = $newContent->preSaveTransform( $this->mTitle
, $wgUser, $popts );
2871 if ( ( $oldContent && !$oldContent->isEmpty() ) ||
( $newContent && !$newContent->isEmpty() ) ) {
2872 $oldtitle = wfMessage( $oldtitlemsg )->parse();
2873 $newtitle = wfMessage( 'yourtext' )->parse();
2875 if ( !$oldContent ) {
2876 $oldContent = $newContent->getContentHandler()->makeEmptyContent();
2879 if ( !$newContent ) {
2880 $newContent = $oldContent->getContentHandler()->makeEmptyContent();
2883 $de = $oldContent->getContentHandler()->createDifferenceEngine( $this->mArticle
->getContext() );
2884 $de->setContent( $oldContent, $newContent );
2886 $difftext = $de->getDiff( $oldtitle, $newtitle );
2887 $de->showDiffStyle();
2892 $wgOut->addHTML( '<div id="wikiDiff">' . $difftext . '</div>' );
2896 * Show the header copyright warning.
2898 protected function showHeaderCopyrightWarning() {
2899 $msg = 'editpage-head-copy-warn';
2900 if ( !wfMessage( $msg )->isDisabled() ) {
2902 $wgOut->wrapWikiMsg( "<div class='editpage-head-copywarn'>\n$1\n</div>",
2903 'editpage-head-copy-warn' );
2908 * Give a chance for site and per-namespace customizations of
2909 * terms of service summary link that might exist separately
2910 * from the copyright notice.
2912 * This will display between the save button and the edit tools,
2913 * so should remain short!
2915 protected function showTosSummary() {
2916 $msg = 'editpage-tos-summary';
2917 wfRunHooks( 'EditPageTosSummary', array( $this->mTitle
, &$msg ) );
2918 if ( !wfMessage( $msg )->isDisabled() ) {
2920 $wgOut->addHTML( '<div class="mw-tos-summary">' );
2921 $wgOut->addWikiMsg( $msg );
2922 $wgOut->addHTML( '</div>' );
2926 protected function showEditTools() {
2928 $wgOut->addHTML( '<div class="mw-editTools">' .
2929 wfMessage( 'edittools' )->inContentLanguage()->parse() .
2934 * Get the copyright warning
2936 * Renamed to getCopyrightWarning(), old name kept around for backwards compatibility
2938 protected function getCopywarn() {
2939 return self
::getCopyrightWarning( $this->mTitle
);
2943 * Get the copyright warning, by default returns wikitext
2945 * @param Title $title
2946 * @param string $format output format, valid values are any function of
2950 public static function getCopyrightWarning( $title, $format = 'plain' ) {
2951 global $wgRightsText;
2952 if ( $wgRightsText ) {
2953 $copywarnMsg = array( 'copyrightwarning',
2954 '[[' . wfMessage( 'copyrightpage' )->inContentLanguage()->text() . ']]',
2957 $copywarnMsg = array( 'copyrightwarning2',
2958 '[[' . wfMessage( 'copyrightpage' )->inContentLanguage()->text() . ']]' );
2960 // Allow for site and per-namespace customization of contribution/copyright notice.
2961 wfRunHooks( 'EditPageCopyrightWarning', array( $title, &$copywarnMsg ) );
2963 return "<div id=\"editpage-copywarn\">\n" .
2964 call_user_func_array( 'wfMessage', $copywarnMsg )->$format() . "\n</div>";
2968 * Get the Limit report for page previews
2971 * @param ParserOutput $output ParserOutput object from the parse
2972 * @return string HTML
2974 public static function getPreviewLimitReport( $output ) {
2975 if ( !$output ||
!$output->getLimitReportData() ) {
2979 wfProfileIn( __METHOD__
);
2981 $limitReport = Html
::rawElement( 'div', array( 'class' => 'mw-limitReportExplanation' ),
2982 wfMessage( 'limitreport-title' )->parseAsBlock()
2985 // Show/hide animation doesn't work correctly on a table, so wrap it in a div.
2986 $limitReport .= Html
::openElement( 'div', array( 'class' => 'preview-limit-report-wrapper' ) );
2988 $limitReport .= Html
::openElement( 'table', array(
2989 'class' => 'preview-limit-report wikitable'
2991 Html
::openElement( 'tbody' );
2993 foreach ( $output->getLimitReportData() as $key => $value ) {
2994 if ( wfRunHooks( 'ParserLimitReportFormat',
2995 array( $key, &$value, &$limitReport, true, true )
2997 $keyMsg = wfMessage( $key );
2998 $valueMsg = wfMessage( array( "$key-value-html", "$key-value" ) );
2999 if ( !$valueMsg->exists() ) {
3000 $valueMsg = new RawMessage( '$1' );
3002 if ( !$keyMsg->isDisabled() && !$valueMsg->isDisabled() ) {
3003 $limitReport .= Html
::openElement( 'tr' ) .
3004 Html
::rawElement( 'th', null, $keyMsg->parse() ) .
3005 Html
::rawElement( 'td', null, $valueMsg->params( $value )->parse() ) .
3006 Html
::closeElement( 'tr' );
3011 $limitReport .= Html
::closeElement( 'tbody' ) .
3012 Html
::closeElement( 'table' ) .
3013 Html
::closeElement( 'div' );
3015 wfProfileOut( __METHOD__
);
3017 return $limitReport;
3020 protected function showStandardInputs( &$tabindex = 2 ) {
3022 $wgOut->addHTML( "<div class='editOptions'>\n" );
3024 if ( $this->section
!= 'new' ) {
3025 $this->showSummaryInput( false, $this->summary
);
3026 $wgOut->addHTML( $this->getSummaryPreview( false, $this->summary
) );
3029 $checkboxes = $this->getCheckboxes( $tabindex,
3030 array( 'minor' => $this->minoredit
, 'watch' => $this->watchthis
) );
3031 $wgOut->addHTML( "<div class='editCheckboxes'>" . implode( $checkboxes, "\n" ) . "</div>\n" );
3033 // Show copyright warning.
3034 $wgOut->addWikiText( $this->getCopywarn() );
3035 $wgOut->addHTML( $this->editFormTextAfterWarn
);
3037 $wgOut->addHTML( "<div class='editButtons'>\n" );
3038 $wgOut->addHTML( implode( $this->getEditButtons( $tabindex ), "\n" ) . "\n" );
3040 $cancel = $this->getCancelLink();
3041 if ( $cancel !== '' ) {
3042 $cancel .= Html
::element( 'span',
3043 array( 'class' => 'mw-editButtons-pipe-separator' ),
3044 wfMessage( 'pipe-separator' )->text() );
3046 $edithelpurl = Skin
::makeInternalOrExternalUrl( wfMessage( 'edithelppage' )->inContentLanguage()->text() );
3047 $edithelp = '<a target="helpwindow" href="' . $edithelpurl . '">' .
3048 wfMessage( 'edithelp' )->escaped() . '</a> ' .
3049 wfMessage( 'newwindow' )->parse();
3050 $wgOut->addHTML( " <span class='cancelLink'>{$cancel}</span>\n" );
3051 $wgOut->addHTML( " <span class='editHelp'>{$edithelp}</span>\n" );
3052 $wgOut->addHTML( "</div><!-- editButtons -->\n" );
3053 wfRunHooks( 'EditPage::showStandardInputs:options', array( $this, $wgOut, &$tabindex ) );
3054 $wgOut->addHTML( "</div><!-- editOptions -->\n" );
3058 * Show an edit conflict. textbox1 is already shown in showEditForm().
3059 * If you want to use another entry point to this function, be careful.
3061 protected function showConflict() {
3064 if ( wfRunHooks( 'EditPageBeforeConflictDiff', array( &$this, &$wgOut ) ) ) {
3065 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
3067 $content1 = $this->toEditContent( $this->textbox1
);
3068 $content2 = $this->toEditContent( $this->textbox2
);
3070 $handler = ContentHandler
::getForModelID( $this->contentModel
);
3071 $de = $handler->createDifferenceEngine( $this->mArticle
->getContext() );
3072 $de->setContent( $content2, $content1 );
3074 wfMessage( 'yourtext' )->parse(),
3075 wfMessage( 'storedversion' )->text()
3078 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
3079 $this->showTextbox2();
3086 public function getCancelLink() {
3087 $cancelParams = array();
3088 if ( !$this->isConflict
&& $this->oldid
> 0 ) {
3089 $cancelParams['oldid'] = $this->oldid
;
3092 return Linker
::linkKnown(
3093 $this->getContextTitle(),
3094 wfMessage( 'cancel' )->parse(),
3095 array( 'id' => 'mw-editform-cancel' ),
3101 * Returns the URL to use in the form's action attribute.
3102 * This is used by EditPage subclasses when simply customizing the action
3103 * variable in the constructor is not enough. This can be used when the
3104 * EditPage lives inside of a Special page rather than a custom page action.
3106 * @param $title Title object for which is being edited (where we go to for &action= links)
3109 protected function getActionURL( Title
$title ) {
3110 return $title->getLocalURL( array( 'action' => $this->action
) );
3114 * Check if a page was deleted while the user was editing it, before submit.
3115 * Note that we rely on the logging table, which hasn't been always there,
3116 * but that doesn't matter, because this only applies to brand new
3119 protected function wasDeletedSinceLastEdit() {
3120 if ( $this->deletedSinceEdit
!== null ) {
3121 return $this->deletedSinceEdit
;
3124 $this->deletedSinceEdit
= false;
3126 if ( $this->mTitle
->isDeletedQuick() ) {
3127 $this->lastDelete
= $this->getLastDelete();
3128 if ( $this->lastDelete
) {
3129 $deleteTime = wfTimestamp( TS_MW
, $this->lastDelete
->log_timestamp
);
3130 if ( $deleteTime > $this->starttime
) {
3131 $this->deletedSinceEdit
= true;
3136 return $this->deletedSinceEdit
;
3139 protected function getLastDelete() {
3140 $dbr = wfGetDB( DB_SLAVE
);
3141 $data = $dbr->selectRow(
3142 array( 'logging', 'user' ),
3155 'log_namespace' => $this->mTitle
->getNamespace(),
3156 'log_title' => $this->mTitle
->getDBkey(),
3157 'log_type' => 'delete',
3158 'log_action' => 'delete',
3162 array( 'LIMIT' => 1, 'ORDER BY' => 'log_timestamp DESC' )
3164 // Quick paranoid permission checks...
3165 if ( is_object( $data ) ) {
3166 if ( $data->log_deleted
& LogPage
::DELETED_USER
) {
3167 $data->user_name
= wfMessage( 'rev-deleted-user' )->escaped();
3170 if ( $data->log_deleted
& LogPage
::DELETED_COMMENT
) {
3171 $data->log_comment
= wfMessage( 'rev-deleted-comment' )->escaped();
3178 * Get the rendered text for previewing.
3179 * @throws MWException
3182 function getPreviewText() {
3183 global $wgOut, $wgUser, $wgRawHtml, $wgLang;
3185 wfProfileIn( __METHOD__
);
3187 if ( $wgRawHtml && !$this->mTokenOk
) {
3188 // Could be an offsite preview attempt. This is very unsafe if
3189 // HTML is enabled, as it could be an attack.
3191 if ( $this->textbox1
!== '' ) {
3192 // Do not put big scary notice, if previewing the empty
3193 // string, which happens when you initially edit
3194 // a category page, due to automatic preview-on-open.
3195 $parsedNote = $wgOut->parse( "<div class='previewnote'>" .
3196 wfMessage( 'session_fail_preview_html' )->text() . "</div>", true, /* interface */true );
3198 wfProfileOut( __METHOD__
);
3205 $content = $this->toEditContent( $this->textbox1
);
3208 if ( !wfRunHooks( 'AlternateEditPreview', array( $this, &$content, &$previewHTML, &$this->mParserOutput
) ) ) {
3209 wfProfileOut( __METHOD__
);
3210 return $previewHTML;
3213 # provide a anchor link to the editform
3214 $continueEditing = '<span class="mw-continue-editing">' .
3215 '[[#' . self
::EDITFORM_ID
. '|' . $wgLang->getArrow() . ' ' .
3216 wfMessage( 'continue-editing' )->text() . ']]</span>';
3217 if ( $this->mTriedSave
&& !$this->mTokenOk
) {
3218 if ( $this->mTokenOkExceptSuffix
) {
3219 $note = wfMessage( 'token_suffix_mismatch' )->plain();
3222 $note = wfMessage( 'session_fail_preview' )->plain();
3224 } elseif ( $this->incompleteForm
) {
3225 $note = wfMessage( 'edit_form_incomplete' )->plain();
3227 $note = wfMessage( 'previewnote' )->plain() . ' ' . $continueEditing;
3230 $parserOptions = $this->mArticle
->makeParserOptions( $this->mArticle
->getContext() );
3231 $parserOptions->setEditSection( false );
3232 $parserOptions->setIsPreview( true );
3233 $parserOptions->setIsSectionPreview( !is_null( $this->section
) && $this->section
!== '' );
3235 # don't parse non-wikitext pages, show message about preview
3236 if ( $this->mTitle
->isCssJsSubpage() ||
$this->mTitle
->isCssOrJsPage() ) {
3237 if ( $this->mTitle
->isCssJsSubpage() ) {
3239 } elseif ( $this->mTitle
->isCssOrJsPage() ) {
3245 if ( $content->getModel() == CONTENT_MODEL_CSS
) {
3247 } elseif ( $content->getModel() == CONTENT_MODEL_JAVASCRIPT
) {
3253 # Used messages to make sure grep find them:
3254 # Messages: usercsspreview, userjspreview, sitecsspreview, sitejspreview
3255 if ( $level && $format ) {
3256 $note = "<div id='mw-{$level}{$format}preview'>" .
3257 wfMessage( "{$level}{$format}preview" )->text() .
3258 ' ' . $continueEditing . "</div>";
3262 # If we're adding a comment, we need to show the
3263 # summary as the headline
3264 if ( $this->section
=== "new" && $this->summary
!== "" ) {
3265 $content = $content->addSectionHeader( $this->summary
);
3268 $hook_args = array( $this, &$content );
3269 ContentHandler
::runLegacyHooks( 'EditPageGetPreviewText', $hook_args );
3270 wfRunHooks( 'EditPageGetPreviewContent', $hook_args );
3272 $parserOptions->enableLimitReport();
3274 # For CSS/JS pages, we should have called the ShowRawCssJs hook here.
3275 # But it's now deprecated, so never mind
3277 $content = $content->preSaveTransform( $this->mTitle
, $wgUser, $parserOptions );
3278 $parserOutput = $content->getParserOutput( $this->getArticle()->getTitle(), null, $parserOptions );
3280 $previewHTML = $parserOutput->getText();
3281 $this->mParserOutput
= $parserOutput;
3282 $wgOut->addParserOutputNoText( $parserOutput );
3284 if ( count( $parserOutput->getWarnings() ) ) {
3285 $note .= "\n\n" . implode( "\n\n", $parserOutput->getWarnings() );
3287 } catch ( MWContentSerializationException
$ex ) {
3288 $m = wfMessage( 'content-failed-to-parse', $this->contentModel
, $this->contentFormat
, $ex->getMessage() );
3289 $note .= "\n\n" . $m->parse();
3293 if ( $this->isConflict
) {
3294 $conflict = '<h2 id="mw-previewconflict">' . wfMessage( 'previewconflict' )->escaped() . "</h2>\n";
3296 $conflict = '<hr />';
3299 $previewhead = "<div class='previewnote'>\n" .
3300 '<h2 id="mw-previewheader">' . wfMessage( 'preview' )->escaped() . "</h2>" .
3301 $wgOut->parse( $note, true, /* interface */true ) . $conflict . "</div>\n";
3303 $pageViewLang = $this->mTitle
->getPageViewLanguage();
3304 $attribs = array( 'lang' => $pageViewLang->getHtmlCode(), 'dir' => $pageViewLang->getDir(),
3305 'class' => 'mw-content-' . $pageViewLang->getDir() );
3306 $previewHTML = Html
::rawElement( 'div', $attribs, $previewHTML );
3308 wfProfileOut( __METHOD__
);
3309 return $previewhead . $previewHTML . $this->previewTextAfterContent
;
3315 function getTemplates() {
3316 if ( $this->preview ||
$this->section
!= '' ) {
3317 $templates = array();
3318 if ( !isset( $this->mParserOutput
) ) {
3321 foreach ( $this->mParserOutput
->getTemplates() as $ns => $template ) {
3322 foreach ( array_keys( $template ) as $dbk ) {
3323 $templates[] = Title
::makeTitle( $ns, $dbk );
3328 return $this->mTitle
->getTemplateLinksFrom();
3333 * Shows a bulletin board style toolbar for common editing functions.
3334 * It can be disabled in the user preferences.
3335 * The necessary JavaScript code can be found in skins/common/edit.js.
3339 static function getEditToolbar() {
3340 global $wgStylePath, $wgContLang, $wgLang, $wgOut;
3341 global $wgEnableUploads, $wgForeignFileRepos;
3343 $imagesAvailable = $wgEnableUploads ||
count( $wgForeignFileRepos );
3346 * $toolarray is an array of arrays each of which includes the
3347 * filename of the button image (without path), the opening
3348 * tag, the closing tag, optionally a sample text that is
3349 * inserted between the two when no selection is highlighted
3350 * and. The tip text is shown when the user moves the mouse
3353 * Also here: accesskeys (key), which are not used yet until
3354 * someone can figure out a way to make them work in
3355 * IE. However, we should make sure these keys are not defined
3360 'image' => $wgLang->getImageFile( 'button-bold' ),
3361 'id' => 'mw-editbutton-bold',
3363 'close' => '\'\'\'',
3364 'sample' => wfMessage( 'bold_sample' )->text(),
3365 'tip' => wfMessage( 'bold_tip' )->text(),
3369 'image' => $wgLang->getImageFile( 'button-italic' ),
3370 'id' => 'mw-editbutton-italic',
3373 'sample' => wfMessage( 'italic_sample' )->text(),
3374 'tip' => wfMessage( 'italic_tip' )->text(),
3378 'image' => $wgLang->getImageFile( 'button-link' ),
3379 'id' => 'mw-editbutton-link',
3382 'sample' => wfMessage( 'link_sample' )->text(),
3383 'tip' => wfMessage( 'link_tip' )->text(),
3387 'image' => $wgLang->getImageFile( 'button-extlink' ),
3388 'id' => 'mw-editbutton-extlink',
3391 'sample' => wfMessage( 'extlink_sample' )->text(),
3392 'tip' => wfMessage( 'extlink_tip' )->text(),
3396 'image' => $wgLang->getImageFile( 'button-headline' ),
3397 'id' => 'mw-editbutton-headline',
3400 'sample' => wfMessage( 'headline_sample' )->text(),
3401 'tip' => wfMessage( 'headline_tip' )->text(),
3404 $imagesAvailable ?
array(
3405 'image' => $wgLang->getImageFile( 'button-image' ),
3406 'id' => 'mw-editbutton-image',
3407 'open' => '[[' . $wgContLang->getNsText( NS_FILE
) . ':',
3409 'sample' => wfMessage( 'image_sample' )->text(),
3410 'tip' => wfMessage( 'image_tip' )->text(),
3413 $imagesAvailable ?
array(
3414 'image' => $wgLang->getImageFile( 'button-media' ),
3415 'id' => 'mw-editbutton-media',
3416 'open' => '[[' . $wgContLang->getNsText( NS_MEDIA
) . ':',
3418 'sample' => wfMessage( 'media_sample' )->text(),
3419 'tip' => wfMessage( 'media_tip' )->text(),
3423 'image' => $wgLang->getImageFile( 'button-nowiki' ),
3424 'id' => 'mw-editbutton-nowiki',
3425 'open' => "<nowiki>",
3426 'close' => "</nowiki>",
3427 'sample' => wfMessage( 'nowiki_sample' )->text(),
3428 'tip' => wfMessage( 'nowiki_tip' )->text(),
3432 'image' => $wgLang->getImageFile( 'button-sig' ),
3433 'id' => 'mw-editbutton-signature',
3437 'tip' => wfMessage( 'sig_tip' )->text(),
3441 'image' => $wgLang->getImageFile( 'button-hr' ),
3442 'id' => 'mw-editbutton-hr',
3443 'open' => "\n----\n",
3446 'tip' => wfMessage( 'hr_tip' )->text(),
3451 $script = 'mw.loader.using("mediawiki.action.edit", function() {';
3452 foreach ( $toolarray as $tool ) {
3458 $wgStylePath . '/common/images/' . $tool['image'],
3459 // Note that we use the tip both for the ALT tag and the TITLE tag of the image.
3460 // Older browsers show a "speedtip" type message only for ALT.
3461 // Ideally these should be different, realistically they
3462 // probably don't need to be.
3470 $script .= Xml
::encodeJsCall( 'mw.toolbar.addButton', $params );
3473 // This used to be called on DOMReady from mediawiki.action.edit, which
3474 // ended up causing race conditions with the setup code above.
3476 "// Create button bar\n" .
3477 "$(function() { mw.toolbar.init(); } );\n";
3480 $wgOut->addScript( Html
::inlineScript( ResourceLoader
::makeLoaderConditionalScript( $script ) ) );
3482 $toolbar = '<div id="toolbar"></div>';
3484 wfRunHooks( 'EditPageBeforeEditToolbar', array( &$toolbar ) );
3490 * Returns an array of html code of the following checkboxes:
3493 * @param int $tabindex Current tabindex
3494 * @param array $checked of checkbox => bool, where bool indicates the checked
3495 * status of the checkbox
3499 public function getCheckboxes( &$tabindex, $checked ) {
3502 $checkboxes = array();
3504 // don't show the minor edit checkbox if it's a new page or section
3505 if ( !$this->isNew
) {
3506 $checkboxes['minor'] = '';
3507 $minorLabel = wfMessage( 'minoredit' )->parse();
3508 if ( $wgUser->isAllowed( 'minoredit' ) ) {
3510 'tabindex' => ++
$tabindex,
3511 'accesskey' => wfMessage( 'accesskey-minoredit' )->text(),
3512 'id' => 'wpMinoredit',
3514 $checkboxes['minor'] =
3515 Xml
::check( 'wpMinoredit', $checked['minor'], $attribs ) .
3516 " <label for='wpMinoredit' id='mw-editpage-minoredit'" .
3517 Xml
::expandAttributes( array( 'title' => Linker
::titleAttrib( 'minoredit', 'withaccess' ) ) ) .
3518 ">{$minorLabel}</label>";
3522 $watchLabel = wfMessage( 'watchthis' )->parse();
3523 $checkboxes['watch'] = '';
3524 if ( $wgUser->isLoggedIn() ) {
3526 'tabindex' => ++
$tabindex,
3527 'accesskey' => wfMessage( 'accesskey-watch' )->text(),
3528 'id' => 'wpWatchthis',
3530 $checkboxes['watch'] =
3531 Xml
::check( 'wpWatchthis', $checked['watch'], $attribs ) .
3532 " <label for='wpWatchthis' id='mw-editpage-watch'" .
3533 Xml
::expandAttributes( array( 'title' => Linker
::titleAttrib( 'watch', 'withaccess' ) ) ) .
3534 ">{$watchLabel}</label>";
3536 wfRunHooks( 'EditPageBeforeEditChecks', array( &$this, &$checkboxes, &$tabindex ) );
3541 * Returns an array of html code of the following buttons:
3542 * save, diff, preview and live
3544 * @param int $tabindex Current tabindex
3548 public function getEditButtons( &$tabindex ) {
3555 'tabindex' => ++
$tabindex,
3556 'value' => wfMessage( 'savearticle' )->text(),
3557 'accesskey' => wfMessage( 'accesskey-save' )->text(),
3558 'title' => wfMessage( 'tooltip-save' )->text() . ' [' . wfMessage( 'accesskey-save' )->text() . ']',
3560 $buttons['save'] = Xml
::element( 'input', $temp, '' );
3562 ++
$tabindex; // use the same for preview and live preview
3564 'id' => 'wpPreview',
3565 'name' => 'wpPreview',
3567 'tabindex' => $tabindex,
3568 'value' => wfMessage( 'showpreview' )->text(),
3569 'accesskey' => wfMessage( 'accesskey-preview' )->text(),
3570 'title' => wfMessage( 'tooltip-preview' )->text() . ' [' . wfMessage( 'accesskey-preview' )->text() . ']',
3572 $buttons['preview'] = Xml
::element( 'input', $temp, '' );
3573 $buttons['live'] = '';
3579 'tabindex' => ++
$tabindex,
3580 'value' => wfMessage( 'showdiff' )->text(),
3581 'accesskey' => wfMessage( 'accesskey-diff' )->text(),
3582 'title' => wfMessage( 'tooltip-diff' )->text() . ' [' . wfMessage( 'accesskey-diff' )->text() . ']',
3584 $buttons['diff'] = Xml
::element( 'input', $temp, '' );
3586 wfRunHooks( 'EditPageBeforeEditButtons', array( &$this, &$buttons, &$tabindex ) );
3591 * Output preview text only. This can be sucked into the edit page
3592 * via JavaScript, and saves the server time rendering the skin as
3593 * well as theoretically being more robust on the client (doesn't
3594 * disturb the edit box's undo history, won't eat your text on
3597 * @todo This doesn't include category or interlanguage links.
3598 * Would need to enhance it a bit, "<s>maybe wrap them in XML
3599 * or something...</s>" that might also require more skin
3600 * initialization, so check whether that's a problem.
3602 function livePreview() {
3605 header( 'Content-type: text/xml; charset=utf-8' );
3606 header( 'Cache-control: no-cache' );
3608 $previewText = $this->getPreviewText();
3609 #$categories = $skin->getCategoryLinks();
3612 '<?xml version="1.0" encoding="UTF-8" ?>' . "\n" .
3613 Xml
::tags( 'livepreview', null,
3614 Xml
::element( 'preview', null, $previewText )
3615 #. Xml::element( 'category', null, $categories )
3621 * Call the stock "user is blocked" page
3623 * @deprecated in 1.19; throw an exception directly instead
3625 function blockedPage() {
3626 wfDeprecated( __METHOD__
, '1.19' );
3629 throw new UserBlockedError( $wgUser->getBlock() );
3633 * Produce the stock "please login to edit pages" page
3635 * @deprecated in 1.19; throw an exception directly instead
3637 function userNotLoggedInPage() {
3638 wfDeprecated( __METHOD__
, '1.19' );
3639 throw new PermissionsError( 'edit' );
3643 * Show an error page saying to the user that he has insufficient permissions
3644 * to create a new page
3646 * @deprecated in 1.19; throw an exception directly instead
3648 function noCreatePermission() {
3649 wfDeprecated( __METHOD__
, '1.19' );
3650 $permission = $this->mTitle
->isTalkPage() ?
'createtalk' : 'createpage';
3651 throw new PermissionsError( $permission );
3655 * Creates a basic error page which informs the user that
3656 * they have attempted to edit a nonexistent section.
3658 function noSuchSectionPage() {
3661 $wgOut->prepareErrorPage( wfMessage( 'nosuchsectiontitle' ) );
3663 $res = wfMessage( 'nosuchsectiontext', $this->section
)->parseAsBlock();
3664 wfRunHooks( 'EditPageNoSuchSection', array( &$this, &$res ) );
3665 $wgOut->addHTML( $res );
3667 $wgOut->returnToMain( false, $this->mTitle
);
3671 * Show "your edit contains spam" page with your diff and text
3673 * @param $match string|Array|bool Text (or array of texts) which triggered one or more filters
3675 public function spamPageWithContent( $match = false ) {
3676 global $wgOut, $wgLang;
3677 $this->textbox2
= $this->textbox1
;
3679 if ( is_array( $match ) ) {
3680 $match = $wgLang->listToText( $match );
3682 $wgOut->prepareErrorPage( wfMessage( 'spamprotectiontitle' ) );
3684 $wgOut->addHTML( '<div id="spamprotected">' );
3685 $wgOut->addWikiMsg( 'spamprotectiontext' );
3687 $wgOut->addWikiMsg( 'spamprotectionmatch', wfEscapeWikiText( $match ) );
3689 $wgOut->addHTML( '</div>' );
3691 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
3694 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
3695 $this->showTextbox2();
3697 $wgOut->addReturnTo( $this->getContextTitle(), array( 'action' => 'edit' ) );
3701 * Check if the browser is on a blacklist of user-agents known to
3702 * mangle UTF-8 data on form submission. Returns true if Unicode
3703 * should make it through, false if it's known to be a problem.
3706 private function checkUnicodeCompliantBrowser() {
3707 global $wgBrowserBlackList, $wgRequest;
3709 $currentbrowser = $wgRequest->getHeader( 'User-Agent' );
3710 if ( $currentbrowser === false ) {
3711 // No User-Agent header sent? Trust it by default...
3715 foreach ( $wgBrowserBlackList as $browser ) {
3716 if ( preg_match( $browser, $currentbrowser ) ) {
3724 * Filter an input field through a Unicode de-armoring process if it
3725 * came from an old browser with known broken Unicode editing issues.
3727 * @param WebRequest $request
3728 * @param string $field
3731 protected function safeUnicodeInput( $request, $field ) {
3732 $text = rtrim( $request->getText( $field ) );
3733 return $request->getBool( 'safemode' )
3734 ?
$this->unmakeSafe( $text )
3739 * Filter an output field through a Unicode armoring process if it is
3740 * going to an old browser with known broken Unicode editing issues.
3742 * @param string $text
3745 protected function safeUnicodeOutput( $text ) {
3747 $codedText = $wgContLang->recodeForEdit( $text );
3748 return $this->checkUnicodeCompliantBrowser()
3750 : $this->makeSafe( $codedText );
3754 * A number of web browsers are known to corrupt non-ASCII characters
3755 * in a UTF-8 text editing environment. To protect against this,
3756 * detected browsers will be served an armored version of the text,
3757 * with non-ASCII chars converted to numeric HTML character references.
3759 * Preexisting such character references will have a 0 added to them
3760 * to ensure that round-trips do not alter the original data.
3762 * @param string $invalue
3765 private function makeSafe( $invalue ) {
3766 // Armor existing references for reversibility.
3767 $invalue = strtr( $invalue, array( "&#x" => "�" ) );
3772 for ( $i = 0; $i < strlen( $invalue ); $i++
) {
3773 $bytevalue = ord( $invalue[$i] );
3774 if ( $bytevalue <= 0x7F ) { // 0xxx xxxx
3775 $result .= chr( $bytevalue );
3777 } elseif ( $bytevalue <= 0xBF ) { // 10xx xxxx
3778 $working = $working << 6;
3779 $working +
= ( $bytevalue & 0x3F );
3781 if ( $bytesleft <= 0 ) {
3782 $result .= "&#x" . strtoupper( dechex( $working ) ) . ";";
3784 } elseif ( $bytevalue <= 0xDF ) { // 110x xxxx
3785 $working = $bytevalue & 0x1F;
3787 } elseif ( $bytevalue <= 0xEF ) { // 1110 xxxx
3788 $working = $bytevalue & 0x0F;
3790 } else { // 1111 0xxx
3791 $working = $bytevalue & 0x07;
3799 * Reverse the previously applied transliteration of non-ASCII characters
3800 * back to UTF-8. Used to protect data from corruption by broken web browsers
3801 * as listed in $wgBrowserBlackList.
3803 * @param string $invalue
3806 private function unmakeSafe( $invalue ) {
3808 $valueLength = strlen( $invalue );
3809 for ( $i = 0; $i < $valueLength; $i++
) {
3810 if ( ( substr( $invalue, $i, 3 ) == "&#x" ) && ( $invalue[$i +
3] != '0' ) ) {
3814 $hexstring .= $invalue[$i];
3816 } while ( ctype_xdigit( $invalue[$i] ) && ( $i < strlen( $invalue ) ) );
3818 // Do some sanity checks. These aren't needed for reversibility,
3819 // but should help keep the breakage down if the editor
3820 // breaks one of the entities whilst editing.
3821 if ( ( substr( $invalue, $i, 1 ) == ";" ) and ( strlen( $hexstring ) <= 6 ) ) {
3822 $codepoint = hexdec( $hexstring );
3823 $result .= codepointToUtf8( $codepoint );
3825 $result .= "&#x" . $hexstring . substr( $invalue, $i, 1 );
3828 $result .= substr( $invalue, $i, 1 );
3831 // reverse the transform that we made for reversibility reasons.
3832 return strtr( $result, array( "�" => "&#x" ) );