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( $wgUser );
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( $wgUser );
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 * @param User $user The user to get the revision for
1025 * @return Content|null
1027 private function getOriginalContent( User
$user ) {
1028 if ( $this->section
== 'new' ) {
1029 return $this->getCurrentContent();
1031 $revision = $this->mArticle
->getRevisionFetched();
1032 if ( $revision === null ) {
1033 if ( !$this->contentModel
) {
1034 $this->contentModel
= $this->getTitle()->getContentModel();
1036 $handler = ContentHandler
::getForModelID( $this->contentModel
);
1038 return $handler->makeEmptyContent();
1040 $content = $revision->getContent( Revision
::FOR_THIS_USER
, $user );
1045 * Get the current content of the page. This is basically similar to
1046 * WikiPage::getContent( Revision::RAW ) except that when the page doesn't exist an empty
1047 * content object is returned instead of null.
1052 protected function getCurrentContent() {
1053 $rev = $this->mArticle
->getRevision();
1054 $content = $rev ?
$rev->getContent( Revision
::RAW
) : null;
1056 if ( $content === false ||
$content === null ) {
1057 if ( !$this->contentModel
) {
1058 $this->contentModel
= $this->getTitle()->getContentModel();
1060 $handler = ContentHandler
::getForModelID( $this->contentModel
);
1062 return $handler->makeEmptyContent();
1064 # nasty side-effect, but needed for consistency
1065 $this->contentModel
= $rev->getContentModel();
1066 $this->contentFormat
= $rev->getContentFormat();
1073 * Use this method before edit() to preload some text into the edit box
1075 * @param $text string
1076 * @deprecated since 1.21, use setPreloadedContent() instead.
1078 public function setPreloadedText( $text ) {
1079 ContentHandler
::deprecated( __METHOD__
, "1.21" );
1081 $content = $this->toEditContent( $text );
1083 $this->setPreloadedContent( $content );
1087 * Use this method before edit() to preload some content into the edit box
1089 * @param $content Content
1093 public function setPreloadedContent( Content
$content ) {
1094 $this->mPreloadContent
= $content;
1098 * Get the contents to be preloaded into the box, either set by
1099 * an earlier setPreloadText() or by loading the given page.
1101 * @param string $preload representing the title to preload from.
1105 * @deprecated since 1.21, use getPreloadedContent() instead
1107 protected function getPreloadedText( $preload ) {
1108 ContentHandler
::deprecated( __METHOD__
, "1.21" );
1110 $content = $this->getPreloadedContent( $preload );
1111 $text = $this->toEditText( $content );
1117 * Get the contents to be preloaded into the box, either set by
1118 * an earlier setPreloadText() or by loading the given page.
1120 * @param string $preload representing the title to preload from.
1121 * @param Array $params Parameters to use (interface-message style) in the preloaded text
1127 protected function getPreloadedContent( $preload, $params = array() ) {
1130 if ( !empty( $this->mPreloadContent
) ) {
1131 return $this->mPreloadContent
;
1134 $handler = ContentHandler
::getForTitle( $this->getTitle() );
1136 if ( $preload === '' ) {
1137 return $handler->makeEmptyContent();
1140 $title = Title
::newFromText( $preload );
1141 # Check for existence to avoid getting MediaWiki:Noarticletext
1142 if ( $title === null ||
!$title->exists() ||
!$title->userCan( 'read', $wgUser ) ) {
1143 //TODO: somehow show a warning to the user!
1144 return $handler->makeEmptyContent();
1147 $page = WikiPage
::factory( $title );
1148 if ( $page->isRedirect() ) {
1149 $title = $page->getRedirectTarget();
1151 if ( $title === null ||
!$title->exists() ||
!$title->userCan( 'read', $wgUser ) ) {
1152 //TODO: somehow show a warning to the user!
1153 return $handler->makeEmptyContent();
1155 $page = WikiPage
::factory( $title );
1158 $parserOptions = ParserOptions
::newFromUser( $wgUser );
1159 $content = $page->getContent( Revision
::RAW
);
1162 //TODO: somehow show a warning to the user!
1163 return $handler->makeEmptyContent();
1166 if ( $content->getModel() !== $handler->getModelID() ) {
1167 $converted = $content->convert( $handler->getModelID() );
1169 if ( !$converted ) {
1170 //TODO: somehow show a warning to the user!
1171 wfDebug( "Attempt to preload incompatible content: "
1172 . "can't convert " . $content->getModel()
1173 . " to " . $handler->getModelID() );
1175 return $handler->makeEmptyContent();
1178 $content = $converted;
1181 return $content->preloadTransform( $title, $parserOptions, $params );
1185 * Make sure the form isn't faking a user's credentials.
1187 * @param $request WebRequest
1191 function tokenOk( &$request ) {
1193 $token = $request->getVal( 'wpEditToken' );
1194 $this->mTokenOk
= $wgUser->matchEditToken( $token );
1195 $this->mTokenOkExceptSuffix
= $wgUser->matchEditTokenNoSuffix( $token );
1196 return $this->mTokenOk
;
1200 * Sets post-edit cookie indicating the user just saved a particular revision.
1202 * This uses a temporary cookie for each revision ID so separate saves will never
1203 * interfere with each other.
1205 * The cookie is deleted in the mediawiki.action.view.postEdit JS module after
1206 * the redirect. It must be clearable by JavaScript code, so it must not be
1207 * marked HttpOnly. The JavaScript code converts the cookie to a wgPostEdit config
1210 * We use a path of '/' since wgCookiePath is not exposed to JS
1212 * If the variable were set on the server, it would be cached, which is unwanted
1213 * since the post-edit state should only apply to the load right after the save.
1215 protected function setPostEditCookie() {
1216 $revisionId = $this->mArticle
->getLatest();
1217 $postEditKey = self
::POST_EDIT_COOKIE_KEY_PREFIX
. $revisionId;
1219 $response = RequestContext
::getMain()->getRequest()->response();
1220 $response->setcookie( $postEditKey, '1', time() + self
::POST_EDIT_COOKIE_DURATION
, array(
1222 'httpOnly' => false,
1227 * Attempt submission
1228 * @throws UserBlockedError|ReadOnlyError|ThrottledError|PermissionsError
1229 * @return bool false if output is done, true if the rest of the form should be displayed
1231 public function attemptSave() {
1234 $resultDetails = false;
1235 # Allow bots to exempt some edits from bot flagging
1236 $bot = $wgUser->isAllowed( 'bot' ) && $this->bot
;
1237 $status = $this->internalAttemptSave( $resultDetails, $bot );
1239 return $this->handleStatus( $status, $resultDetails );
1243 * Handle status, such as after attempt save
1245 * @param Status $status
1246 * @param array|bool $resultDetails
1248 * @throws ErrorPageError
1249 * return bool false, if output is done, true if rest of the form should be displayed
1251 private function handleStatus( Status
$status, $resultDetails ) {
1252 global $wgUser, $wgOut;
1254 // FIXME: once the interface for internalAttemptSave() is made nicer, this should use the message in $status
1255 if ( $status->value
== self
::AS_SUCCESS_UPDATE ||
$status->value
== self
::AS_SUCCESS_NEW_ARTICLE
) {
1256 $this->didSave
= true;
1257 if ( !$resultDetails['nullEdit'] ) {
1258 $this->setPostEditCookie();
1262 switch ( $status->value
) {
1263 case self
::AS_HOOK_ERROR_EXPECTED
:
1264 case self
::AS_CONTENT_TOO_BIG
:
1265 case self
::AS_ARTICLE_WAS_DELETED
:
1266 case self
::AS_CONFLICT_DETECTED
:
1267 case self
::AS_SUMMARY_NEEDED
:
1268 case self
::AS_TEXTBOX_EMPTY
:
1269 case self
::AS_MAX_ARTICLE_SIZE_EXCEEDED
:
1273 case self
::AS_HOOK_ERROR
:
1276 case self
::AS_PARSE_ERROR
:
1277 $wgOut->addWikiText( '<div class="error">' . $status->getWikiText() . '</div>' );
1280 case self
::AS_SUCCESS_NEW_ARTICLE
:
1281 $query = $resultDetails['redirect'] ?
'redirect=no' : '';
1282 $anchor = isset( $resultDetails['sectionanchor'] ) ?
$resultDetails['sectionanchor'] : '';
1283 $wgOut->redirect( $this->mTitle
->getFullURL( $query ) . $anchor );
1286 case self
::AS_SUCCESS_UPDATE
:
1288 $sectionanchor = $resultDetails['sectionanchor'];
1290 // Give extensions a chance to modify URL query on update
1291 wfRunHooks( 'ArticleUpdateBeforeRedirect', array( $this->mArticle
, &$sectionanchor, &$extraQuery ) );
1293 if ( $resultDetails['redirect'] ) {
1294 if ( $extraQuery == '' ) {
1295 $extraQuery = 'redirect=no';
1297 $extraQuery = 'redirect=no&' . $extraQuery;
1300 $wgOut->redirect( $this->mTitle
->getFullURL( $extraQuery ) . $sectionanchor );
1303 case self
::AS_BLANK_ARTICLE
:
1304 $wgOut->redirect( $this->getContextTitle()->getFullURL() );
1307 case self
::AS_SPAM_ERROR
:
1308 $this->spamPageWithContent( $resultDetails['spam'] );
1311 case self
::AS_BLOCKED_PAGE_FOR_USER
:
1312 throw new UserBlockedError( $wgUser->getBlock() );
1314 case self
::AS_IMAGE_REDIRECT_ANON
:
1315 case self
::AS_IMAGE_REDIRECT_LOGGED
:
1316 throw new PermissionsError( 'upload' );
1318 case self
::AS_READ_ONLY_PAGE_ANON
:
1319 case self
::AS_READ_ONLY_PAGE_LOGGED
:
1320 throw new PermissionsError( 'edit' );
1322 case self
::AS_READ_ONLY_PAGE
:
1323 throw new ReadOnlyError
;
1325 case self
::AS_RATE_LIMITED
:
1326 throw new ThrottledError();
1328 case self
::AS_NO_CREATE_PERMISSION
:
1329 $permission = $this->mTitle
->isTalkPage() ?
'createtalk' : 'createpage';
1330 throw new PermissionsError( $permission );
1333 // We don't recognize $status->value. The only way that can happen
1334 // is if an extension hook aborted from inside ArticleSave.
1335 // Render the status object into $this->hookError
1336 // FIXME this sucks, we should just use the Status object throughout
1337 $this->hookError
= '<div class="error">' . $status->getWikitext() .
1344 * Run hooks that can filter edits just before they get saved.
1346 * @param Content $content the Content to filter.
1347 * @param Status $status For reporting the outcome to the caller
1348 * @param User $user The user performing the edit
1352 protected function runPostMergeFilters( Content
$content, Status
$status, User
$user ) {
1353 // Run old style post-section-merge edit filter
1354 if ( !ContentHandler
::runLegacyHooks( 'EditFilterMerged',
1355 array( $this, $content, &$this->hookError
, $this->summary
) ) ) {
1357 # Error messages etc. could be handled within the hook...
1358 $status->fatal( 'hookaborted' );
1359 $status->value
= self
::AS_HOOK_ERROR
;
1361 } elseif ( $this->hookError
!= '' ) {
1362 # ...or the hook could be expecting us to produce an error
1363 $status->fatal( 'hookaborted' );
1364 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1368 // Run new style post-section-merge edit filter
1369 if ( !wfRunHooks( 'EditFilterMergedContent',
1370 array( $this->mArticle
->getContext(), $content, $status, $this->summary
,
1371 $user, $this->minoredit
) ) ) {
1373 # Error messages etc. could be handled within the hook...
1374 // XXX: $status->value may already be something informative...
1375 $this->hookError
= $status->getWikiText();
1376 $status->fatal( 'hookaborted' );
1377 $status->value
= self
::AS_HOOK_ERROR
;
1379 } elseif ( !$status->isOK() ) {
1380 # ...or the hook could be expecting us to produce an error
1381 // FIXME this sucks, we should just use the Status object throughout
1382 $this->hookError
= $status->getWikiText();
1383 $status->fatal( 'hookaborted' );
1384 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1392 * Attempt submission (no UI)
1394 * @param array $result array to add statuses to, currently with the possible keys:
1395 * spam - string - Spam string from content if any spam is detected by matchSpamRegex
1396 * sectionanchor - string - Section anchor for a section save
1397 * nullEdit - boolean - Set if doEditContent is OK. True if null edit, false otherwise.
1398 * redirect - boolean - Set if doEditContent is OK. True if resulting revision is a redirect
1399 * @param bool $bot True if edit is being made under the bot right.
1401 * @return Status object, possibly with a message, but always with one of the AS_* constants in $status->value,
1403 * FIXME: This interface is TERRIBLE, but hard to get rid of due to various error display idiosyncrasies. There are
1404 * also lots of cases where error metadata is set in the object and retrieved later instead of being returned, e.g.
1405 * AS_CONTENT_TOO_BIG and AS_BLOCKED_PAGE_FOR_USER. All that stuff needs to be cleaned up some time.
1407 function internalAttemptSave( &$result, $bot = false ) {
1408 global $wgUser, $wgRequest, $wgParser, $wgMaxArticleSize;
1410 $status = Status
::newGood();
1412 wfProfileIn( __METHOD__
);
1413 wfProfileIn( __METHOD__
. '-checks' );
1415 if ( !wfRunHooks( 'EditPage::attemptSave', array( $this ) ) ) {
1416 wfDebug( "Hook 'EditPage::attemptSave' aborted article saving\n" );
1417 $status->fatal( 'hookaborted' );
1418 $status->value
= self
::AS_HOOK_ERROR
;
1419 wfProfileOut( __METHOD__
. '-checks' );
1420 wfProfileOut( __METHOD__
);
1424 $spam = $wgRequest->getText( 'wpAntispam' );
1425 if ( $spam !== '' ) {
1428 $wgUser->getName() .
1430 $this->mTitle
->getPrefixedText() .
1431 '" submitted bogus field "' .
1435 $status->fatal( 'spamprotectionmatch', false );
1436 $status->value
= self
::AS_SPAM_ERROR
;
1437 wfProfileOut( __METHOD__
. '-checks' );
1438 wfProfileOut( __METHOD__
);
1443 # Construct Content object
1444 $textbox_content = $this->toEditContent( $this->textbox1
);
1445 } catch ( MWContentSerializationException
$ex ) {
1446 $status->fatal( 'content-failed-to-parse', $this->contentModel
, $this->contentFormat
, $ex->getMessage() );
1447 $status->value
= self
::AS_PARSE_ERROR
;
1448 wfProfileOut( __METHOD__
. '-checks' );
1449 wfProfileOut( __METHOD__
);
1453 # Check image redirect
1454 if ( $this->mTitle
->getNamespace() == NS_FILE
&&
1455 $textbox_content->isRedirect() &&
1456 !$wgUser->isAllowed( 'upload' ) ) {
1457 $code = $wgUser->isAnon() ? self
::AS_IMAGE_REDIRECT_ANON
: self
::AS_IMAGE_REDIRECT_LOGGED
;
1458 $status->setResult( false, $code );
1460 wfProfileOut( __METHOD__
. '-checks' );
1461 wfProfileOut( __METHOD__
);
1467 $match = self
::matchSummarySpamRegex( $this->summary
);
1468 if ( $match === false && $this->section
== 'new' ) {
1469 # $wgSpamRegex is enforced on this new heading/summary because, unlike
1470 # regular summaries, it is added to the actual wikitext.
1471 if ( $this->sectiontitle
!== '' ) {
1472 # This branch is taken when the API is used with the 'sectiontitle' parameter.
1473 $match = self
::matchSpamRegex( $this->sectiontitle
);
1475 # This branch is taken when the "Add Topic" user interface is used, or the API
1476 # is used with the 'summary' parameter.
1477 $match = self
::matchSpamRegex( $this->summary
);
1480 if ( $match === false ) {
1481 $match = self
::matchSpamRegex( $this->textbox1
);
1483 if ( $match !== false ) {
1484 $result['spam'] = $match;
1485 $ip = $wgRequest->getIP();
1486 $pdbk = $this->mTitle
->getPrefixedDBkey();
1487 $match = str_replace( "\n", '', $match );
1488 wfDebugLog( 'SpamRegex', "$ip spam regex hit [[$pdbk]]: \"$match\"" );
1489 $status->fatal( 'spamprotectionmatch', $match );
1490 $status->value
= self
::AS_SPAM_ERROR
;
1491 wfProfileOut( __METHOD__
. '-checks' );
1492 wfProfileOut( __METHOD__
);
1495 if ( !wfRunHooks( 'EditFilter', array( $this, $this->textbox1
, $this->section
, &$this->hookError
, $this->summary
) ) ) {
1496 # Error messages etc. could be handled within the hook...
1497 $status->fatal( 'hookaborted' );
1498 $status->value
= self
::AS_HOOK_ERROR
;
1499 wfProfileOut( __METHOD__
. '-checks' );
1500 wfProfileOut( __METHOD__
);
1502 } elseif ( $this->hookError
!= '' ) {
1503 # ...or the hook could be expecting us to produce an error
1504 $status->fatal( 'hookaborted' );
1505 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1506 wfProfileOut( __METHOD__
. '-checks' );
1507 wfProfileOut( __METHOD__
);
1511 if ( $wgUser->isBlockedFrom( $this->mTitle
, false ) ) {
1512 // Auto-block user's IP if the account was "hard" blocked
1513 $wgUser->spreadAnyEditBlock();
1514 # Check block state against master, thus 'false'.
1515 $status->setResult( false, self
::AS_BLOCKED_PAGE_FOR_USER
);
1516 wfProfileOut( __METHOD__
. '-checks' );
1517 wfProfileOut( __METHOD__
);
1521 $this->kblength
= (int)( strlen( $this->textbox1
) / 1024 );
1522 if ( $this->kblength
> $wgMaxArticleSize ) {
1523 // Error will be displayed by showEditForm()
1524 $this->tooBig
= true;
1525 $status->setResult( false, self
::AS_CONTENT_TOO_BIG
);
1526 wfProfileOut( __METHOD__
. '-checks' );
1527 wfProfileOut( __METHOD__
);
1531 if ( !$wgUser->isAllowed( 'edit' ) ) {
1532 if ( $wgUser->isAnon() ) {
1533 $status->setResult( false, self
::AS_READ_ONLY_PAGE_ANON
);
1534 wfProfileOut( __METHOD__
. '-checks' );
1535 wfProfileOut( __METHOD__
);
1538 $status->fatal( 'readonlytext' );
1539 $status->value
= self
::AS_READ_ONLY_PAGE_LOGGED
;
1540 wfProfileOut( __METHOD__
. '-checks' );
1541 wfProfileOut( __METHOD__
);
1546 if ( wfReadOnly() ) {
1547 $status->fatal( 'readonlytext' );
1548 $status->value
= self
::AS_READ_ONLY_PAGE
;
1549 wfProfileOut( __METHOD__
. '-checks' );
1550 wfProfileOut( __METHOD__
);
1553 if ( $wgUser->pingLimiter() ||
$wgUser->pingLimiter( 'linkpurge', 0 ) ) {
1554 $status->fatal( 'actionthrottledtext' );
1555 $status->value
= self
::AS_RATE_LIMITED
;
1556 wfProfileOut( __METHOD__
. '-checks' );
1557 wfProfileOut( __METHOD__
);
1561 # If the article has been deleted while editing, don't save it without
1563 if ( $this->wasDeletedSinceLastEdit() && !$this->recreate
) {
1564 $status->setResult( false, self
::AS_ARTICLE_WAS_DELETED
);
1565 wfProfileOut( __METHOD__
. '-checks' );
1566 wfProfileOut( __METHOD__
);
1570 wfProfileOut( __METHOD__
. '-checks' );
1572 # Load the page data from the master. If anything changes in the meantime,
1573 # we detect it by using page_latest like a token in a 1 try compare-and-swap.
1574 $this->mArticle
->loadPageData( 'fromdbmaster' );
1575 $new = !$this->mArticle
->exists();
1578 // Late check for create permission, just in case *PARANOIA*
1579 if ( !$this->mTitle
->userCan( 'create', $wgUser ) ) {
1580 $status->fatal( 'nocreatetext' );
1581 $status->value
= self
::AS_NO_CREATE_PERMISSION
;
1582 wfDebug( __METHOD__
. ": no create permission\n" );
1583 wfProfileOut( __METHOD__
);
1587 // Don't save a new page if it's blank or if it's a MediaWiki:
1588 // message with content equivalent to default (allow empty pages
1589 // in this case to disable messages, see bug 50124)
1590 $defaultMessageText = $this->mTitle
->getDefaultMessageText();
1591 if ( $this->mTitle
->getNamespace() === NS_MEDIAWIKI
&& $defaultMessageText !== false ) {
1592 $defaultText = $defaultMessageText;
1597 if ( $this->textbox1
=== $defaultText ) {
1598 $status->setResult( false, self
::AS_BLANK_ARTICLE
);
1599 wfProfileOut( __METHOD__
);
1603 if ( !$this->runPostMergeFilters( $textbox_content, $status, $wgUser ) ) {
1604 wfProfileOut( __METHOD__
);
1608 $content = $textbox_content;
1610 $result['sectionanchor'] = '';
1611 if ( $this->section
== 'new' ) {
1612 if ( $this->sectiontitle
!== '' ) {
1613 // Insert the section title above the content.
1614 $content = $content->addSectionHeader( $this->sectiontitle
);
1616 // Jump to the new section
1617 $result['sectionanchor'] = $wgParser->guessLegacySectionNameFromWikiText( $this->sectiontitle
);
1619 // If no edit summary was specified, create one automatically from the section
1620 // title and have it link to the new section. Otherwise, respect the summary as
1622 if ( $this->summary
=== '' ) {
1623 $cleanSectionTitle = $wgParser->stripSectionName( $this->sectiontitle
);
1624 $this->summary
= wfMessage( 'newsectionsummary' )
1625 ->rawParams( $cleanSectionTitle )->inContentLanguage()->text();
1627 } elseif ( $this->summary
!== '' ) {
1628 // Insert the section title above the content.
1629 $content = $content->addSectionHeader( $this->summary
);
1631 // Jump to the new section
1632 $result['sectionanchor'] = $wgParser->guessLegacySectionNameFromWikiText( $this->summary
);
1634 // Create a link to the new section from the edit summary.
1635 $cleanSummary = $wgParser->stripSectionName( $this->summary
);
1636 $this->summary
= wfMessage( 'newsectionsummary' )
1637 ->rawParams( $cleanSummary )->inContentLanguage()->text();
1641 $status->value
= self
::AS_SUCCESS_NEW_ARTICLE
;
1645 # Article exists. Check for edit conflict.
1647 $this->mArticle
->clear(); # Force reload of dates, etc.
1648 $timestamp = $this->mArticle
->getTimestamp();
1650 wfDebug( "timestamp: {$timestamp}, edittime: {$this->edittime}\n" );
1652 if ( $timestamp != $this->edittime
) {
1653 $this->isConflict
= true;
1654 if ( $this->section
== 'new' ) {
1655 if ( $this->mArticle
->getUserText() == $wgUser->getName() &&
1656 $this->mArticle
->getComment() == $this->summary
) {
1657 // Probably a duplicate submission of a new comment.
1658 // This can happen when squid resends a request after
1659 // a timeout but the first one actually went through.
1660 wfDebug( __METHOD__
. ": duplicate new section submission; trigger edit conflict!\n" );
1662 // New comment; suppress conflict.
1663 $this->isConflict
= false;
1664 wfDebug( __METHOD__
. ": conflict suppressed; new section\n" );
1666 } elseif ( $this->section
== '' && Revision
::userWasLastToEdit( DB_MASTER
, $this->mTitle
->getArticleID(),
1667 $wgUser->getId(), $this->edittime
) ) {
1668 # Suppress edit conflict with self, except for section edits where merging is required.
1669 wfDebug( __METHOD__
. ": Suppressing edit conflict, same user.\n" );
1670 $this->isConflict
= false;
1674 // If sectiontitle is set, use it, otherwise use the summary as the section title.
1675 if ( $this->sectiontitle
!== '' ) {
1676 $sectionTitle = $this->sectiontitle
;
1678 $sectionTitle = $this->summary
;
1683 if ( $this->isConflict
) {
1684 wfDebug( __METHOD__
. ": conflict! getting section '{$this->section}' for time '{$this->edittime}'"
1685 . " (article time '{$timestamp}')\n" );
1687 $content = $this->mArticle
->replaceSectionContent( $this->section
, $textbox_content, $sectionTitle, $this->edittime
);
1689 wfDebug( __METHOD__
. ": getting section '{$this->section}'\n" );
1690 $content = $this->mArticle
->replaceSectionContent( $this->section
, $textbox_content, $sectionTitle );
1693 if ( is_null( $content ) ) {
1694 wfDebug( __METHOD__
. ": activating conflict; section replace failed.\n" );
1695 $this->isConflict
= true;
1696 $content = $textbox_content; // do not try to merge here!
1697 } elseif ( $this->isConflict
) {
1699 if ( $this->mergeChangesIntoContent( $content ) ) {
1700 // Successful merge! Maybe we should tell the user the good news?
1701 $this->isConflict
= false;
1702 wfDebug( __METHOD__
. ": Suppressing edit conflict, successful merge.\n" );
1704 $this->section
= '';
1705 $this->textbox1
= ContentHandler
::getContentText( $content );
1706 wfDebug( __METHOD__
. ": Keeping edit conflict, failed merge.\n" );
1710 if ( $this->isConflict
) {
1711 $status->setResult( false, self
::AS_CONFLICT_DETECTED
);
1712 wfProfileOut( __METHOD__
);
1716 if ( !$this->runPostMergeFilters( $content, $status, $wgUser ) ) {
1717 wfProfileOut( __METHOD__
);
1721 if ( $this->section
== 'new' ) {
1722 // Handle the user preference to force summaries here
1723 if ( !$this->allowBlankSummary
&& trim( $this->summary
) == '' ) {
1724 $this->missingSummary
= true;
1725 $status->fatal( 'missingsummary' ); // or 'missingcommentheader' if $section == 'new'. Blegh
1726 $status->value
= self
::AS_SUMMARY_NEEDED
;
1727 wfProfileOut( __METHOD__
);
1731 // Do not allow the user to post an empty comment
1732 if ( $this->textbox1
== '' ) {
1733 $this->missingComment
= true;
1734 $status->fatal( 'missingcommenttext' );
1735 $status->value
= self
::AS_TEXTBOX_EMPTY
;
1736 wfProfileOut( __METHOD__
);
1739 } elseif ( !$this->allowBlankSummary
1740 && !$content->equals( $this->getOriginalContent( $wgUser ) )
1741 && !$content->isRedirect()
1742 && md5( $this->summary
) == $this->autoSumm
1744 $this->missingSummary
= true;
1745 $status->fatal( 'missingsummary' );
1746 $status->value
= self
::AS_SUMMARY_NEEDED
;
1747 wfProfileOut( __METHOD__
);
1752 wfProfileIn( __METHOD__
. '-sectionanchor' );
1753 $sectionanchor = '';
1754 if ( $this->section
== 'new' ) {
1755 if ( $this->sectiontitle
!== '' ) {
1756 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $this->sectiontitle
);
1757 // If no edit summary was specified, create one automatically from the section
1758 // title and have it link to the new section. Otherwise, respect the summary as
1760 if ( $this->summary
=== '' ) {
1761 $cleanSectionTitle = $wgParser->stripSectionName( $this->sectiontitle
);
1762 $this->summary
= wfMessage( 'newsectionsummary' )
1763 ->rawParams( $cleanSectionTitle )->inContentLanguage()->text();
1765 } elseif ( $this->summary
!== '' ) {
1766 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $this->summary
);
1767 # This is a new section, so create a link to the new section
1768 # in the revision summary.
1769 $cleanSummary = $wgParser->stripSectionName( $this->summary
);
1770 $this->summary
= wfMessage( 'newsectionsummary' )
1771 ->rawParams( $cleanSummary )->inContentLanguage()->text();
1773 } elseif ( $this->section
!= '' ) {
1774 # Try to get a section anchor from the section source, redirect to edited section if header found
1775 # XXX: might be better to integrate this into Article::replaceSection
1776 # for duplicate heading checking and maybe parsing
1777 $hasmatch = preg_match( "/^ *([=]{1,6})(.*?)(\\1) *\\n/i", $this->textbox1
, $matches );
1778 # we can't deal with anchors, includes, html etc in the header for now,
1779 # headline would need to be parsed to improve this
1780 if ( $hasmatch && strlen( $matches[2] ) > 0 ) {
1781 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $matches[2] );
1784 $result['sectionanchor'] = $sectionanchor;
1785 wfProfileOut( __METHOD__
. '-sectionanchor' );
1787 // Save errors may fall down to the edit form, but we've now
1788 // merged the section into full text. Clear the section field
1789 // so that later submission of conflict forms won't try to
1790 // replace that into a duplicated mess.
1791 $this->textbox1
= $this->toEditText( $content );
1792 $this->section
= '';
1794 $status->value
= self
::AS_SUCCESS_UPDATE
;
1797 // Check for length errors again now that the section is merged in
1798 $this->kblength
= (int)( strlen( $this->toEditText( $content ) ) / 1024 );
1799 if ( $this->kblength
> $wgMaxArticleSize ) {
1800 $this->tooBig
= true;
1801 $status->setResult( false, self
::AS_MAX_ARTICLE_SIZE_EXCEEDED
);
1802 wfProfileOut( __METHOD__
);
1806 $flags = EDIT_DEFER_UPDATES | EDIT_AUTOSUMMARY |
1807 ( $new ? EDIT_NEW
: EDIT_UPDATE
) |
1808 ( ( $this->minoredit
&& !$this->isNew
) ? EDIT_MINOR
: 0 ) |
1809 ( $bot ? EDIT_FORCE_BOT
: 0 );
1811 $doEditStatus = $this->mArticle
->doEditContent( $content, $this->summary
, $flags,
1812 false, null, $this->contentFormat
);
1814 if ( !$doEditStatus->isOK() ) {
1815 // Failure from doEdit()
1816 // Show the edit conflict page for certain recognized errors from doEdit(),
1817 // but don't show it for errors from extension hooks
1818 $errors = $doEditStatus->getErrorsArray();
1819 if ( in_array( $errors[0][0],
1820 array( 'edit-gone-missing', 'edit-conflict', 'edit-already-exists' ) )
1822 $this->isConflict
= true;
1823 // Destroys data doEdit() put in $status->value but who cares
1824 $doEditStatus->value
= self
::AS_END
;
1826 wfProfileOut( __METHOD__
);
1827 return $doEditStatus;
1830 $result['nullEdit'] = $doEditStatus->hasMessage( 'edit-no-change' );
1831 if ( $result['nullEdit'] ) {
1832 // We don't know if it was a null edit until now, so increment here
1833 $wgUser->pingLimiter( 'linkpurge' );
1835 $result['redirect'] = $content->isRedirect();
1836 $this->updateWatchlist();
1837 wfProfileOut( __METHOD__
);
1842 * Register the change of watch status
1844 protected function updateWatchlist() {
1847 if ( $wgUser->isLoggedIn()
1848 && $this->watchthis
!= $wgUser->isWatched( $this->mTitle
, WatchedItem
::IGNORE_USER_RIGHTS
)
1850 $fname = __METHOD__
;
1851 $title = $this->mTitle
;
1852 $watch = $this->watchthis
;
1854 // Do this in its own transaction to reduce contention...
1855 $dbw = wfGetDB( DB_MASTER
);
1856 $dbw->onTransactionIdle( function() use ( $dbw, $title, $watch, $wgUser, $fname ) {
1857 $dbw->begin( $fname );
1858 WatchAction
::doWatchOrUnwatch( $watch, $title, $wgUser );
1859 $dbw->commit( $fname );
1865 * Attempts to merge text content with base and current revisions
1867 * @param $editText string
1870 * @deprecated since 1.21, use mergeChangesIntoContent() instead
1872 function mergeChangesInto( &$editText ) {
1873 ContentHandler
::deprecated( __METHOD__
, "1.21" );
1875 $editContent = $this->toEditContent( $editText );
1877 $ok = $this->mergeChangesIntoContent( $editContent );
1880 $editText = $this->toEditText( $editContent );
1887 * Attempts to do 3-way merge of edit content with a base revision
1888 * and current content, in case of edit conflict, in whichever way appropriate
1889 * for the content type.
1893 * @param $editContent
1897 private function mergeChangesIntoContent( &$editContent ) {
1898 wfProfileIn( __METHOD__
);
1900 $db = wfGetDB( DB_MASTER
);
1902 // This is the revision the editor started from
1903 $baseRevision = $this->getBaseRevision();
1904 $baseContent = $baseRevision ?
$baseRevision->getContent() : null;
1906 if ( is_null( $baseContent ) ) {
1907 wfProfileOut( __METHOD__
);
1911 // The current state, we want to merge updates into it
1912 $currentRevision = Revision
::loadFromTitle( $db, $this->mTitle
);
1913 $currentContent = $currentRevision ?
$currentRevision->getContent() : null;
1915 if ( is_null( $currentContent ) ) {
1916 wfProfileOut( __METHOD__
);
1920 $handler = ContentHandler
::getForModelID( $baseContent->getModel() );
1922 $result = $handler->merge3( $baseContent, $editContent, $currentContent );
1925 $editContent = $result;
1926 wfProfileOut( __METHOD__
);
1930 wfProfileOut( __METHOD__
);
1937 function getBaseRevision() {
1938 if ( !$this->mBaseRevision
) {
1939 $db = wfGetDB( DB_MASTER
);
1940 $this->mBaseRevision
= Revision
::loadFromTimestamp(
1941 $db, $this->mTitle
, $this->edittime
);
1943 return $this->mBaseRevision
;
1947 * Check given input text against $wgSpamRegex, and return the text of the first match.
1949 * @param $text string
1951 * @return string|bool matching string or false
1953 public static function matchSpamRegex( $text ) {
1954 global $wgSpamRegex;
1955 // For back compatibility, $wgSpamRegex may be a single string or an array of regexes.
1956 $regexes = (array)$wgSpamRegex;
1957 return self
::matchSpamRegexInternal( $text, $regexes );
1961 * Check given input text against $wgSummarySpamRegex, and return the text of the first match.
1963 * @param $text string
1965 * @return string|bool matching string or false
1967 public static function matchSummarySpamRegex( $text ) {
1968 global $wgSummarySpamRegex;
1969 $regexes = (array)$wgSummarySpamRegex;
1970 return self
::matchSpamRegexInternal( $text, $regexes );
1974 * @param $text string
1975 * @param $regexes array
1976 * @return bool|string
1978 protected static function matchSpamRegexInternal( $text, $regexes ) {
1979 foreach ( $regexes as $regex ) {
1981 if ( preg_match( $regex, $text, $matches ) ) {
1988 function setHeaders() {
1989 global $wgOut, $wgUser;
1991 $wgOut->addModules( 'mediawiki.action.edit' );
1992 $wgOut->addModuleStyles( 'mediawiki.action.edit.styles' );
1994 if ( $wgUser->getOption( 'uselivepreview', false ) ) {
1995 $wgOut->addModules( 'mediawiki.action.edit.preview' );
1998 if ( $wgUser->getOption( 'useeditwarning', false ) ) {
1999 $wgOut->addModules( 'mediawiki.action.edit.editWarning' );
2002 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2004 # Enabled article-related sidebar, toplinks, etc.
2005 $wgOut->setArticleRelated( true );
2007 $contextTitle = $this->getContextTitle();
2008 if ( $this->isConflict
) {
2009 $msg = 'editconflict';
2010 } elseif ( $contextTitle->exists() && $this->section
!= '' ) {
2011 $msg = $this->section
== 'new' ?
'editingcomment' : 'editingsection';
2013 $msg = $contextTitle->exists() ||
( $contextTitle->getNamespace() == NS_MEDIAWIKI
&& $contextTitle->getDefaultMessageText() !== false ) ?
2014 'editing' : 'creating';
2016 # Use the title defined by DISPLAYTITLE magic word when present
2017 $displayTitle = isset( $this->mParserOutput
) ?
$this->mParserOutput
->getDisplayTitle() : false;
2018 if ( $displayTitle === false ) {
2019 $displayTitle = $contextTitle->getPrefixedText();
2021 $wgOut->setPageTitle( wfMessage( $msg, $displayTitle ) );
2025 * Show all applicable editing introductions
2027 protected function showIntro() {
2028 global $wgOut, $wgUser;
2029 if ( $this->suppressIntro
) {
2033 $namespace = $this->mTitle
->getNamespace();
2035 if ( $namespace == NS_MEDIAWIKI
) {
2036 # Show a warning if editing an interface message
2037 $wgOut->wrapWikiMsg( "<div class='mw-editinginterface'>\n$1\n</div>", 'editinginterface' );
2038 } elseif ( $namespace == NS_FILE
) {
2039 # Show a hint to shared repo
2040 $file = wfFindFile( $this->mTitle
);
2041 if ( $file && !$file->isLocal() ) {
2042 $descUrl = $file->getDescriptionUrl();
2043 # there must be a description url to show a hint to shared repo
2045 if ( !$this->mTitle
->exists() ) {
2046 $wgOut->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-create\">\n$1\n</div>", array(
2047 'sharedupload-desc-create', $file->getRepo()->getDisplayName(), $descUrl
2050 $wgOut->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-edit\">\n$1\n</div>", array(
2051 'sharedupload-desc-edit', $file->getRepo()->getDisplayName(), $descUrl
2058 # Show a warning message when someone creates/edits a user (talk) page but the user does not exist
2059 # Show log extract when the user is currently blocked
2060 if ( $namespace == NS_USER ||
$namespace == NS_USER_TALK
) {
2061 $parts = explode( '/', $this->mTitle
->getText(), 2 );
2062 $username = $parts[0];
2063 $user = User
::newFromName( $username, false /* allow IP users*/ );
2064 $ip = User
::isIP( $username );
2065 if ( !( $user && $user->isLoggedIn() ) && !$ip ) { # User does not exist
2066 $wgOut->wrapWikiMsg( "<div class=\"mw-userpage-userdoesnotexist error\">\n$1\n</div>",
2067 array( 'userpage-userdoesnotexist', wfEscapeWikiText( $username ) ) );
2068 } elseif ( $user->isBlocked() ) { # Show log extract if the user is currently blocked
2069 LogEventsList
::showLogExtract(
2072 $user->getUserPage(),
2076 'showIfEmpty' => false,
2078 'blocked-notice-logextract',
2079 $user->getName() # Support GENDER in notice
2085 # Try to add a custom edit intro, or use the standard one if this is not possible.
2086 if ( !$this->showCustomIntro() && !$this->mTitle
->exists() ) {
2087 $helpLink = wfExpandUrl( Skin
::makeInternalOrExternalUrl(
2088 wfMessage( 'helppage' )->inContentLanguage()->text()
2090 if ( $wgUser->isLoggedIn() ) {
2091 $wgOut->wrapWikiMsg(
2092 // Suppress the external link icon, consider the help url an internal one
2093 "<div class=\"mw-newarticletext plainlinks\">\n$1\n</div>",
2100 $wgOut->wrapWikiMsg(
2101 // Suppress the external link icon, consider the help url an internal one
2102 "<div class=\"mw-newarticletextanon plainlinks\">\n$1\n</div>",
2104 'newarticletextanon',
2110 # Give a notice if the user is editing a deleted/moved page...
2111 if ( !$this->mTitle
->exists() ) {
2112 LogEventsList
::showLogExtract( $wgOut, array( 'delete', 'move' ), $this->mTitle
,
2116 'conds' => array( "log_action != 'revision'" ),
2117 'showIfEmpty' => false,
2118 'msgKey' => array( 'recreate-moveddeleted-warn' )
2125 * Attempt to show a custom editing introduction, if supplied
2129 protected function showCustomIntro() {
2130 if ( $this->editintro
) {
2131 $title = Title
::newFromText( $this->editintro
);
2132 if ( $title instanceof Title
&& $title->exists() && $title->userCan( 'read' ) ) {
2134 // Added using template syntax, to take <noinclude>'s into account.
2135 $wgOut->addWikiTextTitleTidy( '{{:' . $title->getFullText() . '}}', $this->mTitle
);
2143 * Gets an editable textual representation of $content.
2144 * The textual representation can be turned by into a Content object by the
2145 * toEditContent() method.
2147 * If $content is null or false or a string, $content is returned unchanged.
2149 * If the given Content object is not of a type that can be edited using the text base EditPage,
2150 * an exception will be raised. Set $this->allowNonTextContent to true to allow editing of non-textual
2153 * @param Content|null|bool|string $content
2154 * @return String the editable text form of the content.
2156 * @throws MWException if $content is not an instance of TextContent and $this->allowNonTextContent is not true.
2158 protected function toEditText( $content ) {
2159 if ( $content === null ||
$content === false ) {
2163 if ( is_string( $content ) ) {
2167 if ( !$this->isSupportedContentModel( $content->getModel() ) ) {
2168 throw new MWException( 'This content model is not supported: '
2169 . ContentHandler
::getLocalizedName( $content->getModel() ) );
2172 return $content->serialize( $this->contentFormat
);
2176 * Turns the given text into a Content object by unserializing it.
2178 * If the resulting Content object is not of a type that can be edited using the text base EditPage,
2179 * an exception will be raised. Set $this->allowNonTextContent to true to allow editing of non-textual
2182 * @param string|null|bool $text Text to unserialize
2183 * @return Content The content object created from $text. If $text was false or null, false resp. null will be
2186 * @throws MWException if unserializing the text results in a Content object that is not an instance of TextContent
2187 * and $this->allowNonTextContent is not true.
2189 protected function toEditContent( $text ) {
2190 if ( $text === false ||
$text === null ) {
2194 $content = ContentHandler
::makeContent( $text, $this->getTitle(),
2195 $this->contentModel
, $this->contentFormat
);
2197 if ( !$this->isSupportedContentModel( $content->getModel() ) ) {
2198 throw new MWException( 'This content model is not supported: '
2199 . ContentHandler
::getLocalizedName( $content->getModel() ) );
2206 * Send the edit form and related headers to $wgOut
2207 * @param $formCallback Callback|null that takes an OutputPage parameter; will be called
2208 * during form output near the top, for captchas and the like.
2210 function showEditForm( $formCallback = null ) {
2211 global $wgOut, $wgUser;
2213 wfProfileIn( __METHOD__
);
2215 # need to parse the preview early so that we know which templates are used,
2216 # otherwise users with "show preview after edit box" will get a blank list
2217 # we parse this near the beginning so that setHeaders can do the title
2218 # setting work instead of leaving it in getPreviewText
2219 $previewOutput = '';
2220 if ( $this->formtype
== 'preview' ) {
2221 $previewOutput = $this->getPreviewText();
2224 wfRunHooks( 'EditPage::showEditForm:initial', array( &$this, &$wgOut ) );
2226 $this->setHeaders();
2228 if ( $this->showHeader() === false ) {
2229 wfProfileOut( __METHOD__
);
2233 $wgOut->addHTML( $this->editFormPageTop
);
2235 if ( $wgUser->getOption( 'previewontop' ) ) {
2236 $this->displayPreviewArea( $previewOutput, true );
2239 $wgOut->addHTML( $this->editFormTextTop
);
2241 $showToolbar = true;
2242 if ( $this->wasDeletedSinceLastEdit() ) {
2243 if ( $this->formtype
== 'save' ) {
2244 // Hide the toolbar and edit area, user can click preview to get it back
2245 // Add an confirmation checkbox and explanation.
2246 $showToolbar = false;
2248 $wgOut->wrapWikiMsg( "<div class='error mw-deleted-while-editing'>\n$1\n</div>",
2249 'deletedwhileediting' );
2253 // @todo add EditForm plugin interface and use it here!
2254 // search for textarea1 and textares2, and allow EditForm to override all uses.
2255 $wgOut->addHTML( Html
::openElement( 'form', array( 'id' => self
::EDITFORM_ID
, 'name' => self
::EDITFORM_ID
,
2256 'method' => 'post', 'action' => $this->getActionURL( $this->getContextTitle() ),
2257 'enctype' => 'multipart/form-data' ) ) );
2259 if ( is_callable( $formCallback ) ) {
2260 call_user_func_array( $formCallback, array( &$wgOut ) );
2263 // Add an empty field to trip up spambots
2265 Xml
::openElement( 'div', array( 'id' => 'antispam-container', 'style' => 'display: none;' ) )
2266 . Html
::rawElement( 'label', array( 'for' => 'wpAntiSpam' ), wfMessage( 'simpleantispam-label' )->parse() )
2267 . Xml
::element( 'input', array( 'type' => 'text', 'name' => 'wpAntispam', 'id' => 'wpAntispam', 'value' => '' ) )
2268 . Xml
::closeElement( 'div' )
2271 wfRunHooks( 'EditPage::showEditForm:fields', array( &$this, &$wgOut ) );
2273 // Put these up at the top to ensure they aren't lost on early form submission
2274 $this->showFormBeforeText();
2276 if ( $this->wasDeletedSinceLastEdit() && 'save' == $this->formtype
) {
2277 $username = $this->lastDelete
->user_name
;
2278 $comment = $this->lastDelete
->log_comment
;
2280 // It is better to not parse the comment at all than to have templates expanded in the middle
2281 // TODO: can the checkLabel be moved outside of the div so that wrapWikiMsg could be used?
2282 $key = $comment === ''
2283 ?
'confirmrecreate-noreason'
2284 : 'confirmrecreate';
2286 '<div class="mw-confirm-recreate">' .
2287 wfMessage( $key, $username, "<nowiki>$comment</nowiki>" )->parse() .
2288 Xml
::checkLabel( wfMessage( 'recreate' )->text(), 'wpRecreate', 'wpRecreate', false,
2289 array( 'title' => Linker
::titleAttrib( 'recreate' ), 'tabindex' => 1, 'id' => 'wpRecreate' )
2295 # When the summary is hidden, also hide them on preview/show changes
2296 if ( $this->nosummary
) {
2297 $wgOut->addHTML( Html
::hidden( 'nosummary', true ) );
2300 # If a blank edit summary was previously provided, and the appropriate
2301 # user preference is active, pass a hidden tag as wpIgnoreBlankSummary. This will stop the
2302 # user being bounced back more than once in the event that a summary
2305 # For a bit more sophisticated detection of blank summaries, hash the
2306 # automatic one and pass that in the hidden field wpAutoSummary.
2307 if ( $this->missingSummary ||
( $this->section
== 'new' && $this->nosummary
) ) {
2308 $wgOut->addHTML( Html
::hidden( 'wpIgnoreBlankSummary', true ) );
2311 if ( $this->undidRev
) {
2312 $wgOut->addHTML( Html
::hidden( 'wpUndidRevision', $this->undidRev
) );
2315 if ( $this->hasPresetSummary
) {
2316 // If a summary has been preset using &summary= we don't want to prompt for
2317 // a different summary. Only prompt for a summary if the summary is blanked.
2319 $this->autoSumm
= md5( '' );
2322 $autosumm = $this->autoSumm ?
$this->autoSumm
: md5( $this->summary
);
2323 $wgOut->addHTML( Html
::hidden( 'wpAutoSummary', $autosumm ) );
2325 $wgOut->addHTML( Html
::hidden( 'oldid', $this->oldid
) );
2327 $wgOut->addHTML( Html
::hidden( 'format', $this->contentFormat
) );
2328 $wgOut->addHTML( Html
::hidden( 'model', $this->contentModel
) );
2330 if ( $this->section
== 'new' ) {
2331 $this->showSummaryInput( true, $this->summary
);
2332 $wgOut->addHTML( $this->getSummaryPreview( true, $this->summary
) );
2335 $wgOut->addHTML( $this->editFormTextBeforeContent
);
2337 if ( !$this->isCssJsSubpage
&& $showToolbar && $wgUser->getOption( 'showtoolbar' ) ) {
2338 $wgOut->addHTML( EditPage
::getEditToolbar() );
2341 if ( $this->isConflict
) {
2342 // In an edit conflict bypass the overridable content form method
2343 // and fallback to the raw wpTextbox1 since editconflicts can't be
2344 // resolved between page source edits and custom ui edits using the
2346 $this->textbox2
= $this->textbox1
;
2348 $content = $this->getCurrentContent();
2349 $this->textbox1
= $this->toEditText( $content );
2351 $this->showTextbox1();
2353 $this->showContentForm();
2356 $wgOut->addHTML( $this->editFormTextAfterContent
);
2358 $this->showStandardInputs();
2360 $this->showFormAfterText();
2362 $this->showTosSummary();
2364 $this->showEditTools();
2366 $wgOut->addHTML( $this->editFormTextAfterTools
. "\n" );
2368 $wgOut->addHTML( Html
::rawElement( 'div', array( 'class' => 'templatesUsed' ),
2369 Linker
::formatTemplates( $this->getTemplates(), $this->preview
, $this->section
!= '' ) ) );
2371 $wgOut->addHTML( Html
::rawElement( 'div', array( 'class' => 'hiddencats' ),
2372 Linker
::formatHiddenCategories( $this->mArticle
->getHiddenCategories() ) ) );
2374 $wgOut->addHTML( Html
::rawElement( 'div', array( 'class' => 'limitreport' ),
2375 self
::getPreviewLimitReport( $this->mParserOutput
) ) );
2377 $wgOut->addModules( 'mediawiki.action.edit.collapsibleFooter' );
2379 if ( $this->isConflict
) {
2381 $this->showConflict();
2382 } catch ( MWContentSerializationException
$ex ) {
2383 // this can't really happen, but be nice if it does.
2384 $msg = wfMessage( 'content-failed-to-parse', $this->contentModel
, $this->contentFormat
, $ex->getMessage() );
2385 $wgOut->addWikiText( '<div class="error">' . $msg->text() . '</div>' );
2389 $wgOut->addHTML( $this->editFormTextBottom
. "\n</form>\n" );
2391 if ( !$wgUser->getOption( 'previewontop' ) ) {
2392 $this->displayPreviewArea( $previewOutput, false );
2395 wfProfileOut( __METHOD__
);
2399 * Extract the section title from current section text, if any.
2401 * @param string $text
2402 * @return Mixed|string or false
2404 public static function extractSectionTitle( $text ) {
2405 preg_match( "/^(=+)(.+)\\1\\s*(\n|$)/i", $text, $matches );
2406 if ( !empty( $matches[2] ) ) {
2408 return $wgParser->stripSectionName( trim( $matches[2] ) );
2414 protected function showHeader() {
2415 global $wgOut, $wgUser, $wgMaxArticleSize, $wgLang;
2417 if ( $this->mTitle
->isTalkPage() ) {
2418 $wgOut->addWikiMsg( 'talkpagetext' );
2422 $wgOut->addHTML( implode( "\n", $this->mTitle
->getEditNotices( $this->oldid
) ) );
2424 if ( $this->isConflict
) {
2425 $wgOut->wrapWikiMsg( "<div class='mw-explainconflict'>\n$1\n</div>", 'explainconflict' );
2426 $this->edittime
= $this->mArticle
->getTimestamp();
2428 if ( $this->section
!= '' && !$this->isSectionEditSupported() ) {
2429 // We use $this->section to much before this and getVal('wgSection') directly in other places
2430 // at this point we can't reset $this->section to '' to fallback to non-section editing.
2431 // Someone is welcome to try refactoring though
2432 $wgOut->showErrorPage( 'sectioneditnotsupported-title', 'sectioneditnotsupported-text' );
2436 if ( $this->section
!= '' && $this->section
!= 'new' ) {
2437 if ( !$this->summary
&& !$this->preview
&& !$this->diff
) {
2438 $sectionTitle = self
::extractSectionTitle( $this->textbox1
); //FIXME: use Content object
2439 if ( $sectionTitle !== false ) {
2440 $this->summary
= "/* $sectionTitle */ ";
2445 if ( $this->missingComment
) {
2446 $wgOut->wrapWikiMsg( "<div id='mw-missingcommenttext'>\n$1\n</div>", 'missingcommenttext' );
2449 if ( $this->missingSummary
&& $this->section
!= 'new' ) {
2450 $wgOut->wrapWikiMsg( "<div id='mw-missingsummary'>\n$1\n</div>", 'missingsummary' );
2453 if ( $this->missingSummary
&& $this->section
== 'new' ) {
2454 $wgOut->wrapWikiMsg( "<div id='mw-missingcommentheader'>\n$1\n</div>", 'missingcommentheader' );
2457 if ( $this->hookError
!== '' ) {
2458 $wgOut->addWikiText( $this->hookError
);
2461 if ( !$this->checkUnicodeCompliantBrowser() ) {
2462 $wgOut->addWikiMsg( 'nonunicodebrowser' );
2465 if ( $this->section
!= 'new' ) {
2466 $revision = $this->mArticle
->getRevisionFetched();
2468 // Let sysop know that this will make private content public if saved
2470 if ( !$revision->userCan( Revision
::DELETED_TEXT
, $wgUser ) ) {
2471 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n", 'rev-deleted-text-permission' );
2472 } elseif ( $revision->isDeleted( Revision
::DELETED_TEXT
) ) {
2473 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n", 'rev-deleted-text-view' );
2476 if ( !$revision->isCurrent() ) {
2477 $this->mArticle
->setOldSubtitle( $revision->getId() );
2478 $wgOut->addWikiMsg( 'editingold' );
2480 } elseif ( $this->mTitle
->exists() ) {
2481 // Something went wrong
2483 $wgOut->wrapWikiMsg( "<div class='errorbox'>\n$1\n</div>\n",
2484 array( 'missing-revision', $this->oldid
) );
2489 if ( wfReadOnly() ) {
2490 $wgOut->wrapWikiMsg( "<div id=\"mw-read-only-warning\">\n$1\n</div>", array( 'readonlywarning', wfReadOnlyReason() ) );
2491 } elseif ( $wgUser->isAnon() ) {
2492 if ( $this->formtype
!= 'preview' ) {
2493 $wgOut->wrapWikiMsg( "<div id=\"mw-anon-edit-warning\">\n$1</div>", 'anoneditwarning' );
2495 $wgOut->wrapWikiMsg( "<div id=\"mw-anon-preview-warning\">\n$1</div>", 'anonpreviewwarning' );
2498 if ( $this->isCssJsSubpage
) {
2499 # Check the skin exists
2500 if ( $this->isWrongCaseCssJsPage
) {
2501 $wgOut->wrapWikiMsg( "<div class='error' id='mw-userinvalidcssjstitle'>\n$1\n</div>", array( 'userinvalidcssjstitle', $this->mTitle
->getSkinFromCssJsSubpage() ) );
2503 if ( $this->formtype
!== 'preview' ) {
2504 if ( $this->isCssSubpage
) {
2505 $wgOut->wrapWikiMsg( "<div id='mw-usercssyoucanpreview'>\n$1\n</div>", array( 'usercssyoucanpreview' ) );
2508 if ( $this->isJsSubpage
) {
2509 $wgOut->wrapWikiMsg( "<div id='mw-userjsyoucanpreview'>\n$1\n</div>", array( 'userjsyoucanpreview' ) );
2515 if ( $this->mTitle
->isProtected( 'edit' ) &&
2516 MWNamespace
::getRestrictionLevels( $this->mTitle
->getNamespace() ) !== array( '' )
2518 # Is the title semi-protected?
2519 if ( $this->mTitle
->isSemiProtected() ) {
2520 $noticeMsg = 'semiprotectedpagewarning';
2522 # Then it must be protected based on static groups (regular)
2523 $noticeMsg = 'protectedpagewarning';
2525 LogEventsList
::showLogExtract( $wgOut, 'protect', $this->mTitle
, '',
2526 array( 'lim' => 1, 'msgKey' => array( $noticeMsg ) ) );
2528 if ( $this->mTitle
->isCascadeProtected() ) {
2529 # Is this page under cascading protection from some source pages?
2530 list( $cascadeSources, /* $restrictions */ ) = $this->mTitle
->getCascadeProtectionSources();
2531 $notice = "<div class='mw-cascadeprotectedwarning'>\n$1\n";
2532 $cascadeSourcesCount = count( $cascadeSources );
2533 if ( $cascadeSourcesCount > 0 ) {
2534 # Explain, and list the titles responsible
2535 foreach ( $cascadeSources as $page ) {
2536 $notice .= '* [[:' . $page->getPrefixedText() . "]]\n";
2539 $notice .= '</div>';
2540 $wgOut->wrapWikiMsg( $notice, array( 'cascadeprotectedwarning', $cascadeSourcesCount ) );
2542 if ( !$this->mTitle
->exists() && $this->mTitle
->getRestrictions( 'create' ) ) {
2543 LogEventsList
::showLogExtract( $wgOut, 'protect', $this->mTitle
, '',
2545 'showIfEmpty' => false,
2546 'msgKey' => array( 'titleprotectedwarning' ),
2547 'wrap' => "<div class=\"mw-titleprotectedwarning\">\n$1</div>" ) );
2550 if ( $this->kblength
=== false ) {
2551 $this->kblength
= (int)( strlen( $this->textbox1
) / 1024 );
2554 if ( $this->tooBig ||
$this->kblength
> $wgMaxArticleSize ) {
2555 $wgOut->wrapWikiMsg( "<div class='error' id='mw-edit-longpageerror'>\n$1\n</div>",
2556 array( 'longpageerror', $wgLang->formatNum( $this->kblength
), $wgLang->formatNum( $wgMaxArticleSize ) ) );
2558 if ( !wfMessage( 'longpage-hint' )->isDisabled() ) {
2559 $wgOut->wrapWikiMsg( "<div id='mw-edit-longpage-hint'>\n$1\n</div>",
2560 array( 'longpage-hint', $wgLang->formatSize( strlen( $this->textbox1
) ), strlen( $this->textbox1
) )
2564 # Add header copyright warning
2565 $this->showHeaderCopyrightWarning();
2569 * Standard summary input and label (wgSummary), abstracted so EditPage
2570 * subclasses may reorganize the form.
2571 * Note that you do not need to worry about the label's for=, it will be
2572 * inferred by the id given to the input. You can remove them both by
2573 * passing array( 'id' => false ) to $userInputAttrs.
2575 * @param string $summary The value of the summary input
2576 * @param string $labelText The html to place inside the label
2577 * @param array $inputAttrs of attrs to use on the input
2578 * @param array $spanLabelAttrs of attrs to use on the span inside the label
2580 * @return array An array in the format array( $label, $input )
2582 function getSummaryInput( $summary = "", $labelText = null, $inputAttrs = null, $spanLabelAttrs = null ) {
2583 // Note: the maxlength is overridden in JS to 255 and to make it use UTF-8 bytes, not characters.
2584 $inputAttrs = ( is_array( $inputAttrs ) ?
$inputAttrs : array() ) +
array(
2585 'id' => 'wpSummary',
2586 'maxlength' => '200',
2589 'spellcheck' => 'true',
2590 ) + Linker
::tooltipAndAccesskeyAttribs( 'summary' );
2592 $spanLabelAttrs = ( is_array( $spanLabelAttrs ) ?
$spanLabelAttrs : array() ) +
array(
2593 'class' => $this->missingSummary ?
'mw-summarymissed' : 'mw-summary',
2594 'id' => "wpSummaryLabel"
2599 $label = Xml
::tags( 'label', $inputAttrs['id'] ?
array( 'for' => $inputAttrs['id'] ) : null, $labelText );
2600 $label = Xml
::tags( 'span', $spanLabelAttrs, $label );
2603 $input = Html
::input( 'wpSummary', $summary, 'text', $inputAttrs );
2605 return array( $label, $input );
2609 * @param bool $isSubjectPreview true if this is the section subject/title
2610 * up top, or false if this is the comment summary
2611 * down below the textarea
2612 * @param string $summary The text of the summary to display
2615 protected function showSummaryInput( $isSubjectPreview, $summary = "" ) {
2616 global $wgOut, $wgContLang;
2617 # Add a class if 'missingsummary' is triggered to allow styling of the summary line
2618 $summaryClass = $this->missingSummary ?
'mw-summarymissed' : 'mw-summary';
2619 if ( $isSubjectPreview ) {
2620 if ( $this->nosummary
) {
2624 if ( !$this->mShowSummaryField
) {
2628 $summary = $wgContLang->recodeForEdit( $summary );
2629 $labelText = wfMessage( $isSubjectPreview ?
'subject' : 'summary' )->parse();
2630 list( $label, $input ) = $this->getSummaryInput( $summary, $labelText, array( 'class' => $summaryClass ), array() );
2631 $wgOut->addHTML( "{$label} {$input}" );
2635 * @param bool $isSubjectPreview true if this is the section subject/title
2636 * up top, or false if this is the comment summary
2637 * down below the textarea
2638 * @param string $summary the text of the summary to display
2641 protected function getSummaryPreview( $isSubjectPreview, $summary = "" ) {
2642 // avoid spaces in preview, gets always trimmed on save
2643 $summary = trim( $summary );
2644 if ( !$summary ||
( !$this->preview
&& !$this->diff
) ) {
2650 if ( $isSubjectPreview ) {
2651 $summary = wfMessage( 'newsectionsummary' )->rawParams( $wgParser->stripSectionName( $summary ) )
2652 ->inContentLanguage()->text();
2655 $message = $isSubjectPreview ?
'subject-preview' : 'summary-preview';
2657 $summary = wfMessage( $message )->parse() . Linker
::commentBlock( $summary, $this->mTitle
, $isSubjectPreview );
2658 return Xml
::tags( 'div', array( 'class' => 'mw-summary-preview' ), $summary );
2661 protected function showFormBeforeText() {
2663 $section = htmlspecialchars( $this->section
);
2664 $wgOut->addHTML( <<<HTML
2665 <input type='hidden' value="{$section}" name="wpSection" />
2666 <input type='hidden' value="{$this->starttime}" name="wpStarttime" />
2667 <input type='hidden' value="{$this->edittime}" name="wpEdittime" />
2668 <input type='hidden' value="{$this->scrolltop}" name="wpScrolltop" id="wpScrolltop" />
2672 if ( !$this->checkUnicodeCompliantBrowser() ) {
2673 $wgOut->addHTML( Html
::hidden( 'safemode', '1' ) );
2677 protected function showFormAfterText() {
2678 global $wgOut, $wgUser;
2680 * To make it harder for someone to slip a user a page
2681 * which submits an edit form to the wiki without their
2682 * knowledge, a random token is associated with the login
2683 * session. If it's not passed back with the submission,
2684 * we won't save the page, or render user JavaScript and
2687 * For anon editors, who may not have a session, we just
2688 * include the constant suffix to prevent editing from
2689 * broken text-mangling proxies.
2691 $wgOut->addHTML( "\n" . Html
::hidden( "wpEditToken", $wgUser->getEditToken() ) . "\n" );
2695 * Subpage overridable method for printing the form for page content editing
2696 * By default this simply outputs wpTextbox1
2697 * Subclasses can override this to provide a custom UI for editing;
2698 * be it a form, or simply wpTextbox1 with a modified content that will be
2699 * reverse modified when extracted from the post data.
2700 * Note that this is basically the inverse for importContentFormData
2702 protected function showContentForm() {
2703 $this->showTextbox1();
2707 * Method to output wpTextbox1
2708 * The $textoverride method can be used by subclasses overriding showContentForm
2709 * to pass back to this method.
2711 * @param array $customAttribs of html attributes to use in the textarea
2712 * @param string $textoverride optional text to override $this->textarea1 with
2714 protected function showTextbox1( $customAttribs = null, $textoverride = null ) {
2715 if ( $this->wasDeletedSinceLastEdit() && $this->formtype
== 'save' ) {
2716 $attribs = array( 'style' => 'display:none;' );
2718 $classes = array(); // Textarea CSS
2719 if ( $this->mTitle
->isProtected( 'edit' ) &&
2720 MWNamespace
::getRestrictionLevels( $this->mTitle
->getNamespace() ) !== array( '' )
2722 # Is the title semi-protected?
2723 if ( $this->mTitle
->isSemiProtected() ) {
2724 $classes[] = 'mw-textarea-sprotected';
2726 # Then it must be protected based on static groups (regular)
2727 $classes[] = 'mw-textarea-protected';
2729 # Is the title cascade-protected?
2730 if ( $this->mTitle
->isCascadeProtected() ) {
2731 $classes[] = 'mw-textarea-cprotected';
2735 $attribs = array( 'tabindex' => 1 );
2737 if ( is_array( $customAttribs ) ) {
2738 $attribs +
= $customAttribs;
2741 if ( count( $classes ) ) {
2742 if ( isset( $attribs['class'] ) ) {
2743 $classes[] = $attribs['class'];
2745 $attribs['class'] = implode( ' ', $classes );
2749 $this->showTextbox( $textoverride !== null ?
$textoverride : $this->textbox1
, 'wpTextbox1', $attribs );
2752 protected function showTextbox2() {
2753 $this->showTextbox( $this->textbox2
, 'wpTextbox2', array( 'tabindex' => 6, 'readonly' ) );
2756 protected function showTextbox( $text, $name, $customAttribs = array() ) {
2757 global $wgOut, $wgUser;
2759 $wikitext = $this->safeUnicodeOutput( $text );
2760 if ( strval( $wikitext ) !== '' ) {
2761 // Ensure there's a newline at the end, otherwise adding lines
2763 // But don't add a newline if the ext is empty, or Firefox in XHTML
2764 // mode will show an extra newline. A bit annoying.
2768 $attribs = $customAttribs +
array(
2771 'cols' => $wgUser->getIntOption( 'cols' ),
2772 'rows' => $wgUser->getIntOption( 'rows' ),
2773 'style' => '' // avoid php notices when appending preferences (appending allows customAttribs['style'] to still work
2776 $pageLang = $this->mTitle
->getPageLanguage();
2777 $attribs['lang'] = $pageLang->getCode();
2778 $attribs['dir'] = $pageLang->getDir();
2780 $wgOut->addHTML( Html
::textarea( $name, $wikitext, $attribs ) );
2783 protected function displayPreviewArea( $previewOutput, $isOnTop = false ) {
2787 $classes[] = 'ontop';
2790 $attribs = array( 'id' => 'wikiPreview', 'class' => implode( ' ', $classes ) );
2792 if ( $this->formtype
!= 'preview' ) {
2793 $attribs['style'] = 'display: none;';
2796 $wgOut->addHTML( Xml
::openElement( 'div', $attribs ) );
2798 if ( $this->formtype
== 'preview' ) {
2799 $this->showPreview( $previewOutput );
2802 $wgOut->addHTML( '</div>' );
2804 if ( $this->formtype
== 'diff' ) {
2807 } catch ( MWContentSerializationException
$ex ) {
2808 $msg = wfMessage( 'content-failed-to-parse', $this->contentModel
, $this->contentFormat
, $ex->getMessage() );
2809 $wgOut->addWikiText( '<div class="error">' . $msg->text() . '</div>' );
2815 * Append preview output to $wgOut.
2816 * Includes category rendering if this is a category page.
2818 * @param string $text the HTML to be output for the preview.
2820 protected function showPreview( $text ) {
2822 if ( $this->mTitle
->getNamespace() == NS_CATEGORY
) {
2823 $this->mArticle
->openShowCategory();
2825 # This hook seems slightly odd here, but makes things more
2826 # consistent for extensions.
2827 wfRunHooks( 'OutputPageBeforeHTML', array( &$wgOut, &$text ) );
2828 $wgOut->addHTML( $text );
2829 if ( $this->mTitle
->getNamespace() == NS_CATEGORY
) {
2830 $this->mArticle
->closeShowCategory();
2835 * Get a diff between the current contents of the edit box and the
2836 * version of the page we're editing from.
2838 * If this is a section edit, we'll replace the section as for final
2839 * save and then make a comparison.
2841 function showDiff() {
2842 global $wgUser, $wgContLang, $wgOut;
2844 $oldtitlemsg = 'currentrev';
2845 # if message does not exist, show diff against the preloaded default
2846 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
&& !$this->mTitle
->exists() ) {
2847 $oldtext = $this->mTitle
->getDefaultMessageText();
2848 if ( $oldtext !== false ) {
2849 $oldtitlemsg = 'defaultmessagetext';
2850 $oldContent = $this->toEditContent( $oldtext );
2855 $oldContent = $this->getCurrentContent();
2858 $textboxContent = $this->toEditContent( $this->textbox1
);
2860 $newContent = $this->mArticle
->replaceSectionContent(
2861 $this->section
, $textboxContent,
2862 $this->summary
, $this->edittime
);
2864 if ( $newContent ) {
2865 ContentHandler
::runLegacyHooks( 'EditPageGetDiffText', array( $this, &$newContent ) );
2866 wfRunHooks( 'EditPageGetDiffContent', array( $this, &$newContent ) );
2868 $popts = ParserOptions
::newFromUserAndLang( $wgUser, $wgContLang );
2869 $newContent = $newContent->preSaveTransform( $this->mTitle
, $wgUser, $popts );
2872 if ( ( $oldContent && !$oldContent->isEmpty() ) ||
( $newContent && !$newContent->isEmpty() ) ) {
2873 $oldtitle = wfMessage( $oldtitlemsg )->parse();
2874 $newtitle = wfMessage( 'yourtext' )->parse();
2876 if ( !$oldContent ) {
2877 $oldContent = $newContent->getContentHandler()->makeEmptyContent();
2880 if ( !$newContent ) {
2881 $newContent = $oldContent->getContentHandler()->makeEmptyContent();
2884 $de = $oldContent->getContentHandler()->createDifferenceEngine( $this->mArticle
->getContext() );
2885 $de->setContent( $oldContent, $newContent );
2887 $difftext = $de->getDiff( $oldtitle, $newtitle );
2888 $de->showDiffStyle();
2893 $wgOut->addHTML( '<div id="wikiDiff">' . $difftext . '</div>' );
2897 * Show the header copyright warning.
2899 protected function showHeaderCopyrightWarning() {
2900 $msg = 'editpage-head-copy-warn';
2901 if ( !wfMessage( $msg )->isDisabled() ) {
2903 $wgOut->wrapWikiMsg( "<div class='editpage-head-copywarn'>\n$1\n</div>",
2904 'editpage-head-copy-warn' );
2909 * Give a chance for site and per-namespace customizations of
2910 * terms of service summary link that might exist separately
2911 * from the copyright notice.
2913 * This will display between the save button and the edit tools,
2914 * so should remain short!
2916 protected function showTosSummary() {
2917 $msg = 'editpage-tos-summary';
2918 wfRunHooks( 'EditPageTosSummary', array( $this->mTitle
, &$msg ) );
2919 if ( !wfMessage( $msg )->isDisabled() ) {
2921 $wgOut->addHTML( '<div class="mw-tos-summary">' );
2922 $wgOut->addWikiMsg( $msg );
2923 $wgOut->addHTML( '</div>' );
2927 protected function showEditTools() {
2929 $wgOut->addHTML( '<div class="mw-editTools">' .
2930 wfMessage( 'edittools' )->inContentLanguage()->parse() .
2935 * Get the copyright warning
2937 * Renamed to getCopyrightWarning(), old name kept around for backwards compatibility
2939 protected function getCopywarn() {
2940 return self
::getCopyrightWarning( $this->mTitle
);
2944 * Get the copyright warning, by default returns wikitext
2946 * @param Title $title
2947 * @param string $format output format, valid values are any function of
2951 public static function getCopyrightWarning( $title, $format = 'plain' ) {
2952 global $wgRightsText;
2953 if ( $wgRightsText ) {
2954 $copywarnMsg = array( 'copyrightwarning',
2955 '[[' . wfMessage( 'copyrightpage' )->inContentLanguage()->text() . ']]',
2958 $copywarnMsg = array( 'copyrightwarning2',
2959 '[[' . wfMessage( 'copyrightpage' )->inContentLanguage()->text() . ']]' );
2961 // Allow for site and per-namespace customization of contribution/copyright notice.
2962 wfRunHooks( 'EditPageCopyrightWarning', array( $title, &$copywarnMsg ) );
2964 return "<div id=\"editpage-copywarn\">\n" .
2965 call_user_func_array( 'wfMessage', $copywarnMsg )->$format() . "\n</div>";
2969 * Get the Limit report for page previews
2972 * @param ParserOutput $output ParserOutput object from the parse
2973 * @return string HTML
2975 public static function getPreviewLimitReport( $output ) {
2976 if ( !$output ||
!$output->getLimitReportData() ) {
2980 wfProfileIn( __METHOD__
);
2982 $limitReport = Html
::rawElement( 'div', array( 'class' => 'mw-limitReportExplanation' ),
2983 wfMessage( 'limitreport-title' )->parseAsBlock()
2986 // Show/hide animation doesn't work correctly on a table, so wrap it in a div.
2987 $limitReport .= Html
::openElement( 'div', array( 'class' => 'preview-limit-report-wrapper' ) );
2989 $limitReport .= Html
::openElement( 'table', array(
2990 'class' => 'preview-limit-report wikitable'
2992 Html
::openElement( 'tbody' );
2994 foreach ( $output->getLimitReportData() as $key => $value ) {
2995 if ( wfRunHooks( 'ParserLimitReportFormat',
2996 array( $key, &$value, &$limitReport, true, true )
2998 $keyMsg = wfMessage( $key );
2999 $valueMsg = wfMessage( array( "$key-value-html", "$key-value" ) );
3000 if ( !$valueMsg->exists() ) {
3001 $valueMsg = new RawMessage( '$1' );
3003 if ( !$keyMsg->isDisabled() && !$valueMsg->isDisabled() ) {
3004 $limitReport .= Html
::openElement( 'tr' ) .
3005 Html
::rawElement( 'th', null, $keyMsg->parse() ) .
3006 Html
::rawElement( 'td', null, $valueMsg->params( $value )->parse() ) .
3007 Html
::closeElement( 'tr' );
3012 $limitReport .= Html
::closeElement( 'tbody' ) .
3013 Html
::closeElement( 'table' ) .
3014 Html
::closeElement( 'div' );
3016 wfProfileOut( __METHOD__
);
3018 return $limitReport;
3021 protected function showStandardInputs( &$tabindex = 2 ) {
3023 $wgOut->addHTML( "<div class='editOptions'>\n" );
3025 if ( $this->section
!= 'new' ) {
3026 $this->showSummaryInput( false, $this->summary
);
3027 $wgOut->addHTML( $this->getSummaryPreview( false, $this->summary
) );
3030 $checkboxes = $this->getCheckboxes( $tabindex,
3031 array( 'minor' => $this->minoredit
, 'watch' => $this->watchthis
) );
3032 $wgOut->addHTML( "<div class='editCheckboxes'>" . implode( $checkboxes, "\n" ) . "</div>\n" );
3034 // Show copyright warning.
3035 $wgOut->addWikiText( $this->getCopywarn() );
3036 $wgOut->addHTML( $this->editFormTextAfterWarn
);
3038 $wgOut->addHTML( "<div class='editButtons'>\n" );
3039 $wgOut->addHTML( implode( $this->getEditButtons( $tabindex ), "\n" ) . "\n" );
3041 $cancel = $this->getCancelLink();
3042 if ( $cancel !== '' ) {
3043 $cancel .= Html
::element( 'span',
3044 array( 'class' => 'mw-editButtons-pipe-separator' ),
3045 wfMessage( 'pipe-separator' )->text() );
3047 $edithelpurl = Skin
::makeInternalOrExternalUrl( wfMessage( 'edithelppage' )->inContentLanguage()->text() );
3048 $edithelp = '<a target="helpwindow" href="' . $edithelpurl . '">' .
3049 wfMessage( 'edithelp' )->escaped() . '</a> ' .
3050 wfMessage( 'newwindow' )->parse();
3051 $wgOut->addHTML( " <span class='cancelLink'>{$cancel}</span>\n" );
3052 $wgOut->addHTML( " <span class='editHelp'>{$edithelp}</span>\n" );
3053 $wgOut->addHTML( "</div><!-- editButtons -->\n" );
3054 wfRunHooks( 'EditPage::showStandardInputs:options', array( $this, $wgOut, &$tabindex ) );
3055 $wgOut->addHTML( "</div><!-- editOptions -->\n" );
3059 * Show an edit conflict. textbox1 is already shown in showEditForm().
3060 * If you want to use another entry point to this function, be careful.
3062 protected function showConflict() {
3065 if ( wfRunHooks( 'EditPageBeforeConflictDiff', array( &$this, &$wgOut ) ) ) {
3066 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
3068 $content1 = $this->toEditContent( $this->textbox1
);
3069 $content2 = $this->toEditContent( $this->textbox2
);
3071 $handler = ContentHandler
::getForModelID( $this->contentModel
);
3072 $de = $handler->createDifferenceEngine( $this->mArticle
->getContext() );
3073 $de->setContent( $content2, $content1 );
3075 wfMessage( 'yourtext' )->parse(),
3076 wfMessage( 'storedversion' )->text()
3079 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
3080 $this->showTextbox2();
3087 public function getCancelLink() {
3088 $cancelParams = array();
3089 if ( !$this->isConflict
&& $this->oldid
> 0 ) {
3090 $cancelParams['oldid'] = $this->oldid
;
3093 return Linker
::linkKnown(
3094 $this->getContextTitle(),
3095 wfMessage( 'cancel' )->parse(),
3096 array( 'id' => 'mw-editform-cancel' ),
3102 * Returns the URL to use in the form's action attribute.
3103 * This is used by EditPage subclasses when simply customizing the action
3104 * variable in the constructor is not enough. This can be used when the
3105 * EditPage lives inside of a Special page rather than a custom page action.
3107 * @param $title Title object for which is being edited (where we go to for &action= links)
3110 protected function getActionURL( Title
$title ) {
3111 return $title->getLocalURL( array( 'action' => $this->action
) );
3115 * Check if a page was deleted while the user was editing it, before submit.
3116 * Note that we rely on the logging table, which hasn't been always there,
3117 * but that doesn't matter, because this only applies to brand new
3120 protected function wasDeletedSinceLastEdit() {
3121 if ( $this->deletedSinceEdit
!== null ) {
3122 return $this->deletedSinceEdit
;
3125 $this->deletedSinceEdit
= false;
3127 if ( $this->mTitle
->isDeletedQuick() ) {
3128 $this->lastDelete
= $this->getLastDelete();
3129 if ( $this->lastDelete
) {
3130 $deleteTime = wfTimestamp( TS_MW
, $this->lastDelete
->log_timestamp
);
3131 if ( $deleteTime > $this->starttime
) {
3132 $this->deletedSinceEdit
= true;
3137 return $this->deletedSinceEdit
;
3140 protected function getLastDelete() {
3141 $dbr = wfGetDB( DB_SLAVE
);
3142 $data = $dbr->selectRow(
3143 array( 'logging', 'user' ),
3156 'log_namespace' => $this->mTitle
->getNamespace(),
3157 'log_title' => $this->mTitle
->getDBkey(),
3158 'log_type' => 'delete',
3159 'log_action' => 'delete',
3163 array( 'LIMIT' => 1, 'ORDER BY' => 'log_timestamp DESC' )
3165 // Quick paranoid permission checks...
3166 if ( is_object( $data ) ) {
3167 if ( $data->log_deleted
& LogPage
::DELETED_USER
) {
3168 $data->user_name
= wfMessage( 'rev-deleted-user' )->escaped();
3171 if ( $data->log_deleted
& LogPage
::DELETED_COMMENT
) {
3172 $data->log_comment
= wfMessage( 'rev-deleted-comment' )->escaped();
3179 * Get the rendered text for previewing.
3180 * @throws MWException
3183 function getPreviewText() {
3184 global $wgOut, $wgUser, $wgRawHtml, $wgLang;
3186 wfProfileIn( __METHOD__
);
3188 if ( $wgRawHtml && !$this->mTokenOk
) {
3189 // Could be an offsite preview attempt. This is very unsafe if
3190 // HTML is enabled, as it could be an attack.
3192 if ( $this->textbox1
!== '' ) {
3193 // Do not put big scary notice, if previewing the empty
3194 // string, which happens when you initially edit
3195 // a category page, due to automatic preview-on-open.
3196 $parsedNote = $wgOut->parse( "<div class='previewnote'>" .
3197 wfMessage( 'session_fail_preview_html' )->text() . "</div>", true, /* interface */true );
3199 wfProfileOut( __METHOD__
);
3206 $content = $this->toEditContent( $this->textbox1
);
3209 if ( !wfRunHooks( 'AlternateEditPreview', array( $this, &$content, &$previewHTML, &$this->mParserOutput
) ) ) {
3210 wfProfileOut( __METHOD__
);
3211 return $previewHTML;
3214 # provide a anchor link to the editform
3215 $continueEditing = '<span class="mw-continue-editing">' .
3216 '[[#' . self
::EDITFORM_ID
. '|' . $wgLang->getArrow() . ' ' .
3217 wfMessage( 'continue-editing' )->text() . ']]</span>';
3218 if ( $this->mTriedSave
&& !$this->mTokenOk
) {
3219 if ( $this->mTokenOkExceptSuffix
) {
3220 $note = wfMessage( 'token_suffix_mismatch' )->plain();
3223 $note = wfMessage( 'session_fail_preview' )->plain();
3225 } elseif ( $this->incompleteForm
) {
3226 $note = wfMessage( 'edit_form_incomplete' )->plain();
3228 $note = wfMessage( 'previewnote' )->plain() . ' ' . $continueEditing;
3231 $parserOptions = $this->mArticle
->makeParserOptions( $this->mArticle
->getContext() );
3232 $parserOptions->setEditSection( false );
3233 $parserOptions->setIsPreview( true );
3234 $parserOptions->setIsSectionPreview( !is_null( $this->section
) && $this->section
!== '' );
3236 # don't parse non-wikitext pages, show message about preview
3237 if ( $this->mTitle
->isCssJsSubpage() ||
$this->mTitle
->isCssOrJsPage() ) {
3238 if ( $this->mTitle
->isCssJsSubpage() ) {
3240 } elseif ( $this->mTitle
->isCssOrJsPage() ) {
3246 if ( $content->getModel() == CONTENT_MODEL_CSS
) {
3248 } elseif ( $content->getModel() == CONTENT_MODEL_JAVASCRIPT
) {
3254 # Used messages to make sure grep find them:
3255 # Messages: usercsspreview, userjspreview, sitecsspreview, sitejspreview
3256 if ( $level && $format ) {
3257 $note = "<div id='mw-{$level}{$format}preview'>" .
3258 wfMessage( "{$level}{$format}preview" )->text() .
3259 ' ' . $continueEditing . "</div>";
3263 # If we're adding a comment, we need to show the
3264 # summary as the headline
3265 if ( $this->section
=== "new" && $this->summary
!== "" ) {
3266 $content = $content->addSectionHeader( $this->summary
);
3269 $hook_args = array( $this, &$content );
3270 ContentHandler
::runLegacyHooks( 'EditPageGetPreviewText', $hook_args );
3271 wfRunHooks( 'EditPageGetPreviewContent', $hook_args );
3273 $parserOptions->enableLimitReport();
3275 # For CSS/JS pages, we should have called the ShowRawCssJs hook here.
3276 # But it's now deprecated, so never mind
3278 $content = $content->preSaveTransform( $this->mTitle
, $wgUser, $parserOptions );
3279 $parserOutput = $content->getParserOutput( $this->getArticle()->getTitle(), null, $parserOptions );
3281 $previewHTML = $parserOutput->getText();
3282 $this->mParserOutput
= $parserOutput;
3283 $wgOut->addParserOutputNoText( $parserOutput );
3285 if ( count( $parserOutput->getWarnings() ) ) {
3286 $note .= "\n\n" . implode( "\n\n", $parserOutput->getWarnings() );
3288 } catch ( MWContentSerializationException
$ex ) {
3289 $m = wfMessage( 'content-failed-to-parse', $this->contentModel
, $this->contentFormat
, $ex->getMessage() );
3290 $note .= "\n\n" . $m->parse();
3294 if ( $this->isConflict
) {
3295 $conflict = '<h2 id="mw-previewconflict">' . wfMessage( 'previewconflict' )->escaped() . "</h2>\n";
3297 $conflict = '<hr />';
3300 $previewhead = "<div class='previewnote'>\n" .
3301 '<h2 id="mw-previewheader">' . wfMessage( 'preview' )->escaped() . "</h2>" .
3302 $wgOut->parse( $note, true, /* interface */true ) . $conflict . "</div>\n";
3304 $pageViewLang = $this->mTitle
->getPageViewLanguage();
3305 $attribs = array( 'lang' => $pageViewLang->getHtmlCode(), 'dir' => $pageViewLang->getDir(),
3306 'class' => 'mw-content-' . $pageViewLang->getDir() );
3307 $previewHTML = Html
::rawElement( 'div', $attribs, $previewHTML );
3309 wfProfileOut( __METHOD__
);
3310 return $previewhead . $previewHTML . $this->previewTextAfterContent
;
3316 function getTemplates() {
3317 if ( $this->preview ||
$this->section
!= '' ) {
3318 $templates = array();
3319 if ( !isset( $this->mParserOutput
) ) {
3322 foreach ( $this->mParserOutput
->getTemplates() as $ns => $template ) {
3323 foreach ( array_keys( $template ) as $dbk ) {
3324 $templates[] = Title
::makeTitle( $ns, $dbk );
3329 return $this->mTitle
->getTemplateLinksFrom();
3334 * Shows a bulletin board style toolbar for common editing functions.
3335 * It can be disabled in the user preferences.
3336 * The necessary JavaScript code can be found in skins/common/edit.js.
3340 static function getEditToolbar() {
3341 global $wgStylePath, $wgContLang, $wgLang, $wgOut;
3342 global $wgEnableUploads, $wgForeignFileRepos;
3344 $imagesAvailable = $wgEnableUploads ||
count( $wgForeignFileRepos );
3347 * $toolarray is an array of arrays each of which includes the
3348 * filename of the button image (without path), the opening
3349 * tag, the closing tag, optionally a sample text that is
3350 * inserted between the two when no selection is highlighted
3351 * and. The tip text is shown when the user moves the mouse
3354 * Also here: accesskeys (key), which are not used yet until
3355 * someone can figure out a way to make them work in
3356 * IE. However, we should make sure these keys are not defined
3361 'image' => $wgLang->getImageFile( 'button-bold' ),
3362 'id' => 'mw-editbutton-bold',
3364 'close' => '\'\'\'',
3365 'sample' => wfMessage( 'bold_sample' )->text(),
3366 'tip' => wfMessage( 'bold_tip' )->text(),
3370 'image' => $wgLang->getImageFile( 'button-italic' ),
3371 'id' => 'mw-editbutton-italic',
3374 'sample' => wfMessage( 'italic_sample' )->text(),
3375 'tip' => wfMessage( 'italic_tip' )->text(),
3379 'image' => $wgLang->getImageFile( 'button-link' ),
3380 'id' => 'mw-editbutton-link',
3383 'sample' => wfMessage( 'link_sample' )->text(),
3384 'tip' => wfMessage( 'link_tip' )->text(),
3388 'image' => $wgLang->getImageFile( 'button-extlink' ),
3389 'id' => 'mw-editbutton-extlink',
3392 'sample' => wfMessage( 'extlink_sample' )->text(),
3393 'tip' => wfMessage( 'extlink_tip' )->text(),
3397 'image' => $wgLang->getImageFile( 'button-headline' ),
3398 'id' => 'mw-editbutton-headline',
3401 'sample' => wfMessage( 'headline_sample' )->text(),
3402 'tip' => wfMessage( 'headline_tip' )->text(),
3405 $imagesAvailable ?
array(
3406 'image' => $wgLang->getImageFile( 'button-image' ),
3407 'id' => 'mw-editbutton-image',
3408 'open' => '[[' . $wgContLang->getNsText( NS_FILE
) . ':',
3410 'sample' => wfMessage( 'image_sample' )->text(),
3411 'tip' => wfMessage( 'image_tip' )->text(),
3414 $imagesAvailable ?
array(
3415 'image' => $wgLang->getImageFile( 'button-media' ),
3416 'id' => 'mw-editbutton-media',
3417 'open' => '[[' . $wgContLang->getNsText( NS_MEDIA
) . ':',
3419 'sample' => wfMessage( 'media_sample' )->text(),
3420 'tip' => wfMessage( 'media_tip' )->text(),
3424 'image' => $wgLang->getImageFile( 'button-nowiki' ),
3425 'id' => 'mw-editbutton-nowiki',
3426 'open' => "<nowiki>",
3427 'close' => "</nowiki>",
3428 'sample' => wfMessage( 'nowiki_sample' )->text(),
3429 'tip' => wfMessage( 'nowiki_tip' )->text(),
3433 'image' => $wgLang->getImageFile( 'button-sig' ),
3434 'id' => 'mw-editbutton-signature',
3438 'tip' => wfMessage( 'sig_tip' )->text(),
3442 'image' => $wgLang->getImageFile( 'button-hr' ),
3443 'id' => 'mw-editbutton-hr',
3444 'open' => "\n----\n",
3447 'tip' => wfMessage( 'hr_tip' )->text(),
3452 $script = 'mw.loader.using("mediawiki.action.edit", function() {';
3453 foreach ( $toolarray as $tool ) {
3459 $wgStylePath . '/common/images/' . $tool['image'],
3460 // Note that we use the tip both for the ALT tag and the TITLE tag of the image.
3461 // Older browsers show a "speedtip" type message only for ALT.
3462 // Ideally these should be different, realistically they
3463 // probably don't need to be.
3471 $script .= Xml
::encodeJsCall( 'mw.toolbar.addButton', $params );
3474 // This used to be called on DOMReady from mediawiki.action.edit, which
3475 // ended up causing race conditions with the setup code above.
3477 "// Create button bar\n" .
3478 "$(function() { mw.toolbar.init(); } );\n";
3481 $wgOut->addScript( Html
::inlineScript( ResourceLoader
::makeLoaderConditionalScript( $script ) ) );
3483 $toolbar = '<div id="toolbar"></div>';
3485 wfRunHooks( 'EditPageBeforeEditToolbar', array( &$toolbar ) );
3491 * Returns an array of html code of the following checkboxes:
3494 * @param int $tabindex Current tabindex
3495 * @param array $checked of checkbox => bool, where bool indicates the checked
3496 * status of the checkbox
3500 public function getCheckboxes( &$tabindex, $checked ) {
3503 $checkboxes = array();
3505 // don't show the minor edit checkbox if it's a new page or section
3506 if ( !$this->isNew
) {
3507 $checkboxes['minor'] = '';
3508 $minorLabel = wfMessage( 'minoredit' )->parse();
3509 if ( $wgUser->isAllowed( 'minoredit' ) ) {
3511 'tabindex' => ++
$tabindex,
3512 'accesskey' => wfMessage( 'accesskey-minoredit' )->text(),
3513 'id' => 'wpMinoredit',
3515 $checkboxes['minor'] =
3516 Xml
::check( 'wpMinoredit', $checked['minor'], $attribs ) .
3517 " <label for='wpMinoredit' id='mw-editpage-minoredit'" .
3518 Xml
::expandAttributes( array( 'title' => Linker
::titleAttrib( 'minoredit', 'withaccess' ) ) ) .
3519 ">{$minorLabel}</label>";
3523 $watchLabel = wfMessage( 'watchthis' )->parse();
3524 $checkboxes['watch'] = '';
3525 if ( $wgUser->isLoggedIn() ) {
3527 'tabindex' => ++
$tabindex,
3528 'accesskey' => wfMessage( 'accesskey-watch' )->text(),
3529 'id' => 'wpWatchthis',
3531 $checkboxes['watch'] =
3532 Xml
::check( 'wpWatchthis', $checked['watch'], $attribs ) .
3533 " <label for='wpWatchthis' id='mw-editpage-watch'" .
3534 Xml
::expandAttributes( array( 'title' => Linker
::titleAttrib( 'watch', 'withaccess' ) ) ) .
3535 ">{$watchLabel}</label>";
3537 wfRunHooks( 'EditPageBeforeEditChecks', array( &$this, &$checkboxes, &$tabindex ) );
3542 * Returns an array of html code of the following buttons:
3543 * save, diff, preview and live
3545 * @param int $tabindex Current tabindex
3549 public function getEditButtons( &$tabindex ) {
3556 'tabindex' => ++
$tabindex,
3557 'value' => wfMessage( 'savearticle' )->text(),
3558 'accesskey' => wfMessage( 'accesskey-save' )->text(),
3559 'title' => wfMessage( 'tooltip-save' )->text() . ' [' . wfMessage( 'accesskey-save' )->text() . ']',
3561 $buttons['save'] = Xml
::element( 'input', $temp, '' );
3563 ++
$tabindex; // use the same for preview and live preview
3565 'id' => 'wpPreview',
3566 'name' => 'wpPreview',
3568 'tabindex' => $tabindex,
3569 'value' => wfMessage( 'showpreview' )->text(),
3570 'accesskey' => wfMessage( 'accesskey-preview' )->text(),
3571 'title' => wfMessage( 'tooltip-preview' )->text() . ' [' . wfMessage( 'accesskey-preview' )->text() . ']',
3573 $buttons['preview'] = Xml
::element( 'input', $temp, '' );
3574 $buttons['live'] = '';
3580 'tabindex' => ++
$tabindex,
3581 'value' => wfMessage( 'showdiff' )->text(),
3582 'accesskey' => wfMessage( 'accesskey-diff' )->text(),
3583 'title' => wfMessage( 'tooltip-diff' )->text() . ' [' . wfMessage( 'accesskey-diff' )->text() . ']',
3585 $buttons['diff'] = Xml
::element( 'input', $temp, '' );
3587 wfRunHooks( 'EditPageBeforeEditButtons', array( &$this, &$buttons, &$tabindex ) );
3592 * Output preview text only. This can be sucked into the edit page
3593 * via JavaScript, and saves the server time rendering the skin as
3594 * well as theoretically being more robust on the client (doesn't
3595 * disturb the edit box's undo history, won't eat your text on
3598 * @todo This doesn't include category or interlanguage links.
3599 * Would need to enhance it a bit, "<s>maybe wrap them in XML
3600 * or something...</s>" that might also require more skin
3601 * initialization, so check whether that's a problem.
3603 function livePreview() {
3606 header( 'Content-type: text/xml; charset=utf-8' );
3607 header( 'Cache-control: no-cache' );
3609 $previewText = $this->getPreviewText();
3610 #$categories = $skin->getCategoryLinks();
3613 '<?xml version="1.0" encoding="UTF-8" ?>' . "\n" .
3614 Xml
::tags( 'livepreview', null,
3615 Xml
::element( 'preview', null, $previewText )
3616 #. Xml::element( 'category', null, $categories )
3622 * Call the stock "user is blocked" page
3624 * @deprecated in 1.19; throw an exception directly instead
3626 function blockedPage() {
3627 wfDeprecated( __METHOD__
, '1.19' );
3630 throw new UserBlockedError( $wgUser->getBlock() );
3634 * Produce the stock "please login to edit pages" page
3636 * @deprecated in 1.19; throw an exception directly instead
3638 function userNotLoggedInPage() {
3639 wfDeprecated( __METHOD__
, '1.19' );
3640 throw new PermissionsError( 'edit' );
3644 * Show an error page saying to the user that he has insufficient permissions
3645 * to create a new page
3647 * @deprecated in 1.19; throw an exception directly instead
3649 function noCreatePermission() {
3650 wfDeprecated( __METHOD__
, '1.19' );
3651 $permission = $this->mTitle
->isTalkPage() ?
'createtalk' : 'createpage';
3652 throw new PermissionsError( $permission );
3656 * Creates a basic error page which informs the user that
3657 * they have attempted to edit a nonexistent section.
3659 function noSuchSectionPage() {
3662 $wgOut->prepareErrorPage( wfMessage( 'nosuchsectiontitle' ) );
3664 $res = wfMessage( 'nosuchsectiontext', $this->section
)->parseAsBlock();
3665 wfRunHooks( 'EditPageNoSuchSection', array( &$this, &$res ) );
3666 $wgOut->addHTML( $res );
3668 $wgOut->returnToMain( false, $this->mTitle
);
3672 * Show "your edit contains spam" page with your diff and text
3674 * @param $match string|Array|bool Text (or array of texts) which triggered one or more filters
3676 public function spamPageWithContent( $match = false ) {
3677 global $wgOut, $wgLang;
3678 $this->textbox2
= $this->textbox1
;
3680 if ( is_array( $match ) ) {
3681 $match = $wgLang->listToText( $match );
3683 $wgOut->prepareErrorPage( wfMessage( 'spamprotectiontitle' ) );
3685 $wgOut->addHTML( '<div id="spamprotected">' );
3686 $wgOut->addWikiMsg( 'spamprotectiontext' );
3688 $wgOut->addWikiMsg( 'spamprotectionmatch', wfEscapeWikiText( $match ) );
3690 $wgOut->addHTML( '</div>' );
3692 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
3695 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
3696 $this->showTextbox2();
3698 $wgOut->addReturnTo( $this->getContextTitle(), array( 'action' => 'edit' ) );
3702 * Check if the browser is on a blacklist of user-agents known to
3703 * mangle UTF-8 data on form submission. Returns true if Unicode
3704 * should make it through, false if it's known to be a problem.
3707 private function checkUnicodeCompliantBrowser() {
3708 global $wgBrowserBlackList, $wgRequest;
3710 $currentbrowser = $wgRequest->getHeader( 'User-Agent' );
3711 if ( $currentbrowser === false ) {
3712 // No User-Agent header sent? Trust it by default...
3716 foreach ( $wgBrowserBlackList as $browser ) {
3717 if ( preg_match( $browser, $currentbrowser ) ) {
3725 * Filter an input field through a Unicode de-armoring process if it
3726 * came from an old browser with known broken Unicode editing issues.
3728 * @param WebRequest $request
3729 * @param string $field
3732 protected function safeUnicodeInput( $request, $field ) {
3733 $text = rtrim( $request->getText( $field ) );
3734 return $request->getBool( 'safemode' )
3735 ?
$this->unmakeSafe( $text )
3740 * Filter an output field through a Unicode armoring process if it is
3741 * going to an old browser with known broken Unicode editing issues.
3743 * @param string $text
3746 protected function safeUnicodeOutput( $text ) {
3748 $codedText = $wgContLang->recodeForEdit( $text );
3749 return $this->checkUnicodeCompliantBrowser()
3751 : $this->makeSafe( $codedText );
3755 * A number of web browsers are known to corrupt non-ASCII characters
3756 * in a UTF-8 text editing environment. To protect against this,
3757 * detected browsers will be served an armored version of the text,
3758 * with non-ASCII chars converted to numeric HTML character references.
3760 * Preexisting such character references will have a 0 added to them
3761 * to ensure that round-trips do not alter the original data.
3763 * @param string $invalue
3766 private function makeSafe( $invalue ) {
3767 // Armor existing references for reversibility.
3768 $invalue = strtr( $invalue, array( "&#x" => "�" ) );
3773 for ( $i = 0; $i < strlen( $invalue ); $i++
) {
3774 $bytevalue = ord( $invalue[$i] );
3775 if ( $bytevalue <= 0x7F ) { // 0xxx xxxx
3776 $result .= chr( $bytevalue );
3778 } elseif ( $bytevalue <= 0xBF ) { // 10xx xxxx
3779 $working = $working << 6;
3780 $working +
= ( $bytevalue & 0x3F );
3782 if ( $bytesleft <= 0 ) {
3783 $result .= "&#x" . strtoupper( dechex( $working ) ) . ";";
3785 } elseif ( $bytevalue <= 0xDF ) { // 110x xxxx
3786 $working = $bytevalue & 0x1F;
3788 } elseif ( $bytevalue <= 0xEF ) { // 1110 xxxx
3789 $working = $bytevalue & 0x0F;
3791 } else { // 1111 0xxx
3792 $working = $bytevalue & 0x07;
3800 * Reverse the previously applied transliteration of non-ASCII characters
3801 * back to UTF-8. Used to protect data from corruption by broken web browsers
3802 * as listed in $wgBrowserBlackList.
3804 * @param string $invalue
3807 private function unmakeSafe( $invalue ) {
3809 $valueLength = strlen( $invalue );
3810 for ( $i = 0; $i < $valueLength; $i++
) {
3811 if ( ( substr( $invalue, $i, 3 ) == "&#x" ) && ( $invalue[$i +
3] != '0' ) ) {
3815 $hexstring .= $invalue[$i];
3817 } while ( ctype_xdigit( $invalue[$i] ) && ( $i < strlen( $invalue ) ) );
3819 // Do some sanity checks. These aren't needed for reversibility,
3820 // but should help keep the breakage down if the editor
3821 // breaks one of the entities whilst editing.
3822 if ( ( substr( $invalue, $i, 1 ) == ";" ) and ( strlen( $hexstring ) <= 6 ) ) {
3823 $codepoint = hexdec( $hexstring );
3824 $result .= codepointToUtf8( $codepoint );
3826 $result .= "&#x" . $hexstring . substr( $invalue, $i, 1 );
3829 $result .= substr( $invalue, $i, 1 );
3832 // reverse the transform that we made for reversibility reasons.
3833 return strtr( $result, array( "�" => "&#x" ) );