3 * Contains the EditPage class
8 * The edit page/HTML interface (split from Article)
9 * The actual database and text munging is still in Article,
10 * but it should get easier to call those from alternate
13 * EditPage cares about two distinct titles:
14 * $this->mContextTitle is the page that forms submit to, links point to,
15 * redirects go to, etc. $this->mTitle (as well as $mArticle) is the
16 * page in the database that is actually being edited. These are
17 * usually the same, but they are now allowed to be different.
19 * Surgeon General's Warning: prolonged exposure to this class is known to cause
20 * headaches, which may be fatal.
25 * Status: Article successfully updated
27 const AS_SUCCESS_UPDATE
= 200;
30 * Status: Article successfully created
32 const AS_SUCCESS_NEW_ARTICLE
= 201;
35 * Status: Article update aborted by a hook function
37 const AS_HOOK_ERROR
= 210;
40 * Status: A hook function returned an error
42 const AS_HOOK_ERROR_EXPECTED
= 212;
45 * Status: User is blocked from editting this page
47 const AS_BLOCKED_PAGE_FOR_USER
= 215;
50 * Status: Content too big (> $wgMaxArticleSize)
52 const AS_CONTENT_TOO_BIG
= 216;
55 * Status: User cannot edit? (not used)
57 const AS_USER_CANNOT_EDIT
= 217;
60 * Status: this anonymous user is not allowed to edit this page
62 const AS_READ_ONLY_PAGE_ANON
= 218;
65 * Status: this logged in user is not allowed to edit this page
67 const AS_READ_ONLY_PAGE_LOGGED
= 219;
70 * Status: wiki is in readonly mode (wfReadOnly() == true)
72 const AS_READ_ONLY_PAGE
= 220;
75 * Status: rate limiter for action 'edit' was tripped
77 const AS_RATE_LIMITED
= 221;
80 * Status: article was deleted while editting and param wpRecreate == false or form
83 const AS_ARTICLE_WAS_DELETED
= 222;
86 * Status: user tried to create this page, but is not allowed to do that
87 * ( Title->usercan('create') == false )
89 const AS_NO_CREATE_PERMISSION
= 223;
92 * Status: user tried to create a blank page
94 const AS_BLANK_ARTICLE
= 224;
97 * Status: (non-resolvable) edit conflict
99 const AS_CONFLICT_DETECTED
= 225;
102 * Status: no edit summary given and the user has forceeditsummary set and the user is not
103 * editting in his own userspace or talkspace and wpIgnoreBlankSummary == false
105 const AS_SUMMARY_NEEDED
= 226;
108 * Status: user tried to create a new section without content
110 const AS_TEXTBOX_EMPTY
= 228;
113 * Status: article is too big (> $wgMaxArticleSize), after merging in the new section
115 const AS_MAX_ARTICLE_SIZE_EXCEEDED
= 229;
123 * Status: WikiPage::doEdit() was unsuccessfull
128 * Status: summary contained spam according to one of the regexes in $wgSummarySpamRegex
130 const AS_SPAM_ERROR
= 232;
133 * Status: anonymous user is not allowed to upload (User::isAllowed('upload') == false)
135 const AS_IMAGE_REDIRECT_ANON
= 233;
138 * Status: logged in user is not allowed to upload (User::isAllowed('upload') == false)
140 const AS_IMAGE_REDIRECT_LOGGED
= 234;
143 * HTML id and name for the beginning of the edit form.
145 const EDITFORM_ID
= 'editform';
156 private $mContextTitle = null;
157 var $action = 'submit';
158 var $isConflict = false;
159 var $isCssJsSubpage = false;
160 var $isCssSubpage = false;
161 var $isJsSubpage = false;
162 var $isWrongCaseCssJsPage = false;
163 var $isNew = false; // new page or new section
164 var $deletedSinceEdit;
168 var $mTokenOk = false;
169 var $mTokenOkExceptSuffix = false;
170 var $mTriedSave = false;
171 var $incompleteForm = false;
173 var $kblength = false;
174 var $missingComment = false;
175 var $missingSummary = false;
176 var $allowBlankSummary = false;
179 #var $mPreviewTemplates;
187 * Has a summary been preset using GET parameter &summary= ?
190 var $hasPresetSummary = false;
192 var $mBaseRevision = false;
193 var $mShowSummaryField = true;
196 var $save = false, $preview = false, $diff = false;
197 var $minoredit = false, $watchthis = false, $recreate = false;
198 var $textbox1 = '', $textbox2 = '', $summary = '', $nosummary = false;
199 var $edittime = '', $section = '', $sectiontitle = '', $starttime = '';
200 var $oldid = 0, $editintro = '', $scrolltop = null, $bot = true;
202 # Placeholders for text injection by hooks (must be HTML)
203 # extensions should take care to _append_ to the present value
204 public $editFormPageTop = ''; // Before even the preview
205 public $editFormTextTop = '';
206 public $editFormTextBeforeContent = '';
207 public $editFormTextAfterWarn = '';
208 public $editFormTextAfterTools = '';
209 public $editFormTextBottom = '';
210 public $editFormTextAfterContent = '';
211 public $previewTextAfterContent = '';
212 public $mPreloadText = '';
214 /* $didSave should be set to true whenever an article was succesfully altered. */
215 public $didSave = false;
216 public $undidRev = 0;
218 public $suppressIntro = false;
221 * @param $article Article
223 public function __construct( Article
$article ) {
224 $this->mArticle
= $article;
225 $this->mTitle
= $article->getTitle();
231 public function getArticle() {
232 return $this->mArticle
;
239 public function getTitle() {
240 return $this->mTitle
;
244 * Set the context Title object
246 * @param $title Title object or null
248 public function setContextTitle( $title ) {
249 $this->mContextTitle
= $title;
253 * Get the context title object.
254 * If not set, $wgTitle will be returned. This behavior might changed in
255 * the future to return $this->mTitle instead.
257 * @return Title object
259 public function getContextTitle() {
260 if ( is_null( $this->mContextTitle
) ) {
264 return $this->mContextTitle
;
273 * This is the function that gets called for "action=edit". It
274 * sets up various member variables, then passes execution to
275 * another function, usually showEditForm()
277 * The edit form is self-submitting, so that when things like
278 * preview and edit conflicts occur, we get the same form back
279 * with the extra stuff added. Only when the final submission
280 * is made and all is well do we actually save and redirect to
281 * the newly-edited page.
284 global $wgOut, $wgRequest, $wgUser;
285 // Allow extensions to modify/prevent this form or submission
286 if ( !wfRunHooks( 'AlternateEdit', array( $this ) ) ) {
290 wfProfileIn( __METHOD__
);
291 wfDebug( __METHOD__
. ": enter\n" );
293 // If they used redlink=1 and the page exists, redirect to the main article
294 if ( $wgRequest->getBool( 'redlink' ) && $this->mTitle
->exists() ) {
295 $wgOut->redirect( $this->mTitle
->getFullURL() );
296 wfProfileOut( __METHOD__
);
300 $this->importFormData( $wgRequest );
301 $this->firsttime
= false;
304 $this->livePreview();
305 wfProfileOut( __METHOD__
);
309 if ( wfReadOnly() && $this->save
) {
312 $this->preview
= true;
316 $this->formtype
= 'save';
317 } elseif ( $this->preview
) {
318 $this->formtype
= 'preview';
319 } elseif ( $this->diff
) {
320 $this->formtype
= 'diff';
321 } else { # First time through
322 $this->firsttime
= true;
323 if ( $this->previewOnOpen() ) {
324 $this->formtype
= 'preview';
326 $this->formtype
= 'initial';
330 $permErrors = $this->getEditPermissionErrors();
332 wfDebug( __METHOD__
. ": User can't edit\n" );
333 // Auto-block user's IP if the account was "hard" blocked
334 $wgUser->spreadAnyEditBlock();
336 $this->displayPermissionsError( $permErrors );
338 wfProfileOut( __METHOD__
);
342 wfProfileIn( __METHOD__
. "-business-end" );
344 $this->isConflict
= false;
345 // css / js subpages of user pages get a special treatment
346 $this->isCssJsSubpage
= $this->mTitle
->isCssJsSubpage();
347 $this->isCssSubpage
= $this->mTitle
->isCssSubpage();
348 $this->isJsSubpage
= $this->mTitle
->isJsSubpage();
349 $this->isWrongCaseCssJsPage
= $this->isWrongCaseCssJsPage();
350 $this->isNew
= !$this->mTitle
->exists() ||
$this->section
== 'new';
352 # Show applicable editing introductions
353 if ( $this->formtype
== 'initial' ||
$this->firsttime
) {
357 # Attempt submission here. This will check for edit conflicts,
358 # and redundantly check for locked database, blocked IPs, etc.
359 # that edit() already checked just in case someone tries to sneak
360 # in the back door with a hand-edited submission URL.
362 if ( 'save' == $this->formtype
) {
363 if ( !$this->attemptSave() ) {
364 wfProfileOut( __METHOD__
. "-business-end" );
365 wfProfileOut( __METHOD__
);
370 # First time through: get contents, set time for conflict
372 if ( 'initial' == $this->formtype ||
$this->firsttime
) {
373 if ( $this->initialiseForm() === false ) {
374 $this->noSuchSectionPage();
375 wfProfileOut( __METHOD__
. "-business-end" );
376 wfProfileOut( __METHOD__
);
379 if ( !$this->mTitle
->getArticleID() )
380 wfRunHooks( 'EditFormPreloadText', array( &$this->textbox1
, &$this->mTitle
) );
382 wfRunHooks( 'EditFormInitialText', array( $this ) );
385 $this->showEditForm();
386 wfProfileOut( __METHOD__
. "-business-end" );
387 wfProfileOut( __METHOD__
);
393 protected function getEditPermissionErrors() {
395 $permErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $wgUser );
396 # Can this title be created?
397 if ( !$this->mTitle
->exists() ) {
398 $permErrors = array_merge( $permErrors,
399 wfArrayDiff2( $this->mTitle
->getUserPermissionsErrors( 'create', $wgUser ), $permErrors ) );
401 # Ignore some permissions errors when a user is just previewing/viewing diffs
403 foreach ( $permErrors as $error ) {
404 if ( ( $this->preview ||
$this->diff
) &&
405 ( $error[0] == 'blockedtext' ||
$error[0] == 'autoblockedtext' ) )
410 $permErrors = wfArrayDiff2( $permErrors, $remove );
415 * Display a permissions error page, like OutputPage::showPermissionsErrorPage(),
416 * but with the following differences:
417 * - If redlink=1, the user will be redirected to the page
418 * - If there is content to display or the error occurs while either saving,
419 * previewing or showing the difference, it will be a
420 * "View source for ..." page displaying the source code after the error message.
423 * @param $permErrors Array of permissions errors, as returned by
424 * Title::getUserPermissionsErrors().
426 protected function displayPermissionsError( array $permErrors ) {
427 global $wgRequest, $wgOut;
429 if ( $wgRequest->getBool( 'redlink' ) ) {
430 // The edit page was reached via a red link.
431 // Redirect to the article page and let them click the edit tab if
432 // they really want a permission error.
433 $wgOut->redirect( $this->mTitle
->getFullUrl() );
437 $content = $this->getContent();
439 # Use the normal message if there's nothing to display
440 if ( $this->firsttime
&& $content === '' ) {
441 $action = $this->mTitle
->exists() ?
'edit' :
442 ( $this->mTitle
->isTalkPage() ?
'createtalk' : 'createpage' );
443 throw new PermissionsError( $action, $permErrors );
446 $wgOut->setPageTitle( wfMessage( 'viewsource-title', $this->getContextTitle()->getPrefixedText() ) );
447 $wgOut->addBacklinkSubtitle( $this->getContextTitle() );
448 $wgOut->addWikiText( $wgOut->formatPermissionsErrorMessage( $permErrors, 'edit' ) );
449 $wgOut->addHTML( "<hr />\n" );
451 # If the user made changes, preserve them when showing the markup
452 # (This happens when a user is blocked during edit, for instance)
453 if ( !$this->firsttime
) {
454 $content = $this->textbox1
;
455 $wgOut->addWikiMsg( 'viewyourtext' );
457 $wgOut->addWikiMsg( 'viewsourcetext' );
460 $this->showTextbox( $content, 'wpTextbox1', array( 'readonly' ) );
462 $wgOut->addHTML( Html
::rawElement( 'div', array( 'class' => 'templatesUsed' ),
463 Linker
::formatTemplates( $this->getTemplates() ) ) );
465 if ( $this->mTitle
->exists() ) {
466 $wgOut->returnToMain( null, $this->mTitle
);
471 * Show a read-only error
472 * Parameters are the same as OutputPage:readOnlyPage()
473 * Redirect to the article page if redlink=1
474 * @deprecated in 1.19; use displayPermissionsError() instead
476 function readOnlyPage( $source = null, $protected = false, $reasons = array(), $action = null ) {
477 wfDeprecated( __METHOD__
, '1.19' );
479 global $wgRequest, $wgOut;
480 if ( $wgRequest->getBool( 'redlink' ) ) {
481 // The edit page was reached via a red link.
482 // Redirect to the article page and let them click the edit tab if
483 // they really want a permission error.
484 $wgOut->redirect( $this->mTitle
->getFullUrl() );
486 $wgOut->readOnlyPage( $source, $protected, $reasons, $action );
491 * Should we show a preview when the edit form is first shown?
495 protected function previewOnOpen() {
496 global $wgRequest, $wgUser, $wgPreviewOnOpenNamespaces;
497 if ( $wgRequest->getVal( 'preview' ) == 'yes' ) {
498 // Explicit override from request
500 } elseif ( $wgRequest->getVal( 'preview' ) == 'no' ) {
501 // Explicit override from request
503 } elseif ( $this->section
== 'new' ) {
504 // Nothing *to* preview for new sections
506 } elseif ( ( $wgRequest->getVal( 'preload' ) !== null ||
$this->mTitle
->exists() ) && $wgUser->getOption( 'previewonfirst' ) ) {
507 // Standard preference behaviour
509 } elseif ( !$this->mTitle
->exists() &&
510 isset( $wgPreviewOnOpenNamespaces[$this->mTitle
->getNamespace()] ) &&
511 $wgPreviewOnOpenNamespaces[$this->mTitle
->getNamespace()] )
513 // Categories are special
521 * Checks whether the user entered a skin name in uppercase,
522 * e.g. "User:Example/Monobook.css" instead of "monobook.css"
526 protected function isWrongCaseCssJsPage() {
527 if ( $this->mTitle
->isCssJsSubpage() ) {
528 $name = $this->mTitle
->getSkinFromCssJsSubpage();
529 $skins = array_merge(
530 array_keys( Skin
::getSkinNames() ),
533 return !in_array( $name, $skins )
534 && in_array( strtolower( $name ), $skins );
541 * Does this EditPage class support section editing?
542 * This is used by EditPage subclasses to indicate their ui cannot handle section edits
546 protected function isSectionEditSupported() {
551 * This function collects the form data and uses it to populate various member variables.
552 * @param $request WebRequest
554 function importFormData( &$request ) {
555 global $wgLang, $wgUser;
557 wfProfileIn( __METHOD__
);
559 # Section edit can come from either the form or a link
560 $this->section
= $request->getVal( 'wpSection', $request->getVal( 'section' ) );
562 if ( $request->wasPosted() ) {
563 # These fields need to be checked for encoding.
564 # Also remove trailing whitespace, but don't remove _initial_
565 # whitespace from the text boxes. This may be significant formatting.
566 $this->textbox1
= $this->safeUnicodeInput( $request, 'wpTextbox1' );
567 if ( !$request->getCheck( 'wpTextbox2' ) ) {
568 // Skip this if wpTextbox2 has input, it indicates that we came
569 // from a conflict page with raw page text, not a custom form
570 // modified by subclasses
571 wfProfileIn( get_class( $this ) . "::importContentFormData" );
572 $textbox1 = $this->importContentFormData( $request );
573 if ( isset( $textbox1 ) )
574 $this->textbox1
= $textbox1;
575 wfProfileOut( get_class( $this ) . "::importContentFormData" );
578 # Truncate for whole multibyte characters. +5 bytes for ellipsis
579 $this->summary
= $wgLang->truncate( $request->getText( 'wpSummary' ), 250 );
581 # If the summary consists of a heading, e.g. '==Foobar==', extract the title from the
582 # header syntax, e.g. 'Foobar'. This is mainly an issue when we are using wpSummary for
584 $this->summary
= preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->summary
);
586 # Treat sectiontitle the same way as summary.
587 # Note that wpSectionTitle is not yet a part of the actual edit form, as wpSummary is
588 # currently doing double duty as both edit summary and section title. Right now this
589 # is just to allow API edits to work around this limitation, but this should be
590 # incorporated into the actual edit form when EditPage is rewritten (Bugs 18654, 26312).
591 $this->sectiontitle
= $wgLang->truncate( $request->getText( 'wpSectionTitle' ), 250 );
592 $this->sectiontitle
= preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->sectiontitle
);
594 $this->edittime
= $request->getVal( 'wpEdittime' );
595 $this->starttime
= $request->getVal( 'wpStarttime' );
597 $this->scrolltop
= $request->getIntOrNull( 'wpScrolltop' );
599 if ( $this->textbox1
=== '' && $request->getVal( 'wpTextbox1' ) === null ) {
600 // wpTextbox1 field is missing, possibly due to being "too big"
601 // according to some filter rules such as Suhosin's setting for
602 // suhosin.request.max_value_length (d'oh)
603 $this->incompleteForm
= true;
605 // edittime should be one of our last fields; if it's missing,
606 // the submission probably broke somewhere in the middle.
607 $this->incompleteForm
= is_null( $this->edittime
);
609 if ( $this->incompleteForm
) {
610 # If the form is incomplete, force to preview.
611 wfDebug( __METHOD__
. ": Form data appears to be incomplete\n" );
612 wfDebug( "POST DATA: " . var_export( $_POST, true ) . "\n" );
613 $this->preview
= true;
615 /* Fallback for live preview */
616 $this->preview
= $request->getCheck( 'wpPreview' ) ||
$request->getCheck( 'wpLivePreview' );
617 $this->diff
= $request->getCheck( 'wpDiff' );
619 // Remember whether a save was requested, so we can indicate
620 // if we forced preview due to session failure.
621 $this->mTriedSave
= !$this->preview
;
623 if ( $this->tokenOk( $request ) ) {
624 # Some browsers will not report any submit button
625 # if the user hits enter in the comment box.
626 # The unmarked state will be assumed to be a save,
627 # if the form seems otherwise complete.
628 wfDebug( __METHOD__
. ": Passed token check.\n" );
629 } elseif ( $this->diff
) {
630 # Failed token check, but only requested "Show Changes".
631 wfDebug( __METHOD__
. ": Failed token check; Show Changes requested.\n" );
633 # Page might be a hack attempt posted from
634 # an external site. Preview instead of saving.
635 wfDebug( __METHOD__
. ": Failed token check; forcing preview\n" );
636 $this->preview
= true;
639 $this->save
= !$this->preview
&& !$this->diff
;
640 if ( !preg_match( '/^\d{14}$/', $this->edittime
) ) {
641 $this->edittime
= null;
644 if ( !preg_match( '/^\d{14}$/', $this->starttime
) ) {
645 $this->starttime
= null;
648 $this->recreate
= $request->getCheck( 'wpRecreate' );
650 $this->minoredit
= $request->getCheck( 'wpMinoredit' );
651 $this->watchthis
= $request->getCheck( 'wpWatchthis' );
653 # Don't force edit summaries when a user is editing their own user or talk page
654 if ( ( $this->mTitle
->mNamespace
== NS_USER ||
$this->mTitle
->mNamespace
== NS_USER_TALK
) &&
655 $this->mTitle
->getText() == $wgUser->getName() )
657 $this->allowBlankSummary
= true;
659 $this->allowBlankSummary
= $request->getBool( 'wpIgnoreBlankSummary' ) ||
!$wgUser->getOption( 'forceeditsummary' );
662 $this->autoSumm
= $request->getText( 'wpAutoSummary' );
664 # Not a posted form? Start with nothing.
665 wfDebug( __METHOD__
. ": Not a posted form.\n" );
666 $this->textbox1
= '';
668 $this->sectiontitle
= '';
669 $this->edittime
= '';
670 $this->starttime
= wfTimestampNow();
672 $this->preview
= false;
675 $this->minoredit
= false;
676 $this->watchthis
= $request->getBool( 'watchthis', false ); // Watch may be overriden by request parameters
677 $this->recreate
= false;
679 // When creating a new section, we can preload a section title by passing it as the
680 // preloadtitle parameter in the URL (Bug 13100)
681 if ( $this->section
== 'new' && $request->getVal( 'preloadtitle' ) ) {
682 $this->sectiontitle
= $request->getVal( 'preloadtitle' );
683 // Once wpSummary isn't being use for setting section titles, we should delete this.
684 $this->summary
= $request->getVal( 'preloadtitle' );
686 elseif ( $this->section
!= 'new' && $request->getVal( 'summary' ) ) {
687 $this->summary
= $request->getText( 'summary' );
688 if ( $this->summary
!== '' ) {
689 $this->hasPresetSummary
= true;
693 if ( $request->getVal( 'minor' ) ) {
694 $this->minoredit
= true;
698 $this->bot
= $request->getBool( 'bot', true );
699 $this->nosummary
= $request->getBool( 'nosummary' );
701 $this->oldid
= $request->getInt( 'oldid' );
703 $this->live
= $request->getCheck( 'live' );
704 $this->editintro
= $request->getText( 'editintro',
705 // Custom edit intro for new sections
706 $this->section
=== 'new' ?
'MediaWiki:addsection-editintro' : '' );
708 // Allow extensions to modify form data
709 wfRunHooks( 'EditPage::importFormData', array( $this, $request ) );
711 wfProfileOut( __METHOD__
);
715 * Subpage overridable method for extracting the page content data from the
716 * posted form to be placed in $this->textbox1, if using customized input
717 * this method should be overrided and return the page text that will be used
718 * for saving, preview parsing and so on...
720 * @param $request WebRequest
722 protected function importContentFormData( &$request ) {
723 return; // Don't do anything, EditPage already extracted wpTextbox1
727 * Initialise form fields in the object
728 * Called on the first invocation, e.g. when a user clicks an edit link
729 * @return bool -- if the requested section is valid
731 function initialiseForm() {
733 $this->edittime
= $this->mArticle
->getTimestamp();
734 $this->textbox1
= $this->getContent( false );
735 // activate checkboxes if user wants them to be always active
736 # Sort out the "watch" checkbox
737 if ( $wgUser->getOption( 'watchdefault' ) ) {
739 $this->watchthis
= true;
740 } elseif ( $wgUser->getOption( 'watchcreations' ) && !$this->mTitle
->exists() ) {
742 $this->watchthis
= true;
743 } elseif ( $this->mTitle
->userIsWatching() ) {
745 $this->watchthis
= true;
747 if ( $wgUser->getOption( 'minordefault' ) && !$this->isNew
) {
748 $this->minoredit
= true;
750 if ( $this->textbox1
=== false ) {
758 * Fetch initial editing page content.
760 * @param $def_text string
761 * @return mixed string on success, $def_text for invalid sections
764 function getContent( $def_text = '' ) {
765 global $wgOut, $wgRequest, $wgParser;
767 wfProfileIn( __METHOD__
);
771 // For message page not locally set, use the i18n message.
772 // For other non-existent articles, use preload text if any.
773 if ( !$this->mTitle
->exists() ||
$this->section
== 'new' ) {
774 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
&& $this->section
!= 'new' ) {
775 # If this is a system message, get the default text.
776 $text = $this->mTitle
->getDefaultMessageText();
778 if ( $text === false ) {
779 # If requested, preload some text.
780 $preload = $wgRequest->getVal( 'preload',
781 // Custom preload text for new sections
782 $this->section
=== 'new' ?
'MediaWiki:addsection-preload' : '' );
783 $text = $this->getPreloadedText( $preload );
785 // For existing pages, get text based on "undo" or section parameters.
787 if ( $this->section
!= '' ) {
788 // Get section edit text (returns $def_text for invalid sections)
789 $text = $wgParser->getSection( $this->getOriginalContent(), $this->section
, $def_text );
791 $undoafter = $wgRequest->getInt( 'undoafter' );
792 $undo = $wgRequest->getInt( 'undo' );
794 if ( $undo > 0 && $undoafter > 0 ) {
795 if ( $undo < $undoafter ) {
796 # If they got undoafter and undo round the wrong way, switch them
797 list( $undo, $undoafter ) = array( $undoafter, $undo );
800 $undorev = Revision
::newFromId( $undo );
801 $oldrev = Revision
::newFromId( $undoafter );
803 # Sanity check, make sure it's the right page,
804 # the revisions exist and they were not deleted.
805 # Otherwise, $text will be left as-is.
806 if ( !is_null( $undorev ) && !is_null( $oldrev ) &&
807 $undorev->getPage() == $oldrev->getPage() &&
808 $undorev->getPage() == $this->mTitle
->getArticleID() &&
809 !$undorev->isDeleted( Revision
::DELETED_TEXT
) &&
810 !$oldrev->isDeleted( Revision
::DELETED_TEXT
) ) {
812 $text = $this->mArticle
->getUndoText( $undorev, $oldrev );
813 if ( $text === false ) {
814 # Warn the user that something went wrong
815 $undoMsg = 'failure';
817 # Inform the user of our success and set an automatic edit summary
818 $undoMsg = 'success';
820 # If we just undid one rev, use an autosummary
821 $firstrev = $oldrev->getNext();
822 if ( $firstrev && $firstrev->getId() == $undo ) {
823 $undoSummary = wfMsgForContent( 'undo-summary', $undo, $undorev->getUserText() );
824 if ( $this->summary
=== '' ) {
825 $this->summary
= $undoSummary;
827 $this->summary
= $undoSummary . wfMsgForContent( 'colon-separator' ) . $this->summary
;
829 $this->undidRev
= $undo;
831 $this->formtype
= 'diff';
834 // Failed basic sanity checks.
835 // Older revisions may have been removed since the link
836 // was created, or we may simply have got bogus input.
840 $class = ( $undoMsg == 'success' ?
'' : 'error ' ) . "mw-undo-{$undoMsg}";
841 $this->editFormPageTop
.= $wgOut->parse( "<div class=\"{$class}\">" .
842 wfMsgNoTrans( 'undo-' . $undoMsg ) . '</div>', true, /* interface */true );
845 if ( $text === false ) {
846 $text = $this->getOriginalContent();
851 wfProfileOut( __METHOD__
);
856 * Get the content of the wanted revision, without section extraction.
858 * The result of this function can be used to compare user's input with
859 * section replaced in its context (using WikiPage::replaceSection())
860 * to the original text of the edit.
862 * This difers from Article::getContent() that when a missing revision is
863 * encountered the result will be an empty string and not the
864 * 'missing-article' message.
869 private function getOriginalContent() {
870 if ( $this->section
== 'new' ) {
871 return $this->getCurrentText();
873 $revision = $this->mArticle
->getRevisionFetched();
874 if ( $revision === null ) {
877 return $this->mArticle
->getContent();
881 * Get the actual text of the page. This is basically similar to
882 * WikiPage::getRawText() except that when the page doesn't exist an empty
883 * string is returned instead of false.
888 private function getCurrentText() {
889 $text = $this->mArticle
->getRawText();
890 if ( $text === false ) {
898 * Use this method before edit() to preload some text into the edit box
900 * @param $text string
902 public function setPreloadedText( $text ) {
903 $this->mPreloadText
= $text;
907 * Get the contents to be preloaded into the box, either set by
908 * an earlier setPreloadText() or by loading the given page.
910 * @param $preload String: representing the title to preload from.
913 protected function getPreloadedText( $preload ) {
914 global $wgUser, $wgParser;
916 if ( !empty( $this->mPreloadText
) ) {
917 return $this->mPreloadText
;
920 if ( $preload === '' ) {
924 $title = Title
::newFromText( $preload );
925 # Check for existence to avoid getting MediaWiki:Noarticletext
926 if ( $title === null ||
!$title->exists() ||
!$title->userCan( 'read' ) ) {
930 $page = WikiPage
::factory( $title );
931 if ( $page->isRedirect() ) {
932 $title = $page->getRedirectTarget();
934 if ( $title === null ||
!$title->exists() ||
!$title->userCan( 'read' ) ) {
937 $page = WikiPage
::factory( $title );
940 $parserOptions = ParserOptions
::newFromUser( $wgUser );
941 return $wgParser->getPreloadText( $page->getRawText(), $title, $parserOptions );
945 * Make sure the form isn't faking a user's credentials.
947 * @param $request WebRequest
951 function tokenOk( &$request ) {
953 $token = $request->getVal( 'wpEditToken' );
954 $this->mTokenOk
= $wgUser->matchEditToken( $token );
955 $this->mTokenOkExceptSuffix
= $wgUser->matchEditTokenNoSuffix( $token );
956 return $this->mTokenOk
;
961 * @return bool false if output is done, true if the rest of the form should be displayed
963 function attemptSave() {
964 global $wgUser, $wgOut;
966 $resultDetails = false;
967 # Allow bots to exempt some edits from bot flagging
968 $bot = $wgUser->isAllowed( 'bot' ) && $this->bot
;
969 $status = $this->internalAttemptSave( $resultDetails, $bot );
970 // FIXME: once the interface for internalAttemptSave() is made nicer, this should use the message in $status
972 if ( $status->value
== self
::AS_SUCCESS_UPDATE ||
$status->value
== self
::AS_SUCCESS_NEW_ARTICLE
) {
973 $this->didSave
= true;
976 switch ( $status->value
) {
977 case self
::AS_HOOK_ERROR_EXPECTED
:
978 case self
::AS_CONTENT_TOO_BIG
:
979 case self
::AS_ARTICLE_WAS_DELETED
:
980 case self
::AS_CONFLICT_DETECTED
:
981 case self
::AS_SUMMARY_NEEDED
:
982 case self
::AS_TEXTBOX_EMPTY
:
983 case self
::AS_MAX_ARTICLE_SIZE_EXCEEDED
:
987 case self
::AS_HOOK_ERROR
:
990 case self
::AS_SUCCESS_NEW_ARTICLE
:
991 $query = $resultDetails['redirect'] ?
'redirect=no' : '';
992 $anchor = isset ( $resultDetails['sectionanchor'] ) ?
$resultDetails['sectionanchor'] : '';
993 $wgOut->redirect( $this->mTitle
->getFullURL( $query ) . $anchor );
996 case self
::AS_SUCCESS_UPDATE
:
998 $sectionanchor = $resultDetails['sectionanchor'];
1000 // Give extensions a chance to modify URL query on update
1001 wfRunHooks( 'ArticleUpdateBeforeRedirect', array( $this->mArticle
, &$sectionanchor, &$extraQuery ) );
1003 if ( $resultDetails['redirect'] ) {
1004 if ( $extraQuery == '' ) {
1005 $extraQuery = 'redirect=no';
1007 $extraQuery = 'redirect=no&' . $extraQuery;
1010 $wgOut->redirect( $this->mTitle
->getFullURL( $extraQuery ) . $sectionanchor );
1013 case self
::AS_BLANK_ARTICLE
:
1014 $wgOut->redirect( $this->getContextTitle()->getFullURL() );
1017 case self
::AS_SPAM_ERROR
:
1018 $this->spamPageWithContent( $resultDetails['spam'] );
1021 case self
::AS_BLOCKED_PAGE_FOR_USER
:
1022 throw new UserBlockedError( $wgUser->getBlock() );
1024 case self
::AS_IMAGE_REDIRECT_ANON
:
1025 case self
::AS_IMAGE_REDIRECT_LOGGED
:
1026 throw new PermissionsError( 'upload' );
1028 case self
::AS_READ_ONLY_PAGE_ANON
:
1029 case self
::AS_READ_ONLY_PAGE_LOGGED
:
1030 throw new PermissionsError( 'edit' );
1032 case self
::AS_READ_ONLY_PAGE
:
1033 throw new ReadOnlyError
;
1035 case self
::AS_RATE_LIMITED
:
1036 throw new ThrottledError();
1038 case self
::AS_NO_CREATE_PERMISSION
:
1039 $permission = $this->mTitle
->isTalkPage() ?
'createtalk' : 'createpage';
1040 throw new PermissionsError( $permission );
1047 * Attempt submission (no UI)
1052 * @return Status object, possibly with a message, but always with one of the AS_* constants in $status->value,
1054 * FIXME: This interface is TERRIBLE, but hard to get rid of due to various error display idiosyncrasies. There are
1055 * also lots of cases where error metadata is set in the object and retrieved later instead of being returned, e.g.
1056 * AS_CONTENT_TOO_BIG and AS_BLOCKED_PAGE_FOR_USER. All that stuff needs to be cleaned up some time.
1058 function internalAttemptSave( &$result, $bot = false ) {
1059 global $wgUser, $wgRequest, $wgParser, $wgMaxArticleSize;
1061 $status = Status
::newGood();
1063 wfProfileIn( __METHOD__
);
1064 wfProfileIn( __METHOD__
. '-checks' );
1066 if ( !wfRunHooks( 'EditPage::attemptSave', array( $this ) ) ) {
1067 wfDebug( "Hook 'EditPage::attemptSave' aborted article saving\n" );
1068 $status->fatal( 'hookaborted' );
1069 $status->value
= self
::AS_HOOK_ERROR
;
1070 wfProfileOut( __METHOD__
. '-checks' );
1071 wfProfileOut( __METHOD__
);
1075 # Check image redirect
1076 if ( $this->mTitle
->getNamespace() == NS_FILE
&&
1077 Title
::newFromRedirect( $this->textbox1
) instanceof Title
&&
1078 !$wgUser->isAllowed( 'upload' ) ) {
1079 $code = $wgUser->isAnon() ? self
::AS_IMAGE_REDIRECT_ANON
: self
::AS_IMAGE_REDIRECT_LOGGED
;
1080 $status->setResult( false, $code );
1082 wfProfileOut( __METHOD__
. '-checks' );
1083 wfProfileOut( __METHOD__
);
1089 $match = self
::matchSummarySpamRegex( $this->summary
);
1090 if ( $match === false ) {
1091 $match = self
::matchSpamRegex( $this->textbox1
);
1093 if ( $match !== false ) {
1094 $result['spam'] = $match;
1095 $ip = $wgRequest->getIP();
1096 $pdbk = $this->mTitle
->getPrefixedDBkey();
1097 $match = str_replace( "\n", '', $match );
1098 wfDebugLog( 'SpamRegex', "$ip spam regex hit [[$pdbk]]: \"$match\"" );
1099 $status->fatal( 'spamprotectionmatch', $match );
1100 $status->value
= self
::AS_SPAM_ERROR
;
1101 wfProfileOut( __METHOD__
. '-checks' );
1102 wfProfileOut( __METHOD__
);
1105 if ( !wfRunHooks( 'EditFilter', array( $this, $this->textbox1
, $this->section
, &$this->hookError
, $this->summary
) ) ) {
1106 # Error messages etc. could be handled within the hook...
1107 $status->fatal( 'hookaborted' );
1108 $status->value
= self
::AS_HOOK_ERROR
;
1109 wfProfileOut( __METHOD__
. '-checks' );
1110 wfProfileOut( __METHOD__
);
1112 } elseif ( $this->hookError
!= '' ) {
1113 # ...or the hook could be expecting us to produce an error
1114 $status->fatal( 'hookaborted' );
1115 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1116 wfProfileOut( __METHOD__
. '-checks' );
1117 wfProfileOut( __METHOD__
);
1121 if ( $wgUser->isBlockedFrom( $this->mTitle
, false ) ) {
1122 // Auto-block user's IP if the account was "hard" blocked
1123 $wgUser->spreadAnyEditBlock();
1124 # Check block state against master, thus 'false'.
1125 $status->setResult( false, self
::AS_BLOCKED_PAGE_FOR_USER
);
1126 wfProfileOut( __METHOD__
. '-checks' );
1127 wfProfileOut( __METHOD__
);
1131 $this->kblength
= (int)( strlen( $this->textbox1
) / 1024 );
1132 if ( $this->kblength
> $wgMaxArticleSize ) {
1133 // Error will be displayed by showEditForm()
1134 $this->tooBig
= true;
1135 $status->setResult( false, self
::AS_CONTENT_TOO_BIG
);
1136 wfProfileOut( __METHOD__
. '-checks' );
1137 wfProfileOut( __METHOD__
);
1141 if ( !$wgUser->isAllowed( 'edit' ) ) {
1142 if ( $wgUser->isAnon() ) {
1143 $status->setResult( false, self
::AS_READ_ONLY_PAGE_ANON
);
1144 wfProfileOut( __METHOD__
. '-checks' );
1145 wfProfileOut( __METHOD__
);
1148 $status->fatal( 'readonlytext' );
1149 $status->value
= self
::AS_READ_ONLY_PAGE_LOGGED
;
1150 wfProfileOut( __METHOD__
. '-checks' );
1151 wfProfileOut( __METHOD__
);
1156 if ( wfReadOnly() ) {
1157 $status->fatal( 'readonlytext' );
1158 $status->value
= self
::AS_READ_ONLY_PAGE
;
1159 wfProfileOut( __METHOD__
. '-checks' );
1160 wfProfileOut( __METHOD__
);
1163 if ( $wgUser->pingLimiter() ) {
1164 $status->fatal( 'actionthrottledtext' );
1165 $status->value
= self
::AS_RATE_LIMITED
;
1166 wfProfileOut( __METHOD__
. '-checks' );
1167 wfProfileOut( __METHOD__
);
1171 # If the article has been deleted while editing, don't save it without
1173 if ( $this->wasDeletedSinceLastEdit() && !$this->recreate
) {
1174 $status->setResult( false, self
::AS_ARTICLE_WAS_DELETED
);
1175 wfProfileOut( __METHOD__
. '-checks' );
1176 wfProfileOut( __METHOD__
);
1180 wfProfileOut( __METHOD__
. '-checks' );
1182 # If article is new, insert it.
1183 $aid = $this->mTitle
->getArticleID( Title
::GAID_FOR_UPDATE
);
1184 $new = ( $aid == 0 );
1187 // Late check for create permission, just in case *PARANOIA*
1188 if ( !$this->mTitle
->userCan( 'create' ) ) {
1189 $status->fatal( 'nocreatetext' );
1190 $status->value
= self
::AS_NO_CREATE_PERMISSION
;
1191 wfDebug( __METHOD__
. ": no create permission\n" );
1192 wfProfileOut( __METHOD__
);
1196 # Don't save a new article if it's blank.
1197 if ( $this->textbox1
== '' ) {
1198 $status->setResult( false, self
::AS_BLANK_ARTICLE
);
1199 wfProfileOut( __METHOD__
);
1203 // Run post-section-merge edit filter
1204 if ( !wfRunHooks( 'EditFilterMerged', array( $this, $this->textbox1
, &$this->hookError
, $this->summary
) ) ) {
1205 # Error messages etc. could be handled within the hook...
1206 $status->fatal( 'hookaborted' );
1207 $status->value
= self
::AS_HOOK_ERROR
;
1208 wfProfileOut( __METHOD__
);
1210 } elseif ( $this->hookError
!= '' ) {
1211 # ...or the hook could be expecting us to produce an error
1212 $status->fatal( 'hookaborted' );
1213 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1214 wfProfileOut( __METHOD__
);
1218 $text = $this->textbox1
;
1219 $result['sectionanchor'] = '';
1220 if ( $this->section
== 'new' ) {
1221 if ( $this->sectiontitle
!== '' ) {
1222 // Insert the section title above the content.
1223 $text = wfMsgForContent( 'newsectionheaderdefaultlevel', $this->sectiontitle
) . "\n\n" . $text;
1225 // Jump to the new section
1226 $result['sectionanchor'] = $wgParser->guessLegacySectionNameFromWikiText( $this->sectiontitle
);
1228 // If no edit summary was specified, create one automatically from the section
1229 // title and have it link to the new section. Otherwise, respect the summary as
1231 if ( $this->summary
=== '' ) {
1232 $cleanSectionTitle = $wgParser->stripSectionName( $this->sectiontitle
);
1233 $this->summary
= wfMsgForContent( 'newsectionsummary', $cleanSectionTitle );
1235 } elseif ( $this->summary
!== '' ) {
1236 // Insert the section title above the content.
1237 $text = wfMsgForContent( 'newsectionheaderdefaultlevel', $this->summary
) . "\n\n" . $text;
1239 // Jump to the new section
1240 $result['sectionanchor'] = $wgParser->guessLegacySectionNameFromWikiText( $this->summary
);
1242 // Create a link to the new section from the edit summary.
1243 $cleanSummary = $wgParser->stripSectionName( $this->summary
);
1244 $this->summary
= wfMsgForContent( 'newsectionsummary', $cleanSummary );
1248 $status->value
= self
::AS_SUCCESS_NEW_ARTICLE
;
1252 # Article exists. Check for edit conflict.
1254 $this->mArticle
->clear(); # Force reload of dates, etc.
1255 $timestamp = $this->mArticle
->getTimestamp();
1257 wfDebug( "timestamp: {$timestamp}, edittime: {$this->edittime}\n" );
1259 if ( $timestamp != $this->edittime
) {
1260 $this->isConflict
= true;
1261 if ( $this->section
== 'new' ) {
1262 if ( $this->mArticle
->getUserText() == $wgUser->getName() &&
1263 $this->mArticle
->getComment() == $this->summary
) {
1264 // Probably a duplicate submission of a new comment.
1265 // This can happen when squid resends a request after
1266 // a timeout but the first one actually went through.
1267 wfDebug( __METHOD__
. ": duplicate new section submission; trigger edit conflict!\n" );
1269 // New comment; suppress conflict.
1270 $this->isConflict
= false;
1271 wfDebug( __METHOD__
. ": conflict suppressed; new section\n" );
1273 } elseif ( $this->section
== '' && $this->userWasLastToEdit( $wgUser->getId(), $this->edittime
) ) {
1274 # Suppress edit conflict with self, except for section edits where merging is required.
1275 wfDebug( __METHOD__
. ": Suppressing edit conflict, same user.\n" );
1276 $this->isConflict
= false;
1280 // If sectiontitle is set, use it, otherwise use the summary as the section title (for
1281 // backwards compatibility with old forms/bots).
1282 if ( $this->sectiontitle
!== '' ) {
1283 $sectionTitle = $this->sectiontitle
;
1285 $sectionTitle = $this->summary
;
1288 if ( $this->isConflict
) {
1289 wfDebug( __METHOD__
. ": conflict! getting section '$this->section' for time '$this->edittime' (article time '{$timestamp}')\n" );
1290 $text = $this->mArticle
->replaceSection( $this->section
, $this->textbox1
, $sectionTitle, $this->edittime
);
1292 wfDebug( __METHOD__
. ": getting section '$this->section'\n" );
1293 $text = $this->mArticle
->replaceSection( $this->section
, $this->textbox1
, $sectionTitle );
1295 if ( is_null( $text ) ) {
1296 wfDebug( __METHOD__
. ": activating conflict; section replace failed.\n" );
1297 $this->isConflict
= true;
1298 $text = $this->textbox1
; // do not try to merge here!
1299 } elseif ( $this->isConflict
) {
1301 if ( $this->mergeChangesInto( $text ) ) {
1302 // Successful merge! Maybe we should tell the user the good news?
1303 $this->isConflict
= false;
1304 wfDebug( __METHOD__
. ": Suppressing edit conflict, successful merge.\n" );
1306 $this->section
= '';
1307 $this->textbox1
= $text;
1308 wfDebug( __METHOD__
. ": Keeping edit conflict, failed merge.\n" );
1312 if ( $this->isConflict
) {
1313 $status->setResult( false, self
::AS_CONFLICT_DETECTED
);
1314 wfProfileOut( __METHOD__
);
1318 // Run post-section-merge edit filter
1319 if ( !wfRunHooks( 'EditFilterMerged', array( $this, $text, &$this->hookError
, $this->summary
) ) ) {
1320 # Error messages etc. could be handled within the hook...
1321 $status->fatal( 'hookaborted' );
1322 $status->value
= self
::AS_HOOK_ERROR
;
1323 wfProfileOut( __METHOD__
);
1325 } elseif ( $this->hookError
!= '' ) {
1326 # ...or the hook could be expecting us to produce an error
1327 $status->fatal( 'hookaborted' );
1328 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1329 wfProfileOut( __METHOD__
);
1333 # Handle the user preference to force summaries here, but not for null edits
1334 if ( $this->section
!= 'new' && !$this->allowBlankSummary
1335 && $this->getOriginalContent() != $text
1336 && !Title
::newFromRedirect( $text ) ) # check if it's not a redirect
1338 if ( md5( $this->summary
) == $this->autoSumm
) {
1339 $this->missingSummary
= true;
1340 $status->fatal( 'missingsummary' );
1341 $status->value
= self
::AS_SUMMARY_NEEDED
;
1342 wfProfileOut( __METHOD__
);
1347 # And a similar thing for new sections
1348 if ( $this->section
== 'new' && !$this->allowBlankSummary
) {
1349 if ( trim( $this->summary
) == '' ) {
1350 $this->missingSummary
= true;
1351 $status->fatal( 'missingsummary' ); // or 'missingcommentheader' if $section == 'new'. Blegh
1352 $status->value
= self
::AS_SUMMARY_NEEDED
;
1353 wfProfileOut( __METHOD__
);
1359 wfProfileIn( __METHOD__
. '-sectionanchor' );
1360 $sectionanchor = '';
1361 if ( $this->section
== 'new' ) {
1362 if ( $this->textbox1
== '' ) {
1363 $this->missingComment
= true;
1364 $status->fatal( 'missingcommenttext' );
1365 $status->value
= self
::AS_TEXTBOX_EMPTY
;
1366 wfProfileOut( __METHOD__
. '-sectionanchor' );
1367 wfProfileOut( __METHOD__
);
1370 if ( $this->sectiontitle
!== '' ) {
1371 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $this->sectiontitle
);
1372 // If no edit summary was specified, create one automatically from the section
1373 // title and have it link to the new section. Otherwise, respect the summary as
1375 if ( $this->summary
=== '' ) {
1376 $cleanSectionTitle = $wgParser->stripSectionName( $this->sectiontitle
);
1377 $this->summary
= wfMsgForContent( 'newsectionsummary', $cleanSectionTitle );
1379 } elseif ( $this->summary
!== '' ) {
1380 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $this->summary
);
1381 # This is a new section, so create a link to the new section
1382 # in the revision summary.
1383 $cleanSummary = $wgParser->stripSectionName( $this->summary
);
1384 $this->summary
= wfMsgForContent( 'newsectionsummary', $cleanSummary );
1386 } elseif ( $this->section
!= '' ) {
1387 # Try to get a section anchor from the section source, redirect to edited section if header found
1388 # XXX: might be better to integrate this into Article::replaceSection
1389 # for duplicate heading checking and maybe parsing
1390 $hasmatch = preg_match( "/^ *([=]{1,6})(.*?)(\\1) *\\n/i", $this->textbox1
, $matches );
1391 # we can't deal with anchors, includes, html etc in the header for now,
1392 # headline would need to be parsed to improve this
1393 if ( $hasmatch && strlen( $matches[2] ) > 0 ) {
1394 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $matches[2] );
1397 $result['sectionanchor'] = $sectionanchor;
1398 wfProfileOut( __METHOD__
. '-sectionanchor' );
1400 // Save errors may fall down to the edit form, but we've now
1401 // merged the section into full text. Clear the section field
1402 // so that later submission of conflict forms won't try to
1403 // replace that into a duplicated mess.
1404 $this->textbox1
= $text;
1405 $this->section
= '';
1407 $status->value
= self
::AS_SUCCESS_UPDATE
;
1410 // Check for length errors again now that the section is merged in
1411 $this->kblength
= (int)( strlen( $text ) / 1024 );
1412 if ( $this->kblength
> $wgMaxArticleSize ) {
1413 $this->tooBig
= true;
1414 $status->setResult( false, self
::AS_MAX_ARTICLE_SIZE_EXCEEDED
);
1415 wfProfileOut( __METHOD__
);
1419 $flags = EDIT_DEFER_UPDATES | EDIT_AUTOSUMMARY |
1420 ( $new ? EDIT_NEW
: EDIT_UPDATE
) |
1421 ( ( $this->minoredit
&& !$this->isNew
) ? EDIT_MINOR
: 0 ) |
1422 ( $bot ? EDIT_FORCE_BOT
: 0 );
1424 $doEditStatus = $this->mArticle
->doEdit( $text, $this->summary
, $flags );
1426 if ( $doEditStatus->isOK() ) {
1427 $result['redirect'] = Title
::newFromRedirect( $text ) !== null;
1428 $this->commitWatch();
1429 wfProfileOut( __METHOD__
);
1432 $this->isConflict
= true;
1433 $doEditStatus->value
= self
::AS_END
; // Destroys data doEdit() put in $status->value but who cares
1434 wfProfileOut( __METHOD__
);
1435 return $doEditStatus;
1440 * Commit the change of watch status
1442 protected function commitWatch() {
1444 if ( $this->watchthis
xor $this->mTitle
->userIsWatching() ) {
1445 $dbw = wfGetDB( DB_MASTER
);
1446 $dbw->begin( __METHOD__
);
1447 if ( $this->watchthis
) {
1448 WatchAction
::doWatch( $this->mTitle
, $wgUser );
1450 WatchAction
::doUnwatch( $this->mTitle
, $wgUser );
1452 $dbw->commit( __METHOD__
);
1457 * Check if no edits were made by other users since
1458 * the time a user started editing the page. Limit to
1459 * 50 revisions for the sake of performance.
1462 * @param $edittime string
1466 protected function userWasLastToEdit( $id, $edittime ) {
1467 if ( !$id ) return false;
1468 $dbw = wfGetDB( DB_MASTER
);
1469 $res = $dbw->select( 'revision',
1472 'rev_page' => $this->mTitle
->getArticleID(),
1473 'rev_timestamp > ' . $dbw->addQuotes( $dbw->timestamp( $edittime ) )
1476 array( 'ORDER BY' => 'rev_timestamp ASC', 'LIMIT' => 50 ) );
1477 foreach ( $res as $row ) {
1478 if ( $row->rev_user
!= $id ) {
1489 * @parma $editText string
1493 function mergeChangesInto( &$editText ) {
1494 wfProfileIn( __METHOD__
);
1496 $db = wfGetDB( DB_MASTER
);
1498 // This is the revision the editor started from
1499 $baseRevision = $this->getBaseRevision();
1500 if ( is_null( $baseRevision ) ) {
1501 wfProfileOut( __METHOD__
);
1504 $baseText = $baseRevision->getText();
1506 // The current state, we want to merge updates into it
1507 $currentRevision = Revision
::loadFromTitle( $db, $this->mTitle
);
1508 if ( is_null( $currentRevision ) ) {
1509 wfProfileOut( __METHOD__
);
1512 $currentText = $currentRevision->getText();
1515 if ( wfMerge( $baseText, $editText, $currentText, $result ) ) {
1516 $editText = $result;
1517 wfProfileOut( __METHOD__
);
1520 wfProfileOut( __METHOD__
);
1528 function getBaseRevision() {
1529 if ( !$this->mBaseRevision
) {
1530 $db = wfGetDB( DB_MASTER
);
1531 $baseRevision = Revision
::loadFromTimestamp(
1532 $db, $this->mTitle
, $this->edittime
);
1533 return $this->mBaseRevision
= $baseRevision;
1535 return $this->mBaseRevision
;
1540 * Check given input text against $wgSpamRegex, and return the text of the first match.
1542 * @param $text string
1544 * @return string|bool matching string or false
1546 public static function matchSpamRegex( $text ) {
1547 global $wgSpamRegex;
1548 // For back compatibility, $wgSpamRegex may be a single string or an array of regexes.
1549 $regexes = (array)$wgSpamRegex;
1550 return self
::matchSpamRegexInternal( $text, $regexes );
1554 * Check given input text against $wgSpamRegex, and return the text of the first match.
1556 * @parma $text string
1558 * @return string|bool matching string or false
1560 public static function matchSummarySpamRegex( $text ) {
1561 global $wgSummarySpamRegex;
1562 $regexes = (array)$wgSummarySpamRegex;
1563 return self
::matchSpamRegexInternal( $text, $regexes );
1567 * @param $text string
1568 * @param $regexes array
1569 * @return bool|string
1571 protected static function matchSpamRegexInternal( $text, $regexes ) {
1572 foreach ( $regexes as $regex ) {
1574 if ( preg_match( $regex, $text, $matches ) ) {
1581 function setHeaders() {
1582 global $wgOut, $wgUser;
1584 $wgOut->addModules( 'mediawiki.action.edit' );
1586 if ( $wgUser->getOption( 'uselivepreview', false ) ) {
1587 $wgOut->addModules( 'mediawiki.legacy.preview' );
1589 // Bug #19334: textarea jumps when editing articles in IE8
1590 $wgOut->addStyle( 'common/IE80Fixes.css', 'screen', 'IE 8' );
1592 $wgOut->setRobotPolicy( 'noindex,nofollow' );
1594 # Enabled article-related sidebar, toplinks, etc.
1595 $wgOut->setArticleRelated( true );
1597 $contextTitle = $this->getContextTitle();
1598 if ( $this->isConflict
) {
1599 $msg = 'editconflict';
1600 } elseif ( $contextTitle->exists() && $this->section
!= '' ) {
1601 $msg = $this->section
== 'new' ?
'editingcomment' : 'editingsection';
1603 $msg = $contextTitle->exists() ||
( $contextTitle->getNamespace() == NS_MEDIAWIKI
&& $contextTitle->getDefaultMessageText() !== false ) ?
1604 'editing' : 'creating';
1606 # Use the title defined by DISPLAYTITLE magic word when present
1607 $displayTitle = isset( $this->mParserOutput
) ?
$this->mParserOutput
->getDisplayTitle() : false;
1608 if ( $displayTitle === false ) {
1609 $displayTitle = $contextTitle->getPrefixedText();
1611 $wgOut->setPageTitle( wfMessage( $msg, $displayTitle ) );
1615 * Show all applicable editing introductions
1617 protected function showIntro() {
1618 global $wgOut, $wgUser;
1619 if ( $this->suppressIntro
) {
1623 $namespace = $this->mTitle
->getNamespace();
1625 if ( $namespace == NS_MEDIAWIKI
) {
1626 # Show a warning if editing an interface message
1627 $wgOut->wrapWikiMsg( "<div class='mw-editinginterface'>\n$1\n</div>", 'editinginterface' );
1628 } else if( $namespace == NS_FILE
) {
1629 # Show a hint to shared repo
1630 $file = wfFindFile( $this->mTitle
);
1631 if( $file && !$file->isLocal() ) {
1632 $descUrl = $file->getDescriptionUrl();
1633 # there must be a description url to show a hint to shared repo
1635 if( !$this->mTitle
->exists() ) {
1636 $wgOut->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-create\">\n$1\n</div>", array (
1637 'sharedupload-desc-create', $file->getRepo()->getDisplayName(), $descUrl
1640 $wgOut->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-edit\">\n$1\n</div>", array(
1641 'sharedupload-desc-edit', $file->getRepo()->getDisplayName(), $descUrl
1648 # Show a warning message when someone creates/edits a user (talk) page but the user does not exist
1649 # Show log extract when the user is currently blocked
1650 if ( $namespace == NS_USER ||
$namespace == NS_USER_TALK
) {
1651 $parts = explode( '/', $this->mTitle
->getText(), 2 );
1652 $username = $parts[0];
1653 $user = User
::newFromName( $username, false /* allow IP users*/ );
1654 $ip = User
::isIP( $username );
1655 if ( !( $user && $user->isLoggedIn() ) && !$ip ) { # User does not exist
1656 $wgOut->wrapWikiMsg( "<div class=\"mw-userpage-userdoesnotexist error\">\n$1\n</div>",
1657 array( 'userpage-userdoesnotexist', wfEscapeWikiText( $username ) ) );
1658 } elseif ( $user->isBlocked() ) { # Show log extract if the user is currently blocked
1659 LogEventsList
::showLogExtract(
1662 $user->getUserPage(),
1666 'showIfEmpty' => false,
1668 'blocked-notice-logextract',
1669 $user->getName() # Support GENDER in notice
1675 # Try to add a custom edit intro, or use the standard one if this is not possible.
1676 if ( !$this->showCustomIntro() && !$this->mTitle
->exists() ) {
1677 if ( $wgUser->isLoggedIn() ) {
1678 $wgOut->wrapWikiMsg( "<div class=\"mw-newarticletext\">\n$1\n</div>", 'newarticletext' );
1680 $wgOut->wrapWikiMsg( "<div class=\"mw-newarticletextanon\">\n$1\n</div>", 'newarticletextanon' );
1683 # Give a notice if the user is editing a deleted/moved page...
1684 if ( !$this->mTitle
->exists() ) {
1685 LogEventsList
::showLogExtract( $wgOut, array( 'delete', 'move' ), $this->mTitle
,
1686 '', array( 'lim' => 10,
1687 'conds' => array( "log_action != 'revision'" ),
1688 'showIfEmpty' => false,
1689 'msgKey' => array( 'recreate-moveddeleted-warn' ) )
1695 * Attempt to show a custom editing introduction, if supplied
1699 protected function showCustomIntro() {
1700 if ( $this->editintro
) {
1701 $title = Title
::newFromText( $this->editintro
);
1702 if ( $title instanceof Title
&& $title->exists() && $title->userCan( 'read' ) ) {
1704 // Added using template syntax, to take <noinclude>'s into account.
1705 $wgOut->addWikiTextTitleTidy( '{{:' . $title->getFullText() . '}}', $this->mTitle
);
1716 * Send the edit form and related headers to $wgOut
1717 * @param $formCallback Callback that takes an OutputPage parameter; will be called
1718 * during form output near the top, for captchas and the like.
1720 function showEditForm( $formCallback = null ) {
1721 global $wgOut, $wgUser;
1723 wfProfileIn( __METHOD__
);
1725 # need to parse the preview early so that we know which templates are used,
1726 # otherwise users with "show preview after edit box" will get a blank list
1727 # we parse this near the beginning so that setHeaders can do the title
1728 # setting work instead of leaving it in getPreviewText
1729 $previewOutput = '';
1730 if ( $this->formtype
== 'preview' ) {
1731 $previewOutput = $this->getPreviewText();
1734 wfRunHooks( 'EditPage::showEditForm:initial', array( &$this, &$wgOut ) );
1736 $this->setHeaders();
1738 if ( $this->showHeader() === false ) {
1739 wfProfileOut( __METHOD__
);
1743 $wgOut->addHTML( $this->editFormPageTop
);
1745 if ( $wgUser->getOption( 'previewontop' ) ) {
1746 $this->displayPreviewArea( $previewOutput, true );
1749 $wgOut->addHTML( $this->editFormTextTop
);
1751 $showToolbar = true;
1752 if ( $this->wasDeletedSinceLastEdit() ) {
1753 if ( $this->formtype
== 'save' ) {
1754 // Hide the toolbar and edit area, user can click preview to get it back
1755 // Add an confirmation checkbox and explanation.
1756 $showToolbar = false;
1758 $wgOut->wrapWikiMsg( "<div class='error mw-deleted-while-editing'>\n$1\n</div>",
1759 'deletedwhileediting' );
1763 $wgOut->addHTML( Html
::openElement( 'form', array( 'id' => self
::EDITFORM_ID
, 'name' => self
::EDITFORM_ID
,
1764 'method' => 'post', 'action' => $this->getActionURL( $this->getContextTitle() ),
1765 'enctype' => 'multipart/form-data' ) ) );
1767 if ( is_callable( $formCallback ) ) {
1768 call_user_func_array( $formCallback, array( &$wgOut ) );
1771 wfRunHooks( 'EditPage::showEditForm:fields', array( &$this, &$wgOut ) );
1773 // Put these up at the top to ensure they aren't lost on early form submission
1774 $this->showFormBeforeText();
1776 if ( $this->wasDeletedSinceLastEdit() && 'save' == $this->formtype
) {
1777 $username = $this->lastDelete
->user_name
;
1778 $comment = $this->lastDelete
->log_comment
;
1780 // It is better to not parse the comment at all than to have templates expanded in the middle
1781 // TODO: can the checkLabel be moved outside of the div so that wrapWikiMsg could be used?
1782 $key = $comment === ''
1783 ?
'confirmrecreate-noreason'
1784 : 'confirmrecreate';
1786 '<div class="mw-confirm-recreate">' .
1787 wfMsgExt( $key, 'parseinline', $username, "<nowiki>$comment</nowiki>" ) .
1788 Xml
::checkLabel( wfMsg( 'recreate' ), 'wpRecreate', 'wpRecreate', false,
1789 array( 'title' => Linker
::titleAttrib( 'recreate' ), 'tabindex' => 1, 'id' => 'wpRecreate' )
1795 # When the summary is hidden, also hide them on preview/show changes
1796 if( $this->nosummary
) {
1797 $wgOut->addHTML( Html
::hidden( 'nosummary', true ) );
1800 # If a blank edit summary was previously provided, and the appropriate
1801 # user preference is active, pass a hidden tag as wpIgnoreBlankSummary. This will stop the
1802 # user being bounced back more than once in the event that a summary
1805 # For a bit more sophisticated detection of blank summaries, hash the
1806 # automatic one and pass that in the hidden field wpAutoSummary.
1807 if ( $this->missingSummary ||
( $this->section
== 'new' && $this->nosummary
) ) {
1808 $wgOut->addHTML( Html
::hidden( 'wpIgnoreBlankSummary', true ) );
1811 if ( $this->hasPresetSummary
) {
1812 // If a summary has been preset using &summary= we dont want to prompt for
1813 // a different summary. Only prompt for a summary if the summary is blanked.
1815 $this->autoSumm
= md5( '' );
1818 $autosumm = $this->autoSumm ?
$this->autoSumm
: md5( $this->summary
);
1819 $wgOut->addHTML( Html
::hidden( 'wpAutoSummary', $autosumm ) );
1821 $wgOut->addHTML( Html
::hidden( 'oldid', $this->oldid
) );
1823 if ( $this->section
== 'new' ) {
1824 $this->showSummaryInput( true, $this->summary
);
1825 $wgOut->addHTML( $this->getSummaryPreview( true, $this->summary
) );
1828 $wgOut->addHTML( $this->editFormTextBeforeContent
);
1830 if ( !$this->isCssJsSubpage
&& $showToolbar && $wgUser->getOption( 'showtoolbar' ) ) {
1831 $wgOut->addHTML( EditPage
::getEditToolbar() );
1834 if ( $this->isConflict
) {
1835 // In an edit conflict bypass the overrideable content form method
1836 // and fallback to the raw wpTextbox1 since editconflicts can't be
1837 // resolved between page source edits and custom ui edits using the
1839 $this->textbox2
= $this->textbox1
;
1840 $this->textbox1
= $this->getCurrentText();
1842 $this->showTextbox1();
1844 $this->showContentForm();
1847 $wgOut->addHTML( $this->editFormTextAfterContent
);
1849 $wgOut->addWikiText( $this->getCopywarn() );
1851 $wgOut->addHTML( $this->editFormTextAfterWarn
);
1853 $this->showStandardInputs();
1855 $this->showFormAfterText();
1857 $this->showTosSummary();
1859 $this->showEditTools();
1861 $wgOut->addHTML( $this->editFormTextAfterTools
. "\n" );
1863 $wgOut->addHTML( Html
::rawElement( 'div', array( 'class' => 'templatesUsed' ),
1864 Linker
::formatTemplates( $this->getTemplates(), $this->preview
, $this->section
!= '' ) ) );
1866 $wgOut->addHTML( Html
::rawElement( 'div', array( 'class' => 'hiddencats' ),
1867 Linker
::formatHiddenCategories( $this->mArticle
->getHiddenCategories() ) ) );
1869 if ( $this->isConflict
) {
1870 $this->showConflict();
1873 $wgOut->addHTML( $this->editFormTextBottom
. "\n</form>\n" );
1875 if ( !$wgUser->getOption( 'previewontop' ) ) {
1876 $this->displayPreviewArea( $previewOutput, false );
1879 wfProfileOut( __METHOD__
);
1883 * Extract the section title from current section text, if any.
1885 * @param string $text
1886 * @return Mixed|string or false
1888 public static function extractSectionTitle( $text ) {
1889 preg_match( "/^(=+)(.+)\\1\\s*(\n|$)/i", $text, $matches );
1890 if ( !empty( $matches[2] ) ) {
1892 return $wgParser->stripSectionName( trim( $matches[2] ) );
1898 protected function showHeader() {
1899 global $wgOut, $wgUser, $wgMaxArticleSize, $wgLang;
1901 if ( $this->mTitle
->isTalkPage() ) {
1902 $wgOut->addWikiMsg( 'talkpagetext' );
1905 # Optional notices on a per-namespace and per-page basis
1906 $editnotice_ns = 'editnotice-' . $this->mTitle
->getNamespace();
1907 $editnotice_ns_message = wfMessage( $editnotice_ns );
1908 if ( $editnotice_ns_message->exists() ) {
1909 $wgOut->addWikiText( $editnotice_ns_message->plain() );
1911 if ( MWNamespace
::hasSubpages( $this->mTitle
->getNamespace() ) ) {
1912 $parts = explode( '/', $this->mTitle
->getDBkey() );
1913 $editnotice_base = $editnotice_ns;
1914 while ( count( $parts ) > 0 ) {
1915 $editnotice_base .= '-' . array_shift( $parts );
1916 $editnotice_base_msg = wfMessage( $editnotice_base );
1917 if ( $editnotice_base_msg->exists() ) {
1918 $wgOut->addWikiText( $editnotice_base_msg->plain() );
1922 # Even if there are no subpages in namespace, we still don't want / in MW ns.
1923 $editnoticeText = $editnotice_ns . '-' . str_replace( '/', '-', $this->mTitle
->getDBkey() );
1924 $editnoticeMsg = wfMessage( $editnoticeText );
1925 if ( $editnoticeMsg->exists() ) {
1926 $wgOut->addWikiText( $editnoticeMsg->plain() );
1930 if ( $this->isConflict
) {
1931 $wgOut->wrapWikiMsg( "<div class='mw-explainconflict'>\n$1\n</div>", 'explainconflict' );
1932 $this->edittime
= $this->mArticle
->getTimestamp();
1934 if ( $this->section
!= '' && !$this->isSectionEditSupported() ) {
1935 // We use $this->section to much before this and getVal('wgSection') directly in other places
1936 // at this point we can't reset $this->section to '' to fallback to non-section editing.
1937 // Someone is welcome to try refactoring though
1938 $wgOut->showErrorPage( 'sectioneditnotsupported-title', 'sectioneditnotsupported-text' );
1942 if ( $this->section
!= '' && $this->section
!= 'new' ) {
1943 if ( !$this->summary
&& !$this->preview
&& !$this->diff
) {
1944 $sectionTitle = self
::extractSectionTitle( $this->textbox1
);
1945 if ( $sectionTitle !== false ) {
1946 $this->summary
= "/* $sectionTitle */ ";
1951 if ( $this->missingComment
) {
1952 $wgOut->wrapWikiMsg( "<div id='mw-missingcommenttext'>\n$1\n</div>", 'missingcommenttext' );
1955 if ( $this->missingSummary
&& $this->section
!= 'new' ) {
1956 $wgOut->wrapWikiMsg( "<div id='mw-missingsummary'>\n$1\n</div>", 'missingsummary' );
1959 if ( $this->missingSummary
&& $this->section
== 'new' ) {
1960 $wgOut->wrapWikiMsg( "<div id='mw-missingcommentheader'>\n$1\n</div>", 'missingcommentheader' );
1963 if ( $this->hookError
!== '' ) {
1964 $wgOut->addWikiText( $this->hookError
);
1967 if ( !$this->checkUnicodeCompliantBrowser() ) {
1968 $wgOut->addWikiMsg( 'nonunicodebrowser' );
1971 if ( $this->section
!= 'new' ) {
1972 $revision = $this->mArticle
->getRevisionFetched();
1974 // Let sysop know that this will make private content public if saved
1976 if ( !$revision->userCan( Revision
::DELETED_TEXT
) ) {
1977 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n", 'rev-deleted-text-permission' );
1978 } elseif ( $revision->isDeleted( Revision
::DELETED_TEXT
) ) {
1979 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n", 'rev-deleted-text-view' );
1982 if ( !$revision->isCurrent() ) {
1983 $this->mArticle
->setOldSubtitle( $revision->getId() );
1984 $wgOut->addWikiMsg( 'editingold' );
1986 } elseif ( $this->mTitle
->exists() ) {
1987 // Something went wrong
1989 $wgOut->wrapWikiMsg( "<div class='errorbox'>\n$1\n</div>\n",
1990 array( 'missing-article', $this->mTitle
->getPrefixedText(),
1991 wfMsgNoTrans( 'missingarticle-rev', $this->oldid
) ) );
1996 if ( wfReadOnly() ) {
1997 $wgOut->wrapWikiMsg( "<div id=\"mw-read-only-warning\">\n$1\n</div>", array( 'readonlywarning', wfReadOnlyReason() ) );
1998 } elseif ( $wgUser->isAnon() ) {
1999 if ( $this->formtype
!= 'preview' ) {
2000 $wgOut->wrapWikiMsg( "<div id=\"mw-anon-edit-warning\">\n$1</div>", 'anoneditwarning' );
2002 $wgOut->wrapWikiMsg( "<div id=\"mw-anon-preview-warning\">\n$1</div>", 'anonpreviewwarning' );
2005 if ( $this->isCssJsSubpage
) {
2006 # Check the skin exists
2007 if ( $this->isWrongCaseCssJsPage
) {
2008 $wgOut->wrapWikiMsg( "<div class='error' id='mw-userinvalidcssjstitle'>\n$1\n</div>", array( 'userinvalidcssjstitle', $this->mTitle
->getSkinFromCssJsSubpage() ) );
2010 if ( $this->formtype
!== 'preview' ) {
2011 if ( $this->isCssSubpage
)
2012 $wgOut->wrapWikiMsg( "<div id='mw-usercssyoucanpreview'>\n$1\n</div>", array( 'usercssyoucanpreview' ) );
2013 if ( $this->isJsSubpage
)
2014 $wgOut->wrapWikiMsg( "<div id='mw-userjsyoucanpreview'>\n$1\n</div>", array( 'userjsyoucanpreview' ) );
2019 if ( $this->mTitle
->getNamespace() != NS_MEDIAWIKI
&& $this->mTitle
->isProtected( 'edit' ) ) {
2020 # Is the title semi-protected?
2021 if ( $this->mTitle
->isSemiProtected() ) {
2022 $noticeMsg = 'semiprotectedpagewarning';
2024 # Then it must be protected based on static groups (regular)
2025 $noticeMsg = 'protectedpagewarning';
2027 LogEventsList
::showLogExtract( $wgOut, 'protect', $this->mTitle
, '',
2028 array( 'lim' => 1, 'msgKey' => array( $noticeMsg ) ) );
2030 if ( $this->mTitle
->isCascadeProtected() ) {
2031 # Is this page under cascading protection from some source pages?
2032 list( $cascadeSources, /* $restrictions */ ) = $this->mTitle
->getCascadeProtectionSources();
2033 $notice = "<div class='mw-cascadeprotectedwarning'>\n$1\n";
2034 $cascadeSourcesCount = count( $cascadeSources );
2035 if ( $cascadeSourcesCount > 0 ) {
2036 # Explain, and list the titles responsible
2037 foreach ( $cascadeSources as $page ) {
2038 $notice .= '* [[:' . $page->getPrefixedText() . "]]\n";
2041 $notice .= '</div>';
2042 $wgOut->wrapWikiMsg( $notice, array( 'cascadeprotectedwarning', $cascadeSourcesCount ) );
2044 if ( !$this->mTitle
->exists() && $this->mTitle
->getRestrictions( 'create' ) ) {
2045 LogEventsList
::showLogExtract( $wgOut, 'protect', $this->mTitle
, '',
2047 'showIfEmpty' => false,
2048 'msgKey' => array( 'titleprotectedwarning' ),
2049 'wrap' => "<div class=\"mw-titleprotectedwarning\">\n$1</div>" ) );
2052 if ( $this->kblength
=== false ) {
2053 $this->kblength
= (int)( strlen( $this->textbox1
) / 1024 );
2056 if ( $this->tooBig ||
$this->kblength
> $wgMaxArticleSize ) {
2057 $wgOut->wrapWikiMsg( "<div class='error' id='mw-edit-longpageerror'>\n$1\n</div>",
2058 array( 'longpageerror', $wgLang->formatNum( $this->kblength
), $wgLang->formatNum( $wgMaxArticleSize ) ) );
2060 if ( !wfMessage( 'longpage-hint' )->isDisabled() ) {
2061 $wgOut->wrapWikiMsg( "<div id='mw-edit-longpage-hint'>\n$1\n</div>",
2062 array( 'longpage-hint', $wgLang->formatSize( strlen( $this->textbox1
) ), strlen( $this->textbox1
) )
2069 * Standard summary input and label (wgSummary), abstracted so EditPage
2070 * subclasses may reorganize the form.
2071 * Note that you do not need to worry about the label's for=, it will be
2072 * inferred by the id given to the input. You can remove them both by
2073 * passing array( 'id' => false ) to $userInputAttrs.
2075 * @param $summary string The value of the summary input
2076 * @param $labelText string The html to place inside the label
2077 * @param $inputAttrs array of attrs to use on the input
2078 * @param $spanLabelAttrs array of attrs to use on the span inside the label
2080 * @return array An array in the format array( $label, $input )
2082 function getSummaryInput( $summary = "", $labelText = null, $inputAttrs = null, $spanLabelAttrs = null ) {
2083 // Note: the maxlength is overriden in JS to 250 and to make it use UTF-8 bytes, not characters.
2084 $inputAttrs = ( is_array( $inputAttrs ) ?
$inputAttrs : array() ) +
array(
2085 'id' => 'wpSummary',
2086 'maxlength' => '200',
2089 'spellcheck' => 'true',
2090 ) + Linker
::tooltipAndAccesskeyAttribs( 'summary' );
2092 $spanLabelAttrs = ( is_array( $spanLabelAttrs ) ?
$spanLabelAttrs : array() ) +
array(
2093 'class' => $this->missingSummary ?
'mw-summarymissed' : 'mw-summary',
2094 'id' => "wpSummaryLabel"
2099 $label = Xml
::tags( 'label', $inputAttrs['id'] ?
array( 'for' => $inputAttrs['id'] ) : null, $labelText );
2100 $label = Xml
::tags( 'span', $spanLabelAttrs, $label );
2103 $input = Html
::input( 'wpSummary', $summary, 'text', $inputAttrs );
2105 return array( $label, $input );
2109 * @param $isSubjectPreview Boolean: true if this is the section subject/title
2110 * up top, or false if this is the comment summary
2111 * down below the textarea
2112 * @param $summary String: The text of the summary to display
2115 protected function showSummaryInput( $isSubjectPreview, $summary = "" ) {
2116 global $wgOut, $wgContLang;
2117 # Add a class if 'missingsummary' is triggered to allow styling of the summary line
2118 $summaryClass = $this->missingSummary ?
'mw-summarymissed' : 'mw-summary';
2119 if ( $isSubjectPreview ) {
2120 if ( $this->nosummary
) {
2124 if ( !$this->mShowSummaryField
) {
2128 $summary = $wgContLang->recodeForEdit( $summary );
2129 $labelText = wfMsgExt( $isSubjectPreview ?
'subject' : 'summary', 'parseinline' );
2130 list( $label, $input ) = $this->getSummaryInput( $summary, $labelText, array( 'class' => $summaryClass ), array() );
2131 $wgOut->addHTML( "{$label} {$input}" );
2135 * @param $isSubjectPreview Boolean: true if this is the section subject/title
2136 * up top, or false if this is the comment summary
2137 * down below the textarea
2138 * @param $summary String: the text of the summary to display
2141 protected function getSummaryPreview( $isSubjectPreview, $summary = "" ) {
2142 if ( !$summary ||
( !$this->preview
&& !$this->diff
) )
2147 if ( $isSubjectPreview )
2148 $summary = wfMsgForContent( 'newsectionsummary', $wgParser->stripSectionName( $summary ) );
2150 $message = $isSubjectPreview ?
'subject-preview' : 'summary-preview';
2152 $summary = wfMsgExt( $message, 'parseinline' ) . Linker
::commentBlock( $summary, $this->mTitle
, $isSubjectPreview );
2153 return Xml
::tags( 'div', array( 'class' => 'mw-summary-preview' ), $summary );
2156 protected function showFormBeforeText() {
2158 $section = htmlspecialchars( $this->section
);
2159 $wgOut->addHTML( <<<HTML
2160 <input type='hidden' value="{$section}" name="wpSection" />
2161 <input type='hidden' value="{$this->starttime}" name="wpStarttime" />
2162 <input type='hidden' value="{$this->edittime}" name="wpEdittime" />
2163 <input type='hidden' value="{$this->scrolltop}" name="wpScrolltop" id="wpScrolltop" />
2167 if ( !$this->checkUnicodeCompliantBrowser() )
2168 $wgOut->addHTML( Html
::hidden( 'safemode', '1' ) );
2171 protected function showFormAfterText() {
2172 global $wgOut, $wgUser;
2174 * To make it harder for someone to slip a user a page
2175 * which submits an edit form to the wiki without their
2176 * knowledge, a random token is associated with the login
2177 * session. If it's not passed back with the submission,
2178 * we won't save the page, or render user JavaScript and
2181 * For anon editors, who may not have a session, we just
2182 * include the constant suffix to prevent editing from
2183 * broken text-mangling proxies.
2185 $wgOut->addHTML( "\n" . Html
::hidden( "wpEditToken", $wgUser->getEditToken() ) . "\n" );
2189 * Subpage overridable method for printing the form for page content editing
2190 * By default this simply outputs wpTextbox1
2191 * Subclasses can override this to provide a custom UI for editing;
2192 * be it a form, or simply wpTextbox1 with a modified content that will be
2193 * reverse modified when extracted from the post data.
2194 * Note that this is basically the inverse for importContentFormData
2196 protected function showContentForm() {
2197 $this->showTextbox1();
2201 * Method to output wpTextbox1
2202 * The $textoverride method can be used by subclasses overriding showContentForm
2203 * to pass back to this method.
2205 * @param $customAttribs array of html attributes to use in the textarea
2206 * @param $textoverride String: optional text to override $this->textarea1 with
2208 protected function showTextbox1( $customAttribs = null, $textoverride = null ) {
2209 if ( $this->wasDeletedSinceLastEdit() && $this->formtype
== 'save' ) {
2210 $attribs = array( 'style' => 'display:none;' );
2212 $classes = array(); // Textarea CSS
2213 if ( $this->mTitle
->getNamespace() != NS_MEDIAWIKI
&& $this->mTitle
->isProtected( 'edit' ) ) {
2214 # Is the title semi-protected?
2215 if ( $this->mTitle
->isSemiProtected() ) {
2216 $classes[] = 'mw-textarea-sprotected';
2218 # Then it must be protected based on static groups (regular)
2219 $classes[] = 'mw-textarea-protected';
2221 # Is the title cascade-protected?
2222 if ( $this->mTitle
->isCascadeProtected() ) {
2223 $classes[] = 'mw-textarea-cprotected';
2227 $attribs = array( 'tabindex' => 1 );
2229 if ( is_array( $customAttribs ) ) {
2230 $attribs +
= $customAttribs;
2233 if ( count( $classes ) ) {
2234 if ( isset( $attribs['class'] ) ) {
2235 $classes[] = $attribs['class'];
2237 $attribs['class'] = implode( ' ', $classes );
2241 $this->showTextbox( $textoverride !== null ?
$textoverride : $this->textbox1
, 'wpTextbox1', $attribs );
2244 protected function showTextbox2() {
2245 $this->showTextbox( $this->textbox2
, 'wpTextbox2', array( 'tabindex' => 6, 'readonly' ) );
2248 protected function showTextbox( $content, $name, $customAttribs = array() ) {
2249 global $wgOut, $wgUser;
2251 $wikitext = $this->safeUnicodeOutput( $content );
2252 if ( strval( $wikitext ) !== '' ) {
2253 // Ensure there's a newline at the end, otherwise adding lines
2255 // But don't add a newline if the ext is empty, or Firefox in XHTML
2256 // mode will show an extra newline. A bit annoying.
2260 $attribs = $customAttribs +
array(
2263 'cols' => $wgUser->getIntOption( 'cols' ),
2264 'rows' => $wgUser->getIntOption( 'rows' ),
2265 'style' => '' // avoid php notices when appending preferences (appending allows customAttribs['style'] to still work
2268 $pageLang = $this->mTitle
->getPageLanguage();
2269 $attribs['lang'] = $pageLang->getCode();
2270 $attribs['dir'] = $pageLang->getDir();
2272 $wgOut->addHTML( Html
::textarea( $name, $wikitext, $attribs ) );
2275 protected function displayPreviewArea( $previewOutput, $isOnTop = false ) {
2279 $classes[] = 'ontop';
2281 $attribs = array( 'id' => 'wikiPreview', 'class' => implode( ' ', $classes ) );
2283 if ( $this->formtype
!= 'preview' )
2284 $attribs['style'] = 'display: none;';
2286 $wgOut->addHTML( Xml
::openElement( 'div', $attribs ) );
2288 if ( $this->formtype
== 'preview' ) {
2289 $this->showPreview( $previewOutput );
2292 $wgOut->addHTML( '</div>' );
2294 if ( $this->formtype
== 'diff' ) {
2300 * Append preview output to $wgOut.
2301 * Includes category rendering if this is a category page.
2303 * @param $text String: the HTML to be output for the preview.
2305 protected function showPreview( $text ) {
2307 if ( $this->mTitle
->getNamespace() == NS_CATEGORY
) {
2308 $this->mArticle
->openShowCategory();
2310 # This hook seems slightly odd here, but makes things more
2311 # consistent for extensions.
2312 wfRunHooks( 'OutputPageBeforeHTML', array( &$wgOut, &$text ) );
2313 $wgOut->addHTML( $text );
2314 if ( $this->mTitle
->getNamespace() == NS_CATEGORY
) {
2315 $this->mArticle
->closeShowCategory();
2320 * Get a diff between the current contents of the edit box and the
2321 * version of the page we're editing from.
2323 * If this is a section edit, we'll replace the section as for final
2324 * save and then make a comparison.
2326 function showDiff() {
2327 global $wgUser, $wgContLang, $wgParser, $wgOut;
2329 $oldtitlemsg = 'currentrev';
2330 # if message does not exist, show diff against the preloaded default
2331 if( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
&& !$this->mTitle
->exists() ) {
2332 $oldtext = $this->mTitle
->getDefaultMessageText();
2333 if( $oldtext !== false ) {
2334 $oldtitlemsg = 'defaultmessagetext';
2337 $oldtext = $this->mArticle
->getRawText();
2339 $newtext = $this->mArticle
->replaceSection(
2340 $this->section
, $this->textbox1
, $this->summary
, $this->edittime
);
2342 wfRunHooks( 'EditPageGetDiffText', array( $this, &$newtext ) );
2344 $popts = ParserOptions
::newFromUserAndLang( $wgUser, $wgContLang );
2345 $newtext = $wgParser->preSaveTransform( $newtext, $this->mTitle
, $wgUser, $popts );
2347 if ( $oldtext !== false ||
$newtext != '' ) {
2348 $oldtitle = wfMsgExt( $oldtitlemsg, array( 'parseinline' ) );
2349 $newtitle = wfMsgExt( 'yourtext', array( 'parseinline' ) );
2351 $de = new DifferenceEngine( $this->mArticle
->getContext() );
2352 $de->setText( $oldtext, $newtext );
2353 $difftext = $de->getDiff( $oldtitle, $newtitle );
2354 $de->showDiffStyle();
2359 $wgOut->addHTML( '<div id="wikiDiff">' . $difftext . '</div>' );
2363 * Give a chance for site and per-namespace customizations of
2364 * terms of service summary link that might exist separately
2365 * from the copyright notice.
2367 * This will display between the save button and the edit tools,
2368 * so should remain short!
2370 protected function showTosSummary() {
2371 $msg = 'editpage-tos-summary';
2372 wfRunHooks( 'EditPageTosSummary', array( $this->mTitle
, &$msg ) );
2373 if ( !wfMessage( $msg )->isDisabled() ) {
2375 $wgOut->addHTML( '<div class="mw-tos-summary">' );
2376 $wgOut->addWikiMsg( $msg );
2377 $wgOut->addHTML( '</div>' );
2381 protected function showEditTools() {
2383 $wgOut->addHTML( '<div class="mw-editTools">' .
2384 wfMessage( 'edittools' )->inContentLanguage()->parse() .
2388 protected function getCopywarn() {
2389 global $wgRightsText;
2390 if ( $wgRightsText ) {
2391 $copywarnMsg = array( 'copyrightwarning',
2392 '[[' . wfMsgForContent( 'copyrightpage' ) . ']]',
2395 $copywarnMsg = array( 'copyrightwarning2',
2396 '[[' . wfMsgForContent( 'copyrightpage' ) . ']]' );
2398 // Allow for site and per-namespace customization of contribution/copyright notice.
2399 wfRunHooks( 'EditPageCopyrightWarning', array( $this->mTitle
, &$copywarnMsg ) );
2401 return "<div id=\"editpage-copywarn\">\n" .
2402 call_user_func_array( "wfMsgNoTrans", $copywarnMsg ) . "\n</div>";
2405 protected function showStandardInputs( &$tabindex = 2 ) {
2407 $wgOut->addHTML( "<div class='editOptions'>\n" );
2409 if ( $this->section
!= 'new' ) {
2410 $this->showSummaryInput( false, $this->summary
);
2411 $wgOut->addHTML( $this->getSummaryPreview( false, $this->summary
) );
2414 $checkboxes = $this->getCheckboxes( $tabindex,
2415 array( 'minor' => $this->minoredit
, 'watch' => $this->watchthis
) );
2416 $wgOut->addHTML( "<div class='editCheckboxes'>" . implode( $checkboxes, "\n" ) . "</div>\n" );
2417 $wgOut->addHTML( "<div class='editButtons'>\n" );
2418 $wgOut->addHTML( implode( $this->getEditButtons( $tabindex ), "\n" ) . "\n" );
2420 $cancel = $this->getCancelLink();
2421 if ( $cancel !== '' ) {
2422 $cancel .= wfMsgExt( 'pipe-separator' , 'escapenoentities' );
2424 $edithelpurl = Skin
::makeInternalOrExternalUrl( wfMsgForContent( 'edithelppage' ) );
2425 $edithelp = '<a target="helpwindow" href="' . $edithelpurl . '">' .
2426 htmlspecialchars( wfMsg( 'edithelp' ) ) . '</a> ' .
2427 htmlspecialchars( wfMsg( 'newwindow' ) );
2428 $wgOut->addHTML( " <span class='editHelp'>{$cancel}{$edithelp}</span>\n" );
2429 $wgOut->addHTML( "</div><!-- editButtons -->\n</div><!-- editOptions -->\n" );
2433 * Show an edit conflict. textbox1 is already shown in showEditForm().
2434 * If you want to use another entry point to this function, be careful.
2436 protected function showConflict() {
2439 if ( wfRunHooks( 'EditPageBeforeConflictDiff', array( &$this, &$wgOut ) ) ) {
2440 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
2442 $de = new DifferenceEngine( $this->mArticle
->getContext() );
2443 $de->setText( $this->textbox2
, $this->textbox1
);
2444 $de->showDiff( wfMsgExt( 'yourtext', 'parseinline' ), wfMsg( 'storedversion' ) );
2446 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
2447 $this->showTextbox2();
2454 public function getCancelLink() {
2455 $cancelParams = array();
2456 if ( !$this->isConflict
&& $this->oldid
> 0 ) {
2457 $cancelParams['oldid'] = $this->oldid
;
2460 return Linker
::linkKnown(
2461 $this->getContextTitle(),
2462 wfMsgExt( 'cancel', array( 'parseinline' ) ),
2463 array( 'id' => 'mw-editform-cancel' ),
2469 * Returns the URL to use in the form's action attribute.
2470 * This is used by EditPage subclasses when simply customizing the action
2471 * variable in the constructor is not enough. This can be used when the
2472 * EditPage lives inside of a Special page rather than a custom page action.
2474 * @param $title Title object for which is being edited (where we go to for &action= links)
2477 protected function getActionURL( Title
$title ) {
2478 return $title->getLocalURL( array( 'action' => $this->action
) );
2482 * Check if a page was deleted while the user was editing it, before submit.
2483 * Note that we rely on the logging table, which hasn't been always there,
2484 * but that doesn't matter, because this only applies to brand new
2487 protected function wasDeletedSinceLastEdit() {
2488 if ( $this->deletedSinceEdit
!== null ) {
2489 return $this->deletedSinceEdit
;
2492 $this->deletedSinceEdit
= false;
2494 if ( $this->mTitle
->isDeletedQuick() ) {
2495 $this->lastDelete
= $this->getLastDelete();
2496 if ( $this->lastDelete
) {
2497 $deleteTime = wfTimestamp( TS_MW
, $this->lastDelete
->log_timestamp
);
2498 if ( $deleteTime > $this->starttime
) {
2499 $this->deletedSinceEdit
= true;
2504 return $this->deletedSinceEdit
;
2507 protected function getLastDelete() {
2508 $dbr = wfGetDB( DB_SLAVE
);
2509 $data = $dbr->selectRow(
2510 array( 'logging', 'user' ),
2521 array( 'log_namespace' => $this->mTitle
->getNamespace(),
2522 'log_title' => $this->mTitle
->getDBkey(),
2523 'log_type' => 'delete',
2524 'log_action' => 'delete',
2525 'user_id=log_user' ),
2527 array( 'LIMIT' => 1, 'ORDER BY' => 'log_timestamp DESC' )
2529 // Quick paranoid permission checks...
2530 if ( is_object( $data ) ) {
2531 if ( $data->log_deleted
& LogPage
::DELETED_USER
)
2532 $data->user_name
= wfMsgHtml( 'rev-deleted-user' );
2533 if ( $data->log_deleted
& LogPage
::DELETED_COMMENT
)
2534 $data->log_comment
= wfMsgHtml( 'rev-deleted-comment' );
2540 * Get the rendered text for previewing.
2543 function getPreviewText() {
2544 global $wgOut, $wgUser, $wgParser, $wgRawHtml, $wgLang;
2546 wfProfileIn( __METHOD__
);
2548 if ( $wgRawHtml && !$this->mTokenOk
) {
2549 // Could be an offsite preview attempt. This is very unsafe if
2550 // HTML is enabled, as it could be an attack.
2552 if ( $this->textbox1
!== '' ) {
2553 // Do not put big scary notice, if previewing the empty
2554 // string, which happens when you initially edit
2555 // a category page, due to automatic preview-on-open.
2556 $parsedNote = $wgOut->parse( "<div class='previewnote'>" .
2557 wfMsg( 'session_fail_preview_html' ) . "</div>", true, /* interface */true );
2559 wfProfileOut( __METHOD__
);
2563 if ( $this->mTriedSave
&& !$this->mTokenOk
) {
2564 if ( $this->mTokenOkExceptSuffix
) {
2565 $note = wfMsg( 'token_suffix_mismatch' );
2567 $note = wfMsg( 'session_fail_preview' );
2569 } elseif ( $this->incompleteForm
) {
2570 $note = wfMsg( 'edit_form_incomplete' );
2572 $note = wfMsg( 'previewnote' ) .
2573 ' [[#' . self
::EDITFORM_ID
. '|' . $wgLang->getArrow() . ' ' . wfMsg( 'continue-editing' ) . ']]';
2576 $parserOptions = ParserOptions
::newFromUser( $wgUser );
2577 $parserOptions->setEditSection( false );
2578 $parserOptions->setTidy( true );
2579 $parserOptions->setIsPreview( true );
2580 $parserOptions->setIsSectionPreview( !is_null( $this->section
) && $this->section
!== '' );
2582 # don't parse non-wikitext pages, show message about preview
2583 if ( $this->mTitle
->isCssJsSubpage() ||
!$this->mTitle
->isWikitextPage() ) {
2584 if ( $this->mTitle
->isCssJsSubpage() ) {
2586 } elseif ( $this->mTitle
->isCssOrJsPage() ) {
2592 # Used messages to make sure grep find them:
2593 # Messages: usercsspreview, userjspreview, sitecsspreview, sitejspreview
2596 if ( preg_match( "/\\.css$/", $this->mTitle
->getText() ) ) {
2597 $previewtext = "<div id='mw-{$level}csspreview'>\n" . wfMsg( "{$level}csspreview" ) . "\n</div>";
2598 $class .= " mw-css";
2599 } elseif ( preg_match( "/\\.js$/", $this->mTitle
->getText() ) ) {
2600 $previewtext = "<div id='mw-{$level}jspreview'>\n" . wfMsg( "{$level}jspreview" ) . "\n</div>";
2603 throw new MWException( 'A CSS/JS (sub)page but which is not css nor js!' );
2605 $parserOutput = $wgParser->parse( $previewtext, $this->mTitle
, $parserOptions );
2606 $previewHTML = $parserOutput->getText();
2611 $previewHTML .= "<pre class=\"$class\" dir=\"ltr\">\n" . htmlspecialchars( $this->textbox1
) . "\n</pre>\n";
2613 $toparse = $this->textbox1
;
2615 # If we're adding a comment, we need to show the
2616 # summary as the headline
2617 if ( $this->section
== "new" && $this->summary
!= "" ) {
2618 $toparse = wfMsgForContent( 'newsectionheaderdefaultlevel', $this->summary
) . "\n\n" . $toparse;
2621 wfRunHooks( 'EditPageGetPreviewText', array( $this, &$toparse ) );
2623 $parserOptions->enableLimitReport();
2625 $toparse = $wgParser->preSaveTransform( $toparse, $this->mTitle
, $wgUser, $parserOptions );
2626 $parserOutput = $wgParser->parse( $toparse, $this->mTitle
, $parserOptions );
2628 $rt = Title
::newFromRedirectArray( $this->textbox1
);
2630 $previewHTML = $this->mArticle
->viewRedirect( $rt, false );
2632 $previewHTML = $parserOutput->getText();
2635 $this->mParserOutput
= $parserOutput;
2636 $wgOut->addParserOutputNoText( $parserOutput );
2638 if ( count( $parserOutput->getWarnings() ) ) {
2639 $note .= "\n\n" . implode( "\n\n", $parserOutput->getWarnings() );
2643 if ( $this->isConflict
) {
2644 $conflict = '<h2 id="mw-previewconflict">' . htmlspecialchars( wfMsg( 'previewconflict' ) ) . "</h2>\n";
2646 $conflict = '<hr />';
2649 $previewhead = "<div class='previewnote'>\n" .
2650 '<h2 id="mw-previewheader">' . htmlspecialchars( wfMsg( 'preview' ) ) . "</h2>" .
2651 $wgOut->parse( $note, true, /* interface */true ) . $conflict . "</div>\n";
2653 $pageLang = $this->mTitle
->getPageLanguage();
2654 $attribs = array( 'lang' => $pageLang->getCode(), 'dir' => $pageLang->getDir(),
2655 'class' => 'mw-content-' . $pageLang->getDir() );
2656 $previewHTML = Html
::rawElement( 'div', $attribs, $previewHTML );
2658 wfProfileOut( __METHOD__
);
2659 return $previewhead . $previewHTML . $this->previewTextAfterContent
;
2665 function getTemplates() {
2666 if ( $this->preview ||
$this->section
!= '' ) {
2667 $templates = array();
2668 if ( !isset( $this->mParserOutput
) ) {
2671 foreach ( $this->mParserOutput
->getTemplates() as $ns => $template ) {
2672 foreach ( array_keys( $template ) as $dbk ) {
2673 $templates[] = Title
::makeTitle( $ns, $dbk );
2678 return $this->mTitle
->getTemplateLinksFrom();
2683 * Shows a bulletin board style toolbar for common editing functions.
2684 * It can be disabled in the user preferences.
2685 * The necessary JavaScript code can be found in skins/common/edit.js.
2689 static function getEditToolbar() {
2690 global $wgStylePath, $wgContLang, $wgLang, $wgOut;
2691 global $wgUseTeX, $wgEnableUploads, $wgForeignFileRepos;
2693 $imagesAvailable = $wgEnableUploads ||
count( $wgForeignFileRepos );
2696 * $toolarray is an array of arrays each of which includes the
2697 * filename of the button image (without path), the opening
2698 * tag, the closing tag, optionally a sample text that is
2699 * inserted between the two when no selection is highlighted
2700 * and. The tip text is shown when the user moves the mouse
2703 * Also here: accesskeys (key), which are not used yet until
2704 * someone can figure out a way to make them work in
2705 * IE. However, we should make sure these keys are not defined
2710 'image' => $wgLang->getImageFile( 'button-bold' ),
2711 'id' => 'mw-editbutton-bold',
2713 'close' => '\'\'\'',
2714 'sample' => wfMsg( 'bold_sample' ),
2715 'tip' => wfMsg( 'bold_tip' ),
2719 'image' => $wgLang->getImageFile( 'button-italic' ),
2720 'id' => 'mw-editbutton-italic',
2723 'sample' => wfMsg( 'italic_sample' ),
2724 'tip' => wfMsg( 'italic_tip' ),
2728 'image' => $wgLang->getImageFile( 'button-link' ),
2729 'id' => 'mw-editbutton-link',
2732 'sample' => wfMsg( 'link_sample' ),
2733 'tip' => wfMsg( 'link_tip' ),
2737 'image' => $wgLang->getImageFile( 'button-extlink' ),
2738 'id' => 'mw-editbutton-extlink',
2741 'sample' => wfMsg( 'extlink_sample' ),
2742 'tip' => wfMsg( 'extlink_tip' ),
2746 'image' => $wgLang->getImageFile( 'button-headline' ),
2747 'id' => 'mw-editbutton-headline',
2750 'sample' => wfMsg( 'headline_sample' ),
2751 'tip' => wfMsg( 'headline_tip' ),
2754 $imagesAvailable ?
array(
2755 'image' => $wgLang->getImageFile( 'button-image' ),
2756 'id' => 'mw-editbutton-image',
2757 'open' => '[[' . $wgContLang->getNsText( NS_FILE
) . ':',
2759 'sample' => wfMsg( 'image_sample' ),
2760 'tip' => wfMsg( 'image_tip' ),
2763 $imagesAvailable ?
array(
2764 'image' => $wgLang->getImageFile( 'button-media' ),
2765 'id' => 'mw-editbutton-media',
2766 'open' => '[[' . $wgContLang->getNsText( NS_MEDIA
) . ':',
2768 'sample' => wfMsg( 'media_sample' ),
2769 'tip' => wfMsg( 'media_tip' ),
2773 'image' => $wgLang->getImageFile( 'button-math' ),
2774 'id' => 'mw-editbutton-math',
2776 'close' => "</math>",
2777 'sample' => wfMsg( 'math_sample' ),
2778 'tip' => wfMsg( 'math_tip' ),
2782 'image' => $wgLang->getImageFile( 'button-nowiki' ),
2783 'id' => 'mw-editbutton-nowiki',
2784 'open' => "<nowiki>",
2785 'close' => "</nowiki>",
2786 'sample' => wfMsg( 'nowiki_sample' ),
2787 'tip' => wfMsg( 'nowiki_tip' ),
2791 'image' => $wgLang->getImageFile( 'button-sig' ),
2792 'id' => 'mw-editbutton-signature',
2796 'tip' => wfMsg( 'sig_tip' ),
2800 'image' => $wgLang->getImageFile( 'button-hr' ),
2801 'id' => 'mw-editbutton-hr',
2802 'open' => "\n----\n",
2805 'tip' => wfMsg( 'hr_tip' ),
2810 $script = 'mw.loader.using("mediawiki.action.edit", function() {';
2811 foreach ( $toolarray as $tool ) {
2817 $image = $wgStylePath . '/common/images/' . $tool['image'],
2818 // Note that we use the tip both for the ALT tag and the TITLE tag of the image.
2819 // Older browsers show a "speedtip" type message only for ALT.
2820 // Ideally these should be different, realistically they
2821 // probably don't need to be.
2822 $tip = $tool['tip'],
2823 $open = $tool['open'],
2824 $close = $tool['close'],
2825 $sample = $tool['sample'],
2826 $cssId = $tool['id'],
2829 $script .= Xml
::encodeJsCall( 'mw.toolbar.addButton', $params );
2832 // This used to be called on DOMReady from mediawiki.action.edit, which
2833 // ended up causing race conditions with the setup code above.
2835 "// Create button bar\n" .
2836 "$(function() { mw.toolbar.init(); } );\n";
2839 $wgOut->addScript( Html
::inlineScript( ResourceLoader
::makeLoaderConditionalScript( $script ) ) );
2841 $toolbar = '<div id="toolbar"></div>';
2843 wfRunHooks( 'EditPageBeforeEditToolbar', array( &$toolbar ) );
2849 * Returns an array of html code of the following checkboxes:
2852 * @param $tabindex int Current tabindex
2853 * @param $checked Array of checkbox => bool, where bool indicates the checked
2854 * status of the checkbox
2858 public function getCheckboxes( &$tabindex, $checked ) {
2861 $checkboxes = array();
2863 // don't show the minor edit checkbox if it's a new page or section
2864 if ( !$this->isNew
) {
2865 $checkboxes['minor'] = '';
2866 $minorLabel = wfMsgExt( 'minoredit', array( 'parseinline' ) );
2867 if ( $wgUser->isAllowed( 'minoredit' ) ) {
2869 'tabindex' => ++
$tabindex,
2870 'accesskey' => wfMsg( 'accesskey-minoredit' ),
2871 'id' => 'wpMinoredit',
2873 $checkboxes['minor'] =
2874 Xml
::check( 'wpMinoredit', $checked['minor'], $attribs ) .
2875 " <label for='wpMinoredit' id='mw-editpage-minoredit'" .
2876 Xml
::expandAttributes( array( 'title' => Linker
::titleAttrib( 'minoredit', 'withaccess' ) ) ) .
2877 ">{$minorLabel}</label>";
2881 $watchLabel = wfMsgExt( 'watchthis', array( 'parseinline' ) );
2882 $checkboxes['watch'] = '';
2883 if ( $wgUser->isLoggedIn() ) {
2885 'tabindex' => ++
$tabindex,
2886 'accesskey' => wfMsg( 'accesskey-watch' ),
2887 'id' => 'wpWatchthis',
2889 $checkboxes['watch'] =
2890 Xml
::check( 'wpWatchthis', $checked['watch'], $attribs ) .
2891 " <label for='wpWatchthis' id='mw-editpage-watch'" .
2892 Xml
::expandAttributes( array( 'title' => Linker
::titleAttrib( 'watch', 'withaccess' ) ) ) .
2893 ">{$watchLabel}</label>";
2895 wfRunHooks( 'EditPageBeforeEditChecks', array( &$this, &$checkboxes, &$tabindex ) );
2900 * Returns an array of html code of the following buttons:
2901 * save, diff, preview and live
2903 * @param $tabindex int Current tabindex
2907 public function getEditButtons( &$tabindex ) {
2914 'tabindex' => ++
$tabindex,
2915 'value' => wfMsg( 'savearticle' ),
2916 'accesskey' => wfMsg( 'accesskey-save' ),
2917 'title' => wfMsg( 'tooltip-save' ) . ' [' . wfMsg( 'accesskey-save' ) . ']',
2919 $buttons['save'] = Xml
::element( 'input', $temp, '' );
2921 ++
$tabindex; // use the same for preview and live preview
2923 'id' => 'wpPreview',
2924 'name' => 'wpPreview',
2926 'tabindex' => $tabindex,
2927 'value' => wfMsg( 'showpreview' ),
2928 'accesskey' => wfMsg( 'accesskey-preview' ),
2929 'title' => wfMsg( 'tooltip-preview' ) . ' [' . wfMsg( 'accesskey-preview' ) . ']',
2931 $buttons['preview'] = Xml
::element( 'input', $temp, '' );
2932 $buttons['live'] = '';
2938 'tabindex' => ++
$tabindex,
2939 'value' => wfMsg( 'showdiff' ),
2940 'accesskey' => wfMsg( 'accesskey-diff' ),
2941 'title' => wfMsg( 'tooltip-diff' ) . ' [' . wfMsg( 'accesskey-diff' ) . ']',
2943 $buttons['diff'] = Xml
::element( 'input', $temp, '' );
2945 wfRunHooks( 'EditPageBeforeEditButtons', array( &$this, &$buttons, &$tabindex ) );
2950 * Output preview text only. This can be sucked into the edit page
2951 * via JavaScript, and saves the server time rendering the skin as
2952 * well as theoretically being more robust on the client (doesn't
2953 * disturb the edit box's undo history, won't eat your text on
2956 * @todo This doesn't include category or interlanguage links.
2957 * Would need to enhance it a bit, <s>maybe wrap them in XML
2958 * or something...</s> that might also require more skin
2959 * initialization, so check whether that's a problem.
2961 function livePreview() {
2964 header( 'Content-type: text/xml; charset=utf-8' );
2965 header( 'Cache-control: no-cache' );
2967 $previewText = $this->getPreviewText();
2968 #$categories = $skin->getCategoryLinks();
2971 '<?xml version="1.0" encoding="UTF-8" ?>' . "\n" .
2972 Xml
::tags( 'livepreview', null,
2973 Xml
::element( 'preview', null, $previewText )
2974 #. Xml::element( 'category', null, $categories )
2980 * Call the stock "user is blocked" page
2982 * @deprecated in 1.19; throw an exception directly instead
2984 function blockedPage() {
2985 wfDeprecated( __METHOD__
, '1.19' );
2988 throw new UserBlockedError( $wgUser->getBlock() );
2992 * Produce the stock "please login to edit pages" page
2994 * @deprecated in 1.19; throw an exception directly instead
2996 function userNotLoggedInPage() {
2997 wfDeprecated( __METHOD__
, '1.19' );
2998 throw new PermissionsError( 'edit' );
3002 * Show an error page saying to the user that he has insufficient permissions
3003 * to create a new page
3005 * @deprecated in 1.19; throw an exception directly instead
3007 function noCreatePermission() {
3008 wfDeprecated( __METHOD__
, '1.19' );
3009 $permission = $this->mTitle
->isTalkPage() ?
'createtalk' : 'createpage';
3010 throw new PermissionsError( $permission );
3014 * Creates a basic error page which informs the user that
3015 * they have attempted to edit a nonexistent section.
3017 function noSuchSectionPage() {
3020 $wgOut->prepareErrorPage( wfMessage( 'nosuchsectiontitle' ) );
3022 $res = wfMsgExt( 'nosuchsectiontext', 'parse', $this->section
);
3023 wfRunHooks( 'EditPageNoSuchSection', array( &$this, &$res ) );
3024 $wgOut->addHTML( $res );
3026 $wgOut->returnToMain( false, $this->mTitle
);
3030 * Produce the stock "your edit contains spam" page
3032 * @param $match string Text which triggered one or more filters
3033 * @deprecated since 1.17 Use method spamPageWithContent() instead
3035 static function spamPage( $match = false ) {
3036 wfDeprecated( __METHOD__
, '1.17' );
3038 global $wgOut, $wgTitle;
3040 $wgOut->prepareErrorPage( wfMessage( 'spamprotectiontitle' ) );
3042 $wgOut->addHTML( '<div id="spamprotected">' );
3043 $wgOut->addWikiMsg( 'spamprotectiontext' );
3045 $wgOut->addWikiMsg( 'spamprotectionmatch', wfEscapeWikiText( $match ) );
3047 $wgOut->addHTML( '</div>' );
3049 $wgOut->returnToMain( false, $wgTitle );
3053 * Show "your edit contains spam" page with your diff and text
3055 * @param $match string|Array|bool Text (or array of texts) which triggered one or more filters
3057 public function spamPageWithContent( $match = false ) {
3058 global $wgOut, $wgLang;
3059 $this->textbox2
= $this->textbox1
;
3061 if( is_array( $match ) ){
3062 $match = $wgLang->listToText( $match );
3064 $wgOut->prepareErrorPage( wfMessage( 'spamprotectiontitle' ) );
3066 $wgOut->addHTML( '<div id="spamprotected">' );
3067 $wgOut->addWikiMsg( 'spamprotectiontext' );
3069 $wgOut->addWikiMsg( 'spamprotectionmatch', wfEscapeWikiText( $match ) );
3071 $wgOut->addHTML( '</div>' );
3073 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
3076 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
3077 $this->showTextbox2();
3079 $wgOut->addReturnTo( $this->getContextTitle(), array( 'action' => 'edit' ) );
3083 * Format an anchor fragment as it would appear for a given section name
3084 * @param $text String
3088 function sectionAnchor( $text ) {
3090 return $wgParser->guessSectionNameFromWikiText( $text );
3094 * Check if the browser is on a blacklist of user-agents known to
3095 * mangle UTF-8 data on form submission. Returns true if Unicode
3096 * should make it through, false if it's known to be a problem.
3100 function checkUnicodeCompliantBrowser() {
3101 global $wgBrowserBlackList;
3102 if ( empty( $_SERVER["HTTP_USER_AGENT"] ) ) {
3103 // No User-Agent header sent? Trust it by default...
3106 $currentbrowser = $_SERVER["HTTP_USER_AGENT"];
3107 foreach ( $wgBrowserBlackList as $browser ) {
3108 if ( preg_match( $browser, $currentbrowser ) ) {
3116 * Filter an input field through a Unicode de-armoring process if it
3117 * came from an old browser with known broken Unicode editing issues.
3119 * @param $request WebRequest
3120 * @param $field String
3124 function safeUnicodeInput( $request, $field ) {
3125 $text = rtrim( $request->getText( $field ) );
3126 return $request->getBool( 'safemode' )
3127 ?
$this->unmakesafe( $text )
3132 * @param $request WebRequest
3133 * @param $text string
3136 function safeUnicodeText( $request, $text ) {
3137 $text = rtrim( $text );
3138 return $request->getBool( 'safemode' )
3139 ?
$this->unmakesafe( $text )
3144 * Filter an output field through a Unicode armoring process if it is
3145 * going to an old browser with known broken Unicode editing issues.
3147 * @param $text String
3151 function safeUnicodeOutput( $text ) {
3153 $codedText = $wgContLang->recodeForEdit( $text );
3154 return $this->checkUnicodeCompliantBrowser()
3156 : $this->makesafe( $codedText );
3160 * A number of web browsers are known to corrupt non-ASCII characters
3161 * in a UTF-8 text editing environment. To protect against this,
3162 * detected browsers will be served an armored version of the text,
3163 * with non-ASCII chars converted to numeric HTML character references.
3165 * Preexisting such character references will have a 0 added to them
3166 * to ensure that round-trips do not alter the original data.
3168 * @param $invalue String
3172 function makesafe( $invalue ) {
3173 // Armor existing references for reversability.
3174 $invalue = strtr( $invalue, array( "&#x" => "�" ) );
3179 for ( $i = 0; $i < strlen( $invalue ); $i++
) {
3180 $bytevalue = ord( $invalue[$i] );
3181 if ( $bytevalue <= 0x7F ) { // 0xxx xxxx
3182 $result .= chr( $bytevalue );
3184 } elseif ( $bytevalue <= 0xBF ) { // 10xx xxxx
3185 $working = $working << 6;
3186 $working +
= ( $bytevalue & 0x3F );
3188 if ( $bytesleft <= 0 ) {
3189 $result .= "&#x" . strtoupper( dechex( $working ) ) . ";";
3191 } elseif ( $bytevalue <= 0xDF ) { // 110x xxxx
3192 $working = $bytevalue & 0x1F;
3194 } elseif ( $bytevalue <= 0xEF ) { // 1110 xxxx
3195 $working = $bytevalue & 0x0F;
3197 } else { // 1111 0xxx
3198 $working = $bytevalue & 0x07;
3206 * Reverse the previously applied transliteration of non-ASCII characters
3207 * back to UTF-8. Used to protect data from corruption by broken web browsers
3208 * as listed in $wgBrowserBlackList.
3210 * @param $invalue String
3214 function unmakesafe( $invalue ) {
3216 for ( $i = 0; $i < strlen( $invalue ); $i++
) {
3217 if ( ( substr( $invalue, $i, 3 ) == "&#x" ) && ( $invalue[$i +
3] != '0' ) ) {
3221 $hexstring .= $invalue[$i];
3223 } while ( ctype_xdigit( $invalue[$i] ) && ( $i < strlen( $invalue ) ) );
3225 // Do some sanity checks. These aren't needed for reversability,
3226 // but should help keep the breakage down if the editor
3227 // breaks one of the entities whilst editing.
3228 if ( ( substr( $invalue, $i, 1 ) == ";" ) and ( strlen( $hexstring ) <= 6 ) ) {
3229 $codepoint = hexdec( $hexstring );
3230 $result .= codepointToUtf8( $codepoint );
3232 $result .= "&#x" . $hexstring . substr( $invalue, $i, 1 );
3235 $result .= substr( $invalue, $i, 1 );
3238 // reverse the transform that we made for reversability reasons.
3239 return strtr( $result, array( "�" => "&#x" ) );