3 * Page edition user interface.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
24 * The edit page/HTML interface (split from Article)
25 * The actual database and text munging is still in Article,
26 * but it should get easier to call those from alternate
29 * EditPage cares about two distinct titles:
30 * $this->mContextTitle is the page that forms submit to, links point to,
31 * redirects go to, etc. $this->mTitle (as well as $mArticle) is the
32 * page in the database that is actually being edited. These are
33 * usually the same, but they are now allowed to be different.
35 * Surgeon General's Warning: prolonged exposure to this class is known to cause
36 * headaches, which may be fatal.
41 * Status: Article successfully updated
43 const AS_SUCCESS_UPDATE
= 200;
46 * Status: Article successfully created
48 const AS_SUCCESS_NEW_ARTICLE
= 201;
51 * Status: Article update aborted by a hook function
53 const AS_HOOK_ERROR
= 210;
56 * Status: A hook function returned an error
58 const AS_HOOK_ERROR_EXPECTED
= 212;
61 * Status: User is blocked from editting this page
63 const AS_BLOCKED_PAGE_FOR_USER
= 215;
66 * Status: Content too big (> $wgMaxArticleSize)
68 const AS_CONTENT_TOO_BIG
= 216;
71 * Status: User cannot edit? (not used)
73 const AS_USER_CANNOT_EDIT
= 217;
76 * Status: this anonymous user is not allowed to edit this page
78 const AS_READ_ONLY_PAGE_ANON
= 218;
81 * Status: this logged in user is not allowed to edit this page
83 const AS_READ_ONLY_PAGE_LOGGED
= 219;
86 * Status: wiki is in readonly mode (wfReadOnly() == true)
88 const AS_READ_ONLY_PAGE
= 220;
91 * Status: rate limiter for action 'edit' was tripped
93 const AS_RATE_LIMITED
= 221;
96 * Status: article was deleted while editting and param wpRecreate == false or form
99 const AS_ARTICLE_WAS_DELETED
= 222;
102 * Status: user tried to create this page, but is not allowed to do that
103 * ( Title->usercan('create') == false )
105 const AS_NO_CREATE_PERMISSION
= 223;
108 * Status: user tried to create a blank page
110 const AS_BLANK_ARTICLE
= 224;
113 * Status: (non-resolvable) edit conflict
115 const AS_CONFLICT_DETECTED
= 225;
118 * Status: no edit summary given and the user has forceeditsummary set and the user is not
119 * editting in his own userspace or talkspace and wpIgnoreBlankSummary == false
121 const AS_SUMMARY_NEEDED
= 226;
124 * Status: user tried to create a new section without content
126 const AS_TEXTBOX_EMPTY
= 228;
129 * Status: article is too big (> $wgMaxArticleSize), after merging in the new section
131 const AS_MAX_ARTICLE_SIZE_EXCEEDED
= 229;
139 * Status: WikiPage::doEdit() was unsuccessfull
144 * Status: summary contained spam according to one of the regexes in $wgSummarySpamRegex
146 const AS_SPAM_ERROR
= 232;
149 * Status: anonymous user is not allowed to upload (User::isAllowed('upload') == false)
151 const AS_IMAGE_REDIRECT_ANON
= 233;
154 * Status: logged in user is not allowed to upload (User::isAllowed('upload') == false)
156 const AS_IMAGE_REDIRECT_LOGGED
= 234;
159 * Status: can't parse content
161 const AS_PARSE_ERROR
= 240;
164 * HTML id and name for the beginning of the edit form.
166 const EDITFORM_ID
= 'editform';
177 private $mContextTitle = null;
178 var $action = 'submit';
179 var $isConflict = false;
180 var $isCssJsSubpage = false;
181 var $isCssSubpage = false;
182 var $isJsSubpage = false;
183 var $isWrongCaseCssJsPage = false;
184 var $isNew = false; // new page or new section
185 var $deletedSinceEdit;
189 var $mTokenOk = false;
190 var $mTokenOkExceptSuffix = false;
191 var $mTriedSave = false;
192 var $incompleteForm = false;
194 var $kblength = false;
195 var $missingComment = false;
196 var $missingSummary = false;
197 var $allowBlankSummary = false;
200 #var $mPreviewTemplates;
208 * Has a summary been preset using GET parameter &summary= ?
211 var $hasPresetSummary = false;
213 var $mBaseRevision = false;
214 var $mShowSummaryField = true;
217 var $save = false, $preview = false, $diff = false;
218 var $minoredit = false, $watchthis = false, $recreate = false;
219 var $textbox1 = '', $textbox2 = '', $summary = '', $nosummary = false;
220 var $edittime = '', $section = '', $sectiontitle = '', $starttime = '';
221 var $oldid = 0, $editintro = '', $scrolltop = null, $bot = true;
222 var $content_model = null, $content_format = null;
224 # Placeholders for text injection by hooks (must be HTML)
225 # extensions should take care to _append_ to the present value
226 public $editFormPageTop = ''; // Before even the preview
227 public $editFormTextTop = '';
228 public $editFormTextBeforeContent = '';
229 public $editFormTextAfterWarn = '';
230 public $editFormTextAfterTools = '';
231 public $editFormTextBottom = '';
232 public $editFormTextAfterContent = '';
233 public $previewTextAfterContent = '';
234 public $mPreloadContent = null;
236 /* $didSave should be set to true whenever an article was succesfully altered. */
237 public $didSave = false;
238 public $undidRev = 0;
240 public $suppressIntro = false;
243 * Set to true to allow editing of non-text content types.
247 public $allowNonTextContent = false;
250 * @param $article Article
252 public function __construct( Article
$article ) {
253 $this->mArticle
= $article;
254 $this->mTitle
= $article->getTitle();
256 $this->content_model
= $this->mTitle
->getContentModel();
258 $handler = ContentHandler
::getForModelID( $this->content_model
);
259 $this->content_format
= $handler->getDefaultFormat(); #NOTE: should be overridden by format of actual revision
265 public function getArticle() {
266 return $this->mArticle
;
273 public function getTitle() {
274 return $this->mTitle
;
278 * Set the context Title object
280 * @param $title Title object or null
282 public function setContextTitle( $title ) {
283 $this->mContextTitle
= $title;
287 * Get the context title object.
288 * If not set, $wgTitle will be returned. This behavior might changed in
289 * the future to return $this->mTitle instead.
291 * @return Title object
293 public function getContextTitle() {
294 if ( is_null( $this->mContextTitle
) ) {
298 return $this->mContextTitle
;
307 * This is the function that gets called for "action=edit". It
308 * sets up various member variables, then passes execution to
309 * another function, usually showEditForm()
311 * The edit form is self-submitting, so that when things like
312 * preview and edit conflicts occur, we get the same form back
313 * with the extra stuff added. Only when the final submission
314 * is made and all is well do we actually save and redirect to
315 * the newly-edited page.
318 global $wgOut, $wgRequest, $wgUser;
319 // Allow extensions to modify/prevent this form or submission
320 if ( !wfRunHooks( 'AlternateEdit', array( $this ) ) ) {
324 wfProfileIn( __METHOD__
);
325 wfDebug( __METHOD__
. ": enter\n" );
327 // If they used redlink=1 and the page exists, redirect to the main article
328 if ( $wgRequest->getBool( 'redlink' ) && $this->mTitle
->exists() ) {
329 $wgOut->redirect( $this->mTitle
->getFullURL() );
330 wfProfileOut( __METHOD__
);
334 $this->importFormData( $wgRequest );
335 $this->firsttime
= false;
338 $this->livePreview();
339 wfProfileOut( __METHOD__
);
343 if ( wfReadOnly() && $this->save
) {
346 $this->preview
= true;
350 $this->formtype
= 'save';
351 } elseif ( $this->preview
) {
352 $this->formtype
= 'preview';
353 } elseif ( $this->diff
) {
354 $this->formtype
= 'diff';
355 } else { # First time through
356 $this->firsttime
= true;
357 if ( $this->previewOnOpen() ) {
358 $this->formtype
= 'preview';
360 $this->formtype
= 'initial';
364 $permErrors = $this->getEditPermissionErrors();
366 wfDebug( __METHOD__
. ": User can't edit\n" );
367 // Auto-block user's IP if the account was "hard" blocked
368 $wgUser->spreadAnyEditBlock();
370 $this->displayPermissionsError( $permErrors );
372 wfProfileOut( __METHOD__
);
376 wfProfileIn( __METHOD__
. "-business-end" );
378 $this->isConflict
= false;
379 // css / js subpages of user pages get a special treatment
380 $this->isCssJsSubpage
= $this->mTitle
->isCssJsSubpage();
381 $this->isCssSubpage
= $this->mTitle
->isCssSubpage();
382 $this->isJsSubpage
= $this->mTitle
->isJsSubpage();
383 $this->isWrongCaseCssJsPage
= $this->isWrongCaseCssJsPage();
384 $this->isNew
= !$this->mTitle
->exists() ||
$this->section
== 'new';
386 # Show applicable editing introductions
387 if ( $this->formtype
== 'initial' ||
$this->firsttime
) {
391 # Attempt submission here. This will check for edit conflicts,
392 # and redundantly check for locked database, blocked IPs, etc.
393 # that edit() already checked just in case someone tries to sneak
394 # in the back door with a hand-edited submission URL.
396 if ( 'save' == $this->formtype
) {
397 if ( !$this->attemptSave() ) {
398 wfProfileOut( __METHOD__
. "-business-end" );
399 wfProfileOut( __METHOD__
);
404 # First time through: get contents, set time for conflict
406 if ( 'initial' == $this->formtype ||
$this->firsttime
) {
407 if ( $this->initialiseForm() === false ) {
408 $this->noSuchSectionPage();
409 wfProfileOut( __METHOD__
. "-business-end" );
410 wfProfileOut( __METHOD__
);
413 if ( !$this->mTitle
->getArticleID() )
414 wfRunHooks( 'EditFormPreloadText', array( &$this->textbox1
, &$this->mTitle
) );
416 wfRunHooks( 'EditFormInitialText', array( $this ) );
419 $this->showEditForm();
420 wfProfileOut( __METHOD__
. "-business-end" );
421 wfProfileOut( __METHOD__
);
427 protected function getEditPermissionErrors() {
429 $permErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $wgUser );
430 # Can this title be created?
431 if ( !$this->mTitle
->exists() ) {
432 $permErrors = array_merge( $permErrors,
433 wfArrayDiff2( $this->mTitle
->getUserPermissionsErrors( 'create', $wgUser ), $permErrors ) );
435 # Ignore some permissions errors when a user is just previewing/viewing diffs
437 foreach ( $permErrors as $error ) {
438 if ( ( $this->preview ||
$this->diff
) &&
439 ( $error[0] == 'blockedtext' ||
$error[0] == 'autoblockedtext' ) )
444 $permErrors = wfArrayDiff2( $permErrors, $remove );
449 * Display a permissions error page, like OutputPage::showPermissionsErrorPage(),
450 * but with the following differences:
451 * - If redlink=1, the user will be redirected to the page
452 * - If there is content to display or the error occurs while either saving,
453 * previewing or showing the difference, it will be a
454 * "View source for ..." page displaying the source code after the error message.
457 * @param $permErrors Array of permissions errors, as returned by
458 * Title::getUserPermissionsErrors().
460 protected function displayPermissionsError( array $permErrors ) {
461 global $wgRequest, $wgOut;
463 if ( $wgRequest->getBool( 'redlink' ) ) {
464 // The edit page was reached via a red link.
465 // Redirect to the article page and let them click the edit tab if
466 // they really want a permission error.
467 $wgOut->redirect( $this->mTitle
->getFullUrl() );
471 $content = $this->getContentObject();
473 # Use the normal message if there's nothing to display
474 if ( $this->firsttime
&& $content->isEmpty() ) {
475 $action = $this->mTitle
->exists() ?
'edit' :
476 ( $this->mTitle
->isTalkPage() ?
'createtalk' : 'createpage' );
477 throw new PermissionsError( $action, $permErrors );
480 $wgOut->setPageTitle( wfMessage( 'viewsource-title', $this->getContextTitle()->getPrefixedText() ) );
481 $wgOut->addBacklinkSubtitle( $this->getContextTitle() );
482 $wgOut->addWikiText( $wgOut->formatPermissionsErrorMessage( $permErrors, 'edit' ) );
483 $wgOut->addHTML( "<hr />\n" );
485 # If the user made changes, preserve them when showing the markup
486 # (This happens when a user is blocked during edit, for instance)
487 if ( !$this->firsttime
) {
488 $text = $this->textbox1
;
489 $wgOut->addWikiMsg( 'viewyourtext' );
491 $text = $this->toEditText( $content );
492 $wgOut->addWikiMsg( 'viewsourcetext' );
495 $this->showTextbox( $text, 'wpTextbox1', array( 'readonly' ) );
497 $wgOut->addHTML( Html
::rawElement( 'div', array( 'class' => 'templatesUsed' ),
498 Linker
::formatTemplates( $this->getTemplates() ) ) );
500 if ( $this->mTitle
->exists() ) {
501 $wgOut->returnToMain( null, $this->mTitle
);
506 * Show a read-only error
507 * Parameters are the same as OutputPage:readOnlyPage()
508 * Redirect to the article page if redlink=1
509 * @deprecated in 1.19; use displayPermissionsError() instead
511 function readOnlyPage( $source = null, $protected = false, $reasons = array(), $action = null ) {
512 wfDeprecated( __METHOD__
, '1.19' );
514 global $wgRequest, $wgOut;
515 if ( $wgRequest->getBool( 'redlink' ) ) {
516 // The edit page was reached via a red link.
517 // Redirect to the article page and let them click the edit tab if
518 // they really want a permission error.
519 $wgOut->redirect( $this->mTitle
->getFullUrl() );
521 $wgOut->readOnlyPage( $source, $protected, $reasons, $action );
526 * Should we show a preview when the edit form is first shown?
530 protected function previewOnOpen() {
531 global $wgRequest, $wgUser, $wgPreviewOnOpenNamespaces;
532 if ( $wgRequest->getVal( 'preview' ) == 'yes' ) {
533 // Explicit override from request
535 } elseif ( $wgRequest->getVal( 'preview' ) == 'no' ) {
536 // Explicit override from request
538 } elseif ( $this->section
== 'new' ) {
539 // Nothing *to* preview for new sections
541 } elseif ( ( $wgRequest->getVal( 'preload' ) !== null ||
$this->mTitle
->exists() ) && $wgUser->getOption( 'previewonfirst' ) ) {
542 // Standard preference behaviour
544 } elseif ( !$this->mTitle
->exists() &&
545 isset( $wgPreviewOnOpenNamespaces[$this->mTitle
->getNamespace()] ) &&
546 $wgPreviewOnOpenNamespaces[$this->mTitle
->getNamespace()] )
548 // Categories are special
556 * Checks whether the user entered a skin name in uppercase,
557 * e.g. "User:Example/Monobook.css" instead of "monobook.css"
561 protected function isWrongCaseCssJsPage() {
562 if ( $this->mTitle
->isCssJsSubpage() ) {
563 $name = $this->mTitle
->getSkinFromCssJsSubpage();
564 $skins = array_merge(
565 array_keys( Skin
::getSkinNames() ),
568 return !in_array( $name, $skins )
569 && in_array( strtolower( $name ), $skins );
576 * Does this EditPage class support section editing?
577 * This is used by EditPage subclasses to indicate their ui cannot handle section edits
581 protected function isSectionEditSupported() {
586 * This function collects the form data and uses it to populate various member variables.
587 * @param $request WebRequest
589 function importFormData( &$request ) {
590 global $wgLang, $wgUser;
592 wfProfileIn( __METHOD__
);
594 # Section edit can come from either the form or a link
595 $this->section
= $request->getVal( 'wpSection', $request->getVal( 'section' ) );
597 if ( $request->wasPosted() ) {
598 # These fields need to be checked for encoding.
599 # Also remove trailing whitespace, but don't remove _initial_
600 # whitespace from the text boxes. This may be significant formatting.
601 $this->textbox1
= $this->safeUnicodeInput( $request, 'wpTextbox1' );
602 if ( !$request->getCheck( 'wpTextbox2' ) ) {
603 // Skip this if wpTextbox2 has input, it indicates that we came
604 // from a conflict page with raw page text, not a custom form
605 // modified by subclasses
606 wfProfileIn( get_class( $this ) . "::importContentFormData" );
607 $textbox1 = $this->importContentFormData( $request );
608 if ( isset( $textbox1 ) )
609 $this->textbox1
= $textbox1;
610 wfProfileOut( get_class( $this ) . "::importContentFormData" );
613 # Truncate for whole multibyte characters
614 $this->summary
= $wgLang->truncate( $request->getText( 'wpSummary' ), 255 );
616 # If the summary consists of a heading, e.g. '==Foobar==', extract the title from the
617 # header syntax, e.g. 'Foobar'. This is mainly an issue when we are using wpSummary for
619 $this->summary
= preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->summary
);
621 # Treat sectiontitle the same way as summary.
622 # Note that wpSectionTitle is not yet a part of the actual edit form, as wpSummary is
623 # currently doing double duty as both edit summary and section title. Right now this
624 # is just to allow API edits to work around this limitation, but this should be
625 # incorporated into the actual edit form when EditPage is rewritten (Bugs 18654, 26312).
626 $this->sectiontitle
= $wgLang->truncate( $request->getText( 'wpSectionTitle' ), 255 );
627 $this->sectiontitle
= preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->sectiontitle
);
629 $this->edittime
= $request->getVal( 'wpEdittime' );
630 $this->starttime
= $request->getVal( 'wpStarttime' );
632 $this->scrolltop
= $request->getIntOrNull( 'wpScrolltop' );
634 if ( $this->textbox1
=== '' && $request->getVal( 'wpTextbox1' ) === null ) {
635 // wpTextbox1 field is missing, possibly due to being "too big"
636 // according to some filter rules such as Suhosin's setting for
637 // suhosin.request.max_value_length (d'oh)
638 $this->incompleteForm
= true;
640 // edittime should be one of our last fields; if it's missing,
641 // the submission probably broke somewhere in the middle.
642 $this->incompleteForm
= is_null( $this->edittime
);
644 if ( $this->incompleteForm
) {
645 # If the form is incomplete, force to preview.
646 wfDebug( __METHOD__
. ": Form data appears to be incomplete\n" );
647 wfDebug( "POST DATA: " . var_export( $_POST, true ) . "\n" );
648 $this->preview
= true;
650 /* Fallback for live preview */
651 $this->preview
= $request->getCheck( 'wpPreview' ) ||
$request->getCheck( 'wpLivePreview' );
652 $this->diff
= $request->getCheck( 'wpDiff' );
654 // Remember whether a save was requested, so we can indicate
655 // if we forced preview due to session failure.
656 $this->mTriedSave
= !$this->preview
;
658 if ( $this->tokenOk( $request ) ) {
659 # Some browsers will not report any submit button
660 # if the user hits enter in the comment box.
661 # The unmarked state will be assumed to be a save,
662 # if the form seems otherwise complete.
663 wfDebug( __METHOD__
. ": Passed token check.\n" );
664 } elseif ( $this->diff
) {
665 # Failed token check, but only requested "Show Changes".
666 wfDebug( __METHOD__
. ": Failed token check; Show Changes requested.\n" );
668 # Page might be a hack attempt posted from
669 # an external site. Preview instead of saving.
670 wfDebug( __METHOD__
. ": Failed token check; forcing preview\n" );
671 $this->preview
= true;
674 $this->save
= !$this->preview
&& !$this->diff
;
675 if ( !preg_match( '/^\d{14}$/', $this->edittime
) ) {
676 $this->edittime
= null;
679 if ( !preg_match( '/^\d{14}$/', $this->starttime
) ) {
680 $this->starttime
= null;
683 $this->recreate
= $request->getCheck( 'wpRecreate' );
685 $this->minoredit
= $request->getCheck( 'wpMinoredit' );
686 $this->watchthis
= $request->getCheck( 'wpWatchthis' );
688 # Don't force edit summaries when a user is editing their own user or talk page
689 if ( ( $this->mTitle
->mNamespace
== NS_USER ||
$this->mTitle
->mNamespace
== NS_USER_TALK
) &&
690 $this->mTitle
->getText() == $wgUser->getName() )
692 $this->allowBlankSummary
= true;
694 $this->allowBlankSummary
= $request->getBool( 'wpIgnoreBlankSummary' ) ||
!$wgUser->getOption( 'forceeditsummary' );
697 $this->autoSumm
= $request->getText( 'wpAutoSummary' );
699 # Not a posted form? Start with nothing.
700 wfDebug( __METHOD__
. ": Not a posted form.\n" );
701 $this->textbox1
= '';
703 $this->sectiontitle
= '';
704 $this->edittime
= '';
705 $this->starttime
= wfTimestampNow();
707 $this->preview
= false;
710 $this->minoredit
= false;
711 $this->watchthis
= $request->getBool( 'watchthis', false ); // Watch may be overriden by request parameters
712 $this->recreate
= false;
714 // When creating a new section, we can preload a section title by passing it as the
715 // preloadtitle parameter in the URL (Bug 13100)
716 if ( $this->section
== 'new' && $request->getVal( 'preloadtitle' ) ) {
717 $this->sectiontitle
= $request->getVal( 'preloadtitle' );
718 // Once wpSummary isn't being use for setting section titles, we should delete this.
719 $this->summary
= $request->getVal( 'preloadtitle' );
721 elseif ( $this->section
!= 'new' && $request->getVal( 'summary' ) ) {
722 $this->summary
= $request->getText( 'summary' );
723 if ( $this->summary
!== '' ) {
724 $this->hasPresetSummary
= true;
728 if ( $request->getVal( 'minor' ) ) {
729 $this->minoredit
= true;
733 $this->oldid
= $request->getInt( 'oldid' );
735 $this->bot
= $request->getBool( 'bot', true );
736 $this->nosummary
= $request->getBool( 'nosummary' );
738 $content_handler = ContentHandler
::getForTitle( $this->mTitle
);
739 $this->content_model
= $request->getText( 'model', $content_handler->getModelID() ); #may be overridden by revision
740 $this->content_format
= $request->getText( 'format', $content_handler->getDefaultFormat() ); #may be overridden by revision
742 #TODO: check if the desired model is allowed in this namespace, and if a transition from the page's current model to the new model is allowed
743 #TODO: check if the desired content model supports the given content format!
745 $this->live
= $request->getCheck( 'live' );
746 $this->editintro
= $request->getText( 'editintro',
747 // Custom edit intro for new sections
748 $this->section
=== 'new' ?
'MediaWiki:addsection-editintro' : '' );
750 // Allow extensions to modify form data
751 wfRunHooks( 'EditPage::importFormData', array( $this, $request ) );
753 wfProfileOut( __METHOD__
);
757 * Subpage overridable method for extracting the page content data from the
758 * posted form to be placed in $this->textbox1, if using customized input
759 * this method should be overrided and return the page text that will be used
760 * for saving, preview parsing and so on...
762 * @param $request WebRequest
764 protected function importContentFormData( &$request ) {
765 return; // Don't do anything, EditPage already extracted wpTextbox1
769 * Initialise form fields in the object
770 * Called on the first invocation, e.g. when a user clicks an edit link
771 * @return bool -- if the requested section is valid
773 function initialiseForm() {
775 $this->edittime
= $this->mArticle
->getTimestamp();
777 $content = $this->getContentObject( false ); #TODO: track content object?!
778 $this->textbox1
= $this->toEditText( $content );
780 // activate checkboxes if user wants them to be always active
781 # Sort out the "watch" checkbox
782 if ( $wgUser->getOption( 'watchdefault' ) ) {
784 $this->watchthis
= true;
785 } elseif ( $wgUser->getOption( 'watchcreations' ) && !$this->mTitle
->exists() ) {
787 $this->watchthis
= true;
788 } elseif ( $wgUser->isWatched( $this->mTitle
) ) {
790 $this->watchthis
= true;
792 if ( $wgUser->getOption( 'minordefault' ) && !$this->isNew
) {
793 $this->minoredit
= true;
795 if ( $this->textbox1
=== false ) {
803 * Fetch initial editing page content.
805 * @param $def_text string
806 * @return mixed string on success, $def_text for invalid sections
808 * @deprecated since 1.WD
809 * @todo: deprecated, replace usage everywhere
811 function getContent( $def_text = false ) {
812 wfDeprecated( __METHOD__
, '1.WD' );
814 if ( $def_text !== null && $def_text !== false && $def_text !== '' ) {
815 $def_content = $this->toEditContent( $def_text );
817 $def_content = false;
820 $content = $this->getContentObject( $def_content );
822 // Note: EditPage should only be used with text based content anyway.
823 return $this->toEditText( $content );
826 private function getContentObject( $def_content = null ) {
827 global $wgOut, $wgRequest;
829 wfProfileIn( __METHOD__
);
833 // For message page not locally set, use the i18n message.
834 // For other non-existent articles, use preload text if any.
835 if ( !$this->mTitle
->exists() ||
$this->section
== 'new' ) {
836 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
&& $this->section
!= 'new' ) {
837 # If this is a system message, get the default text.
838 $msg = $this->mTitle
->getDefaultMessageText();
840 $content = $this->toEditContent( $msg );
842 if ( $content === false ) {
843 # If requested, preload some text.
844 $preload = $wgRequest->getVal( 'preload',
845 // Custom preload text for new sections
846 $this->section
=== 'new' ?
'MediaWiki:addsection-preload' : '' );
848 $content = $this->getPreloadedContent( $preload );
850 // For existing pages, get text based on "undo" or section parameters.
852 if ( $this->section
!= '' ) {
853 // Get section edit text (returns $def_text for invalid sections)
854 $orig = $this->getOriginalContent();
855 $content = $orig ?
$orig->getSection( $this->section
) : null;
857 if ( !$content ) $content = $def_content;
859 $undoafter = $wgRequest->getInt( 'undoafter' );
860 $undo = $wgRequest->getInt( 'undo' );
862 if ( $undo > 0 && $undoafter > 0 ) {
863 if ( $undo < $undoafter ) {
864 # If they got undoafter and undo round the wrong way, switch them
865 list( $undo, $undoafter ) = array( $undoafter, $undo );
868 $undorev = Revision
::newFromId( $undo );
869 $oldrev = Revision
::newFromId( $undoafter );
871 # Sanity check, make sure it's the right page,
872 # the revisions exist and they were not deleted.
873 # Otherwise, $content will be left as-is.
874 if ( !is_null( $undorev ) && !is_null( $oldrev ) &&
875 $undorev->getPage() == $oldrev->getPage() &&
876 $undorev->getPage() == $this->mTitle
->getArticleID() &&
877 !$undorev->isDeleted( Revision
::DELETED_TEXT
) &&
878 !$oldrev->isDeleted( Revision
::DELETED_TEXT
) ) {
880 $content = $this->mArticle
->getUndoContent( $undorev, $oldrev );
882 if ( $content === false ) {
883 # Warn the user that something went wrong
884 $undoMsg = 'failure';
886 # Inform the user of our success and set an automatic edit summary
887 $undoMsg = 'success';
889 # If we just undid one rev, use an autosummary
890 $firstrev = $oldrev->getNext();
891 if ( $firstrev && $firstrev->getId() == $undo ) {
892 $undoSummary = wfMessage( 'undo-summary', $undo, $undorev->getUserText() )->inContentLanguage()->text();
893 if ( $this->summary
=== '' ) {
894 $this->summary
= $undoSummary;
896 $this->summary
= $undoSummary . wfMessage( 'colon-separator' )
897 ->inContentLanguage()->text() . $this->summary
;
899 $this->undidRev
= $undo;
901 $this->formtype
= 'diff';
904 // Failed basic sanity checks.
905 // Older revisions may have been removed since the link
906 // was created, or we may simply have got bogus input.
910 $class = ( $undoMsg == 'success' ?
'' : 'error ' ) . "mw-undo-{$undoMsg}";
911 $this->editFormPageTop
.= $wgOut->parse( "<div class=\"{$class}\">" .
912 wfMessage( 'undo-' . $undoMsg )->plain() . '</div>', true, /* interface */true );
915 if ( $content === false ) {
916 $content = $this->getOriginalContent();
921 wfProfileOut( __METHOD__
);
926 * Get the content of the wanted revision, without section extraction.
928 * The result of this function can be used to compare user's input with
929 * section replaced in its context (using WikiPage::replaceSection())
930 * to the original text of the edit.
932 * This difers from Article::getContent() that when a missing revision is
933 * encountered the result will be an empty string and not the
934 * 'missing-revision' message.
939 private function getOriginalContent() {
940 if ( $this->section
== 'new' ) {
941 return $this->getCurrentContent();
943 $revision = $this->mArticle
->getRevisionFetched();
944 if ( $revision === null ) {
945 if ( !$this->content_model
) $this->content_model
= $this->getTitle()->getContentModel();
946 $handler = ContentHandler
::getForModelID( $this->content_model
);
948 return $handler->makeEmptyContent();
950 $content = $revision->getContent();
955 * Get the current content of the page. This is basically similar to
956 * WikiPage::getContent( Revision::RAW ) except that when the page doesn't exist an empty
957 * content object is returned instead of null.
962 private function getCurrentContent() {
963 $rev = $this->mArticle
->getRevision();
964 $content = $rev ?
$rev->getContent( Revision
::RAW
) : null;
966 if ( $content === false ||
$content === null ) {
967 if ( !$this->content_model
) $this->content_model
= $this->getTitle()->getContentModel();
968 $handler = ContentHandler
::getForModelID( $this->content_model
);
970 return $handler->makeEmptyContent();
972 # nasty side-effect, but needed for consistency
973 $this->content_model
= $rev->getContentModel();
974 $this->content_format
= $rev->getContentFormat();
982 * Use this method before edit() to preload some text into the edit box
984 * @param $text string
985 * @deprecated since 1.WD
987 public function setPreloadedText( $text ) {
988 wfDeprecated( __METHOD__
, "1.WD" );
990 $content = $this->toEditContent( $text );
992 $this->setPreloadedContent( $content );
996 * Use this method before edit() to preload some content into the edit box
998 * @param $content Content
1002 public function setPreloadedContent( Content
$content ) {
1003 $this->mPreloadedContent
= $content;
1007 * Get the contents to be preloaded into the box, either set by
1008 * an earlier setPreloadText() or by loading the given page.
1010 * @param $preload String: representing the title to preload from.
1014 * @deprecated since 1.WD, use getPreloadedContent() instead
1016 protected function getPreloadedText( $preload ) { #NOTE: B/C only, replace usage!
1017 wfDeprecated( __METHOD__
, "1.WD" );
1019 $content = $this->getPreloadedContent( $preload );
1020 $text = $this->toEditText( $content );
1026 * Get the contents to be preloaded into the box, either set by
1027 * an earlier setPreloadText() or by loading the given page.
1029 * @param $preload String: representing the title to preload from.
1035 protected function getPreloadedContent( $preload ) { #@todo: use this!
1038 if ( !empty( $this->mPreloadContent
) ) {
1039 return $this->mPreloadContent
;
1042 $handler = ContentHandler
::getForTitle( $this->getTitle() );
1044 if ( $preload === '' ) {
1045 return $handler->makeEmptyContent();
1048 $title = Title
::newFromText( $preload );
1049 # Check for existence to avoid getting MediaWiki:Noarticletext
1050 if ( $title === null ||
!$title->exists() ||
!$title->userCan( 'read' ) ) {
1051 return $handler->makeEmptyContent();
1054 $page = WikiPage
::factory( $title );
1055 if ( $page->isRedirect() ) {
1056 $title = $page->getRedirectTarget();
1058 if ( $title === null ||
!$title->exists() ||
!$title->userCan( 'read' ) ) {
1059 return $handler->makeEmptyContent();
1061 $page = WikiPage
::factory( $title );
1064 $parserOptions = ParserOptions
::newFromUser( $wgUser );
1065 $content = $page->getContent( Revision
::RAW
);
1067 return $content->preloadTransform( $title, $parserOptions );
1071 * Make sure the form isn't faking a user's credentials.
1073 * @param $request WebRequest
1077 function tokenOk( &$request ) {
1079 $token = $request->getVal( 'wpEditToken' );
1080 $this->mTokenOk
= $wgUser->matchEditToken( $token );
1081 $this->mTokenOkExceptSuffix
= $wgUser->matchEditTokenNoSuffix( $token );
1082 return $this->mTokenOk
;
1086 * Attempt submission
1087 * @return bool false if output is done, true if the rest of the form should be displayed
1089 function attemptSave() {
1090 global $wgUser, $wgOut;
1092 $resultDetails = false;
1093 # Allow bots to exempt some edits from bot flagging
1094 $bot = $wgUser->isAllowed( 'bot' ) && $this->bot
;
1095 $status = $this->internalAttemptSave( $resultDetails, $bot );
1096 // FIXME: once the interface for internalAttemptSave() is made nicer, this should use the message in $status
1097 if ( $status->value
== self
::AS_SUCCESS_UPDATE ||
$status->value
== self
::AS_SUCCESS_NEW_ARTICLE
) {
1098 $this->didSave
= true;
1101 switch ( $status->value
) {
1102 case self
::AS_HOOK_ERROR_EXPECTED
:
1103 case self
::AS_CONTENT_TOO_BIG
:
1104 case self
::AS_ARTICLE_WAS_DELETED
:
1105 case self
::AS_CONFLICT_DETECTED
:
1106 case self
::AS_SUMMARY_NEEDED
:
1107 case self
::AS_TEXTBOX_EMPTY
:
1108 case self
::AS_MAX_ARTICLE_SIZE_EXCEEDED
:
1112 case self
::AS_HOOK_ERROR
:
1115 case self
::AS_PARSE_ERROR
:
1116 $wgOut->addWikiText( '<div class="error">' . $status->getWikiText() . '</div>');
1119 case self
::AS_SUCCESS_NEW_ARTICLE
:
1120 $query = $resultDetails['redirect'] ?
'redirect=no' : '';
1121 $anchor = isset ( $resultDetails['sectionanchor'] ) ?
$resultDetails['sectionanchor'] : '';
1122 $wgOut->redirect( $this->mTitle
->getFullURL( $query ) . $anchor );
1125 case self
::AS_SUCCESS_UPDATE
:
1127 $sectionanchor = $resultDetails['sectionanchor'];
1129 // Give extensions a chance to modify URL query on update
1130 wfRunHooks( 'ArticleUpdateBeforeRedirect', array( $this->mArticle
, &$sectionanchor, &$extraQuery ) );
1132 if ( $resultDetails['redirect'] ) {
1133 if ( $extraQuery == '' ) {
1134 $extraQuery = 'redirect=no';
1136 $extraQuery = 'redirect=no&' . $extraQuery;
1139 $wgOut->redirect( $this->mTitle
->getFullURL( $extraQuery ) . $sectionanchor );
1142 case self
::AS_BLANK_ARTICLE
:
1143 $wgOut->redirect( $this->getContextTitle()->getFullURL() );
1146 case self
::AS_SPAM_ERROR
:
1147 $this->spamPageWithContent( $resultDetails['spam'] );
1150 case self
::AS_BLOCKED_PAGE_FOR_USER
:
1151 throw new UserBlockedError( $wgUser->getBlock() );
1153 case self
::AS_IMAGE_REDIRECT_ANON
:
1154 case self
::AS_IMAGE_REDIRECT_LOGGED
:
1155 throw new PermissionsError( 'upload' );
1157 case self
::AS_READ_ONLY_PAGE_ANON
:
1158 case self
::AS_READ_ONLY_PAGE_LOGGED
:
1159 throw new PermissionsError( 'edit' );
1161 case self
::AS_READ_ONLY_PAGE
:
1162 throw new ReadOnlyError
;
1164 case self
::AS_RATE_LIMITED
:
1165 throw new ThrottledError();
1167 case self
::AS_NO_CREATE_PERMISSION
:
1168 $permission = $this->mTitle
->isTalkPage() ?
'createtalk' : 'createpage';
1169 throw new PermissionsError( $permission );
1172 // We don't recognize $status->value. The only way that can happen
1173 // is if an extension hook aborted from inside ArticleSave.
1174 // Render the status object into $this->hookError
1175 // FIXME this sucks, we should just use the Status object throughout
1176 $this->hookError
= '<div class="error">' . $status->getWikitext() .
1183 * Attempt submission (no UI)
1188 * @return Status object, possibly with a message, but always with one of the AS_* constants in $status->value,
1190 * FIXME: This interface is TERRIBLE, but hard to get rid of due to various error display idiosyncrasies. There are
1191 * also lots of cases where error metadata is set in the object and retrieved later instead of being returned, e.g.
1192 * AS_CONTENT_TOO_BIG and AS_BLOCKED_PAGE_FOR_USER. All that stuff needs to be cleaned up some time.
1194 function internalAttemptSave( &$result, $bot = false ) {
1195 global $wgUser, $wgRequest, $wgParser, $wgMaxArticleSize;
1197 $status = Status
::newGood();
1199 wfProfileIn( __METHOD__
);
1200 wfProfileIn( __METHOD__
. '-checks' );
1202 if ( !wfRunHooks( 'EditPage::attemptSave', array( $this ) ) ) {
1203 wfDebug( "Hook 'EditPage::attemptSave' aborted article saving\n" );
1204 $status->fatal( 'hookaborted' );
1205 $status->value
= self
::AS_HOOK_ERROR
;
1206 wfProfileOut( __METHOD__
. '-checks' );
1207 wfProfileOut( __METHOD__
);
1212 # Construct Content object
1213 $textbox_content = $this->toEditContent( $this->textbox1
);
1214 } catch (MWContentSerializationException
$ex) {
1215 $status->fatal( 'content-failed-to-parse', $this->content_model
, $this->content_format
, $ex->getMessage() );
1216 $status->value
= self
::AS_PARSE_ERROR
;
1217 wfProfileOut( __METHOD__
);
1221 # Check image redirect
1222 if ( $this->mTitle
->getNamespace() == NS_FILE
&&
1223 $textbox_content->isRedirect() &&
1224 !$wgUser->isAllowed( 'upload' ) ) {
1225 $code = $wgUser->isAnon() ? self
::AS_IMAGE_REDIRECT_ANON
: self
::AS_IMAGE_REDIRECT_LOGGED
;
1226 $status->setResult( false, $code );
1228 wfProfileOut( __METHOD__
. '-checks' );
1229 wfProfileOut( __METHOD__
);
1235 $match = self
::matchSummarySpamRegex( $this->summary
);
1236 if ( $match === false ) {
1237 $match = self
::matchSpamRegex( $this->textbox1
);
1239 if ( $match !== false ) {
1240 $result['spam'] = $match;
1241 $ip = $wgRequest->getIP();
1242 $pdbk = $this->mTitle
->getPrefixedDBkey();
1243 $match = str_replace( "\n", '', $match );
1244 wfDebugLog( 'SpamRegex', "$ip spam regex hit [[$pdbk]]: \"$match\"" );
1245 $status->fatal( 'spamprotectionmatch', $match );
1246 $status->value
= self
::AS_SPAM_ERROR
;
1247 wfProfileOut( __METHOD__
. '-checks' );
1248 wfProfileOut( __METHOD__
);
1251 if ( !wfRunHooks( 'EditFilter', array( $this, $this->textbox1
, $this->section
, &$this->hookError
, $this->summary
) ) ) {
1252 # Error messages etc. could be handled within the hook...
1253 $status->fatal( 'hookaborted' );
1254 $status->value
= self
::AS_HOOK_ERROR
;
1255 wfProfileOut( __METHOD__
. '-checks' );
1256 wfProfileOut( __METHOD__
);
1258 } elseif ( $this->hookError
!= '' ) {
1259 # ...or the hook could be expecting us to produce an error
1260 $status->fatal( 'hookaborted' );
1261 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1262 wfProfileOut( __METHOD__
. '-checks' );
1263 wfProfileOut( __METHOD__
);
1267 if ( $wgUser->isBlockedFrom( $this->mTitle
, false ) ) {
1268 // Auto-block user's IP if the account was "hard" blocked
1269 $wgUser->spreadAnyEditBlock();
1270 # Check block state against master, thus 'false'.
1271 $status->setResult( false, self
::AS_BLOCKED_PAGE_FOR_USER
);
1272 wfProfileOut( __METHOD__
. '-checks' );
1273 wfProfileOut( __METHOD__
);
1277 $this->kblength
= (int)( strlen( $this->textbox1
) / 1024 );
1278 if ( $this->kblength
> $wgMaxArticleSize ) {
1279 // Error will be displayed by showEditForm()
1280 $this->tooBig
= true;
1281 $status->setResult( false, self
::AS_CONTENT_TOO_BIG
);
1282 wfProfileOut( __METHOD__
. '-checks' );
1283 wfProfileOut( __METHOD__
);
1287 if ( !$wgUser->isAllowed( 'edit' ) ) {
1288 if ( $wgUser->isAnon() ) {
1289 $status->setResult( false, self
::AS_READ_ONLY_PAGE_ANON
);
1290 wfProfileOut( __METHOD__
. '-checks' );
1291 wfProfileOut( __METHOD__
);
1294 $status->fatal( 'readonlytext' );
1295 $status->value
= self
::AS_READ_ONLY_PAGE_LOGGED
;
1296 wfProfileOut( __METHOD__
. '-checks' );
1297 wfProfileOut( __METHOD__
);
1302 if ( wfReadOnly() ) {
1303 $status->fatal( 'readonlytext' );
1304 $status->value
= self
::AS_READ_ONLY_PAGE
;
1305 wfProfileOut( __METHOD__
. '-checks' );
1306 wfProfileOut( __METHOD__
);
1309 if ( $wgUser->pingLimiter() ) {
1310 $status->fatal( 'actionthrottledtext' );
1311 $status->value
= self
::AS_RATE_LIMITED
;
1312 wfProfileOut( __METHOD__
. '-checks' );
1313 wfProfileOut( __METHOD__
);
1317 # If the article has been deleted while editing, don't save it without
1319 if ( $this->wasDeletedSinceLastEdit() && !$this->recreate
) {
1320 $status->setResult( false, self
::AS_ARTICLE_WAS_DELETED
);
1321 wfProfileOut( __METHOD__
. '-checks' );
1322 wfProfileOut( __METHOD__
);
1326 wfProfileOut( __METHOD__
. '-checks' );
1328 # Load the page data from the master. If anything changes in the meantime,
1329 # we detect it by using page_latest like a token in a 1 try compare-and-swap.
1330 $this->mArticle
->loadPageData( 'fromdbmaster' );
1331 $new = !$this->mArticle
->exists();
1334 // Late check for create permission, just in case *PARANOIA*
1335 if ( !$this->mTitle
->userCan( 'create' ) ) {
1336 $status->fatal( 'nocreatetext' );
1337 $status->value
= self
::AS_NO_CREATE_PERMISSION
;
1338 wfDebug( __METHOD__
. ": no create permission\n" );
1339 wfProfileOut( __METHOD__
);
1343 # Don't save a new article if it's blank.
1344 if ( $this->textbox1
== '' ) {
1345 $status->setResult( false, self
::AS_BLANK_ARTICLE
);
1346 wfProfileOut( __METHOD__
);
1350 // Run post-section-merge edit filter
1351 if ( !wfRunHooks( 'EditFilterMerged', array( $this, $this->textbox1
, &$this->hookError
, $this->summary
) ) ) {
1352 # Error messages etc. could be handled within the hook...
1353 $status->fatal( 'hookaborted' );
1354 $status->value
= self
::AS_HOOK_ERROR
;
1355 wfProfileOut( __METHOD__
);
1357 } elseif ( $this->hookError
!= '' ) {
1358 # ...or the hook could be expecting us to produce an error
1359 $status->fatal( 'hookaborted' );
1360 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1361 wfProfileOut( __METHOD__
);
1365 $content = $textbox_content;
1367 $result['sectionanchor'] = '';
1368 if ( $this->section
== 'new' ) {
1369 if ( $this->sectiontitle
!== '' ) {
1370 // Insert the section title above the content.
1371 $content = $content->addSectionHeader( $this->sectiontitle
);
1373 // Jump to the new section
1374 $result['sectionanchor'] = $wgParser->guessLegacySectionNameFromWikiText( $this->sectiontitle
);
1376 // If no edit summary was specified, create one automatically from the section
1377 // title and have it link to the new section. Otherwise, respect the summary as
1379 if ( $this->summary
=== '' ) {
1380 $cleanSectionTitle = $wgParser->stripSectionName( $this->sectiontitle
);
1381 $this->summary
= wfMessage( 'newsectionsummary', $cleanSectionTitle )
1382 ->inContentLanguage()->text() ;
1384 } elseif ( $this->summary
!== '' ) {
1385 // Insert the section title above the content.
1386 $content = $content->addSectionHeader( $this->summary
);
1388 // Jump to the new section
1389 $result['sectionanchor'] = $wgParser->guessLegacySectionNameFromWikiText( $this->summary
);
1391 // Create a link to the new section from the edit summary.
1392 $cleanSummary = $wgParser->stripSectionName( $this->summary
);
1393 $this->summary
= wfMessage( 'newsectionsummary', $cleanSummary )
1394 ->inContentLanguage()->text();
1398 $status->value
= self
::AS_SUCCESS_NEW_ARTICLE
;
1402 # Article exists. Check for edit conflict.
1404 $this->mArticle
->clear(); # Force reload of dates, etc.
1405 $timestamp = $this->mArticle
->getTimestamp();
1407 wfDebug( "timestamp: {$timestamp}, edittime: {$this->edittime}\n" );
1409 if ( $timestamp != $this->edittime
) {
1410 $this->isConflict
= true;
1411 if ( $this->section
== 'new' ) {
1412 if ( $this->mArticle
->getUserText() == $wgUser->getName() &&
1413 $this->mArticle
->getComment() == $this->summary
) {
1414 // Probably a duplicate submission of a new comment.
1415 // This can happen when squid resends a request after
1416 // a timeout but the first one actually went through.
1417 wfDebug( __METHOD__
. ": duplicate new section submission; trigger edit conflict!\n" );
1419 // New comment; suppress conflict.
1420 $this->isConflict
= false;
1421 wfDebug( __METHOD__
. ": conflict suppressed; new section\n" );
1423 } elseif ( $this->section
== '' && Revision
::userWasLastToEdit( DB_MASTER
, $this->mTitle
->getArticleID(), $wgUser->getId(), $this->edittime
) ) {
1424 # Suppress edit conflict with self, except for section edits where merging is required.
1425 wfDebug( __METHOD__
. ": Suppressing edit conflict, same user.\n" );
1426 $this->isConflict
= false;
1430 // If sectiontitle is set, use it, otherwise use the summary as the section title (for
1431 // backwards compatibility with old forms/bots).
1432 if ( $this->sectiontitle
!== '' ) {
1433 $sectionTitle = $this->sectiontitle
;
1435 $sectionTitle = $this->summary
;
1440 if ( $this->isConflict
) {
1441 wfDebug( __METHOD__
. ": conflict! getting section '{$this->section}' for time '{$this->edittime}'"
1442 . " (article time '{$timestamp}')\n" );
1444 $content = $this->mArticle
->replaceSectionContent( $this->section
, $textbox_content,
1445 $sectionTitle, $this->edittime
);
1447 wfDebug( __METHOD__
. ": getting section '{$this->section}'\n" );
1448 $content = $this->mArticle
->replaceSectionContent( $this->section
, $textbox_content, $sectionTitle );
1451 if ( is_null( $content ) ) {
1452 wfDebug( __METHOD__
. ": activating conflict; section replace failed.\n" );
1453 $this->isConflict
= true;
1454 $content = $textbox_content; // do not try to merge here!
1455 } elseif ( $this->isConflict
) {
1457 if ( $this->mergeChangesIntoContent( $textbox_content ) ) {
1458 // Successful merge! Maybe we should tell the user the good news?
1459 $this->isConflict
= false;
1460 $content = $textbox_content;
1461 wfDebug( __METHOD__
. ": Suppressing edit conflict, successful merge.\n" );
1463 $this->section
= '';
1464 #$this->textbox1 = $text; #redundant, nothing to do here?
1465 wfDebug( __METHOD__
. ": Keeping edit conflict, failed merge.\n" );
1469 if ( $this->isConflict
) {
1470 $status->setResult( false, self
::AS_CONFLICT_DETECTED
);
1471 wfProfileOut( __METHOD__
);
1475 // Run post-section-merge edit filter
1476 $hook_args = array( $this, $content, &$this->hookError
, $this->summary
);
1478 if ( !ContentHandler
::runLegacyHooks( 'EditFilterMerged', $hook_args )
1479 ||
!wfRunHooks( 'EditFilterMergedContent', $hook_args ) ) {
1480 # Error messages etc. could be handled within the hook...
1481 $status->fatal( 'hookaborted' );
1482 $status->value
= self
::AS_HOOK_ERROR
;
1483 wfProfileOut( __METHOD__
);
1485 } elseif ( $this->hookError
!= '' ) {
1486 # ...or the hook could be expecting us to produce an error
1487 $status->fatal( 'hookaborted' );
1488 $status->value
= self
::AS_HOOK_ERROR_EXPECTED
;
1489 wfProfileOut( __METHOD__
);
1493 # Handle the user preference to force summaries here, but not for null edits
1494 if ( $this->section
!= 'new' && !$this->allowBlankSummary
1495 && !$content->equals( $this->getOriginalContent() )
1496 && !$content->isRedirect() ) # check if it's not a redirect
1498 if ( md5( $this->summary
) == $this->autoSumm
) {
1499 $this->missingSummary
= true;
1500 $status->fatal( 'missingsummary' );
1501 $status->value
= self
::AS_SUMMARY_NEEDED
;
1502 wfProfileOut( __METHOD__
);
1507 # And a similar thing for new sections
1508 if ( $this->section
== 'new' && !$this->allowBlankSummary
) {
1509 if ( trim( $this->summary
) == '' ) {
1510 $this->missingSummary
= true;
1511 $status->fatal( 'missingsummary' ); // or 'missingcommentheader' if $section == 'new'. Blegh
1512 $status->value
= self
::AS_SUMMARY_NEEDED
;
1513 wfProfileOut( __METHOD__
);
1519 wfProfileIn( __METHOD__
. '-sectionanchor' );
1520 $sectionanchor = '';
1521 if ( $this->section
== 'new' ) {
1522 if ( $this->textbox1
== '' ) {
1523 $this->missingComment
= true;
1524 $status->fatal( 'missingcommenttext' );
1525 $status->value
= self
::AS_TEXTBOX_EMPTY
;
1526 wfProfileOut( __METHOD__
. '-sectionanchor' );
1527 wfProfileOut( __METHOD__
);
1530 if ( $this->sectiontitle
!== '' ) {
1531 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $this->sectiontitle
);
1532 // If no edit summary was specified, create one automatically from the section
1533 // title and have it link to the new section. Otherwise, respect the summary as
1535 if ( $this->summary
=== '' ) {
1536 $cleanSectionTitle = $wgParser->stripSectionName( $this->sectiontitle
);
1537 $this->summary
= wfMessage( 'newsectionsummary', $cleanSectionTitle )
1538 ->inContentLanguage()->text();
1540 } elseif ( $this->summary
!== '' ) {
1541 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $this->summary
);
1542 # This is a new section, so create a link to the new section
1543 # in the revision summary.
1544 $cleanSummary = $wgParser->stripSectionName( $this->summary
);
1545 $this->summary
= wfMessage( 'newsectionsummary', $cleanSummary )
1546 ->inContentLanguage()->text();
1548 } elseif ( $this->section
!= '' ) {
1549 # Try to get a section anchor from the section source, redirect to edited section if header found
1550 # XXX: might be better to integrate this into Article::replaceSection
1551 # for duplicate heading checking and maybe parsing
1552 $hasmatch = preg_match( "/^ *([=]{1,6})(.*?)(\\1) *\\n/i", $this->textbox1
, $matches );
1553 # we can't deal with anchors, includes, html etc in the header for now,
1554 # headline would need to be parsed to improve this
1555 if ( $hasmatch && strlen( $matches[2] ) > 0 ) {
1556 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $matches[2] );
1559 $result['sectionanchor'] = $sectionanchor;
1560 wfProfileOut( __METHOD__
. '-sectionanchor' );
1562 // Save errors may fall down to the edit form, but we've now
1563 // merged the section into full text. Clear the section field
1564 // so that later submission of conflict forms won't try to
1565 // replace that into a duplicated mess.
1566 $this->textbox1
= $this->toEditText( $content );
1567 $this->section
= '';
1569 $status->value
= self
::AS_SUCCESS_UPDATE
;
1572 // Check for length errors again now that the section is merged in
1573 $this->kblength
= (int)( strlen( $this->toEditText( $content ) ) / 1024 );
1574 if ( $this->kblength
> $wgMaxArticleSize ) {
1575 $this->tooBig
= true;
1576 $status->setResult( false, self
::AS_MAX_ARTICLE_SIZE_EXCEEDED
);
1577 wfProfileOut( __METHOD__
);
1581 $flags = EDIT_DEFER_UPDATES | EDIT_AUTOSUMMARY |
1582 ( $new ? EDIT_NEW
: EDIT_UPDATE
) |
1583 ( ( $this->minoredit
&& !$this->isNew
) ? EDIT_MINOR
: 0 ) |
1584 ( $bot ? EDIT_FORCE_BOT
: 0 );
1586 $doEditStatus = $this->mArticle
->doEditContent( $content, $this->summary
, $flags,
1587 false, null, $this->content_format
);
1589 if ( $doEditStatus->isOK() ) {
1590 $result['redirect'] = $content->isRedirect();
1591 $this->commitWatch();
1592 wfProfileOut( __METHOD__
);
1595 // Failure from doEdit()
1596 // Show the edit conflict page for certain recognized errors from doEdit(),
1597 // but don't show it for errors from extension hooks
1598 $errors = $doEditStatus->getErrorsArray();
1599 if ( in_array( $errors[0][0], array( 'edit-gone-missing', 'edit-conflict',
1600 'edit-already-exists' ) ) )
1602 $this->isConflict
= true;
1603 // Destroys data doEdit() put in $status->value but who cares
1604 $doEditStatus->value
= self
::AS_END
;
1606 wfProfileOut( __METHOD__
);
1607 return $doEditStatus;
1612 * Commit the change of watch status
1614 protected function commitWatch() {
1616 if ( $wgUser->isLoggedIn() && $this->watchthis
!= $wgUser->isWatched( $this->mTitle
) ) {
1617 $dbw = wfGetDB( DB_MASTER
);
1618 $dbw->begin( __METHOD__
);
1619 if ( $this->watchthis
) {
1620 WatchAction
::doWatch( $this->mTitle
, $wgUser );
1622 WatchAction
::doUnwatch( $this->mTitle
, $wgUser );
1624 $dbw->commit( __METHOD__
);
1632 * @param $editText string
1635 * @deprecated since 1.WD, use mergeChangesIntoContent() instead
1637 function mergeChangesInto( &$editText ){
1638 wfDebug( __METHOD__
, "1.WD" );
1640 $editContent = $this->toEditContent( $editText );
1642 $ok = $this->mergeChangesIntoContent( $editContent );
1645 $editText = $this->toEditText( $editContent );
1656 * @parma $editText string
1661 private function mergeChangesIntoContent( &$editContent ){
1662 wfProfileIn( __METHOD__
);
1664 $db = wfGetDB( DB_MASTER
);
1666 // This is the revision the editor started from
1667 $baseRevision = $this->getBaseRevision();
1668 if ( is_null( $baseRevision ) ) {
1669 wfProfileOut( __METHOD__
);
1672 $baseContent = $baseRevision->getContent();
1674 // The current state, we want to merge updates into it
1675 $currentRevision = Revision
::loadFromTitle( $db, $this->mTitle
);
1676 if ( is_null( $currentRevision ) ) {
1677 wfProfileOut( __METHOD__
);
1680 $currentContent = $currentRevision->getContent();
1682 $handler = ContentHandler
::getForModelID( $baseContent->getModel() );
1684 $result = $handler->merge3( $baseContent, $editContent, $currentContent );
1687 $editContent = $result;
1688 wfProfileOut( __METHOD__
);
1691 wfProfileOut( __METHOD__
);
1699 function getBaseRevision() {
1700 if ( !$this->mBaseRevision
) {
1701 $db = wfGetDB( DB_MASTER
);
1702 $baseRevision = Revision
::loadFromTimestamp(
1703 $db, $this->mTitle
, $this->edittime
);
1704 return $this->mBaseRevision
= $baseRevision;
1706 return $this->mBaseRevision
;
1711 * Check given input text against $wgSpamRegex, and return the text of the first match.
1713 * @param $text string
1715 * @return string|bool matching string or false
1717 public static function matchSpamRegex( $text ) {
1718 global $wgSpamRegex;
1719 // For back compatibility, $wgSpamRegex may be a single string or an array of regexes.
1720 $regexes = (array)$wgSpamRegex;
1721 return self
::matchSpamRegexInternal( $text, $regexes );
1725 * Check given input text against $wgSpamRegex, and return the text of the first match.
1727 * @param $text string
1729 * @return string|bool matching string or false
1731 public static function matchSummarySpamRegex( $text ) {
1732 global $wgSummarySpamRegex;
1733 $regexes = (array)$wgSummarySpamRegex;
1734 return self
::matchSpamRegexInternal( $text, $regexes );
1738 * @param $text string
1739 * @param $regexes array
1740 * @return bool|string
1742 protected static function matchSpamRegexInternal( $text, $regexes ) {
1743 foreach ( $regexes as $regex ) {
1745 if ( preg_match( $regex, $text, $matches ) ) {
1752 function setHeaders() {
1753 global $wgOut, $wgUser;
1755 $wgOut->addModules( 'mediawiki.action.edit' );
1757 if ( $wgUser->getOption( 'uselivepreview', false ) ) {
1758 $wgOut->addModules( 'mediawiki.legacy.preview' );
1760 // Bug #19334: textarea jumps when editing articles in IE8
1761 $wgOut->addStyle( 'common/IE80Fixes.css', 'screen', 'IE 8' );
1763 $wgOut->setRobotPolicy( 'noindex,nofollow' );
1765 # Enabled article-related sidebar, toplinks, etc.
1766 $wgOut->setArticleRelated( true );
1768 $contextTitle = $this->getContextTitle();
1769 if ( $this->isConflict
) {
1770 $msg = 'editconflict';
1771 } elseif ( $contextTitle->exists() && $this->section
!= '' ) {
1772 $msg = $this->section
== 'new' ?
'editingcomment' : 'editingsection';
1774 $msg = $contextTitle->exists() ||
( $contextTitle->getNamespace() == NS_MEDIAWIKI
&& $contextTitle->getDefaultMessageText() !== false ) ?
1775 'editing' : 'creating';
1777 # Use the title defined by DISPLAYTITLE magic word when present
1778 $displayTitle = isset( $this->mParserOutput
) ?
$this->mParserOutput
->getDisplayTitle() : false;
1779 if ( $displayTitle === false ) {
1780 $displayTitle = $contextTitle->getPrefixedText();
1782 $wgOut->setPageTitle( wfMessage( $msg, $displayTitle ) );
1786 * Show all applicable editing introductions
1788 protected function showIntro() {
1789 global $wgOut, $wgUser;
1790 if ( $this->suppressIntro
) {
1794 $namespace = $this->mTitle
->getNamespace();
1796 if ( $namespace == NS_MEDIAWIKI
) {
1797 # Show a warning if editing an interface message
1798 $wgOut->wrapWikiMsg( "<div class='mw-editinginterface'>\n$1\n</div>", 'editinginterface' );
1799 } else if( $namespace == NS_FILE
) {
1800 # Show a hint to shared repo
1801 $file = wfFindFile( $this->mTitle
);
1802 if( $file && !$file->isLocal() ) {
1803 $descUrl = $file->getDescriptionUrl();
1804 # there must be a description url to show a hint to shared repo
1806 if( !$this->mTitle
->exists() ) {
1807 $wgOut->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-create\">\n$1\n</div>", array (
1808 'sharedupload-desc-create', $file->getRepo()->getDisplayName(), $descUrl
1811 $wgOut->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-edit\">\n$1\n</div>", array(
1812 'sharedupload-desc-edit', $file->getRepo()->getDisplayName(), $descUrl
1819 # Show a warning message when someone creates/edits a user (talk) page but the user does not exist
1820 # Show log extract when the user is currently blocked
1821 if ( $namespace == NS_USER ||
$namespace == NS_USER_TALK
) {
1822 $parts = explode( '/', $this->mTitle
->getText(), 2 );
1823 $username = $parts[0];
1824 $user = User
::newFromName( $username, false /* allow IP users*/ );
1825 $ip = User
::isIP( $username );
1826 if ( !( $user && $user->isLoggedIn() ) && !$ip ) { # User does not exist
1827 $wgOut->wrapWikiMsg( "<div class=\"mw-userpage-userdoesnotexist error\">\n$1\n</div>",
1828 array( 'userpage-userdoesnotexist', wfEscapeWikiText( $username ) ) );
1829 } elseif ( $user->isBlocked() ) { # Show log extract if the user is currently blocked
1830 LogEventsList
::showLogExtract(
1833 $user->getUserPage(),
1837 'showIfEmpty' => false,
1839 'blocked-notice-logextract',
1840 $user->getName() # Support GENDER in notice
1846 # Try to add a custom edit intro, or use the standard one if this is not possible.
1847 if ( !$this->showCustomIntro() && !$this->mTitle
->exists() ) {
1848 if ( $wgUser->isLoggedIn() ) {
1849 $wgOut->wrapWikiMsg( "<div class=\"mw-newarticletext\">\n$1\n</div>", 'newarticletext' );
1851 $wgOut->wrapWikiMsg( "<div class=\"mw-newarticletextanon\">\n$1\n</div>", 'newarticletextanon' );
1854 # Give a notice if the user is editing a deleted/moved page...
1855 if ( !$this->mTitle
->exists() ) {
1856 LogEventsList
::showLogExtract( $wgOut, array( 'delete', 'move' ), $this->mTitle
,
1857 '', array( 'lim' => 10,
1858 'conds' => array( "log_action != 'revision'" ),
1859 'showIfEmpty' => false,
1860 'msgKey' => array( 'recreate-moveddeleted-warn' ) )
1866 * Attempt to show a custom editing introduction, if supplied
1870 protected function showCustomIntro() {
1871 if ( $this->editintro
) {
1872 $title = Title
::newFromText( $this->editintro
);
1873 if ( $title instanceof Title
&& $title->exists() && $title->userCan( 'read' ) ) {
1875 // Added using template syntax, to take <noinclude>'s into account.
1876 $wgOut->addWikiTextTitleTidy( '{{:' . $title->getFullText() . '}}', $this->mTitle
);
1887 * Gets an editable textual representation of the given Content object.
1888 * The textual representation can be turned by into a Content object by the
1889 * toEditContent() method.
1891 * If the given Content object is not of a type that can be edited using the text base EditPage,
1892 * an exception will be raised. Set $this->allowNonTextContent to true to allow editing of non-textual
1895 * @param Content $content
1896 * @return String the editable text form of the content.
1898 * @throws MWException if $content is not an instance of TextContent and $this->allowNonTextContent is not true.
1900 protected function toEditText( Content
$content ) {
1901 if ( !$this->allowNonTextContent
&& !( $content instanceof TextContent
) ) {
1902 throw new MWException( "This content model can not be edited as text: "
1903 . ContentHandler
::getLocalizedName( $content->getModel() ) );
1906 return $content->serialize( $this->content_format
);
1910 * Turns the given text into a Content object by unserializing it.
1912 * If the resulting Content object is not of a type that can be edited using the text base EditPage,
1913 * an exception will be raised. Set $this->allowNonTextContent to true to allow editing of non-textual
1916 * @param String $text Text to unserialize
1917 * @return Content the content object created from $text
1919 * @throws MWException if unserializing the text results in a Content object that is not an instance of TextContent
1920 * and $this->allowNonTextContent is not true.
1922 protected function toEditContent( $text ) {
1923 $content = ContentHandler
::makeContent( $text, $this->getTitle(),
1924 $this->content_model
, $this->content_format
);
1926 if ( !$this->allowNonTextContent
&& !( $content instanceof TextContent
) ) {
1927 throw new MWException( "This content model can not be edited as text: "
1928 . ContentHandler
::getLocalizedName( $content->getModel() ) );
1935 * Send the edit form and related headers to $wgOut
1936 * @param $formCallback Callback that takes an OutputPage parameter; will be called
1937 * during form output near the top, for captchas and the like.
1939 function showEditForm( $formCallback = null ) {
1940 global $wgOut, $wgUser;
1942 wfProfileIn( __METHOD__
);
1944 # need to parse the preview early so that we know which templates are used,
1945 # otherwise users with "show preview after edit box" will get a blank list
1946 # we parse this near the beginning so that setHeaders can do the title
1947 # setting work instead of leaving it in getPreviewText
1948 $previewOutput = '';
1949 if ( $this->formtype
== 'preview' ) {
1950 $previewOutput = $this->getPreviewText();
1953 wfRunHooks( 'EditPage::showEditForm:initial', array( &$this, &$wgOut ) );
1955 $this->setHeaders();
1957 if ( $this->showHeader() === false ) {
1958 wfProfileOut( __METHOD__
);
1962 $wgOut->addHTML( $this->editFormPageTop
);
1964 if ( $wgUser->getOption( 'previewontop' ) ) {
1965 $this->displayPreviewArea( $previewOutput, true );
1968 $wgOut->addHTML( $this->editFormTextTop
);
1970 $showToolbar = true;
1971 if ( $this->wasDeletedSinceLastEdit() ) {
1972 if ( $this->formtype
== 'save' ) {
1973 // Hide the toolbar and edit area, user can click preview to get it back
1974 // Add an confirmation checkbox and explanation.
1975 $showToolbar = false;
1977 $wgOut->wrapWikiMsg( "<div class='error mw-deleted-while-editing'>\n$1\n</div>",
1978 'deletedwhileediting' );
1982 //@todo: add EditForm plugin interface and use it here!
1983 // search for textarea1 and textares2, and allow EditForm to override all uses.
1984 $wgOut->addHTML( Html
::openElement( 'form', array( 'id' => self
::EDITFORM_ID
, 'name' => self
::EDITFORM_ID
,
1985 'method' => 'post', 'action' => $this->getActionURL( $this->getContextTitle() ),
1986 'enctype' => 'multipart/form-data' ) ) );
1988 if ( is_callable( $formCallback ) ) {
1989 call_user_func_array( $formCallback, array( &$wgOut ) );
1992 wfRunHooks( 'EditPage::showEditForm:fields', array( &$this, &$wgOut ) );
1994 // Put these up at the top to ensure they aren't lost on early form submission
1995 $this->showFormBeforeText();
1997 if ( $this->wasDeletedSinceLastEdit() && 'save' == $this->formtype
) {
1998 $username = $this->lastDelete
->user_name
;
1999 $comment = $this->lastDelete
->log_comment
;
2001 // It is better to not parse the comment at all than to have templates expanded in the middle
2002 // TODO: can the checkLabel be moved outside of the div so that wrapWikiMsg could be used?
2003 $key = $comment === ''
2004 ?
'confirmrecreate-noreason'
2005 : 'confirmrecreate';
2007 '<div class="mw-confirm-recreate">' .
2008 wfMessage( $key, $username, "<nowiki>$comment</nowiki>" )->parse() .
2009 Xml
::checkLabel( wfMessage( 'recreate' )->text(), 'wpRecreate', 'wpRecreate', false,
2010 array( 'title' => Linker
::titleAttrib( 'recreate' ), 'tabindex' => 1, 'id' => 'wpRecreate' )
2016 # When the summary is hidden, also hide them on preview/show changes
2017 if( $this->nosummary
) {
2018 $wgOut->addHTML( Html
::hidden( 'nosummary', true ) );
2021 # If a blank edit summary was previously provided, and the appropriate
2022 # user preference is active, pass a hidden tag as wpIgnoreBlankSummary. This will stop the
2023 # user being bounced back more than once in the event that a summary
2026 # For a bit more sophisticated detection of blank summaries, hash the
2027 # automatic one and pass that in the hidden field wpAutoSummary.
2028 if ( $this->missingSummary ||
( $this->section
== 'new' && $this->nosummary
) ) {
2029 $wgOut->addHTML( Html
::hidden( 'wpIgnoreBlankSummary', true ) );
2032 if ( $this->undidRev
) {
2033 $wgOut->addHTML( Html
::hidden( 'wpUndidRevision', $this->undidRev
) );
2036 if ( $this->hasPresetSummary
) {
2037 // If a summary has been preset using &summary= we dont want to prompt for
2038 // a different summary. Only prompt for a summary if the summary is blanked.
2040 $this->autoSumm
= md5( '' );
2043 $autosumm = $this->autoSumm ?
$this->autoSumm
: md5( $this->summary
);
2044 $wgOut->addHTML( Html
::hidden( 'wpAutoSummary', $autosumm ) );
2046 $wgOut->addHTML( Html
::hidden( 'oldid', $this->oldid
) );
2048 $wgOut->addHTML( Html
::hidden( 'format', $this->content_format
) );
2049 $wgOut->addHTML( Html
::hidden( 'model', $this->content_model
) );
2051 if ( $this->section
== 'new' ) {
2052 $this->showSummaryInput( true, $this->summary
);
2053 $wgOut->addHTML( $this->getSummaryPreview( true, $this->summary
) );
2056 $wgOut->addHTML( $this->editFormTextBeforeContent
);
2058 if ( !$this->isCssJsSubpage
&& $showToolbar && $wgUser->getOption( 'showtoolbar' ) ) {
2059 $wgOut->addHTML( EditPage
::getEditToolbar() );
2062 if ( $this->isConflict
) {
2063 // In an edit conflict bypass the overrideable content form method
2064 // and fallback to the raw wpTextbox1 since editconflicts can't be
2065 // resolved between page source edits and custom ui edits using the
2067 $this->textbox2
= $this->textbox1
;
2069 $content = $this->getCurrentContent();
2070 $this->textbox1
= $this->toEditText( $content );
2072 $this->showTextbox1();
2074 $this->showContentForm();
2077 $wgOut->addHTML( $this->editFormTextAfterContent
);
2079 $this->showStandardInputs();
2081 $this->showFormAfterText();
2083 $this->showTosSummary();
2085 $this->showEditTools();
2087 $wgOut->addHTML( $this->editFormTextAfterTools
. "\n" );
2089 $wgOut->addHTML( Html
::rawElement( 'div', array( 'class' => 'templatesUsed' ),
2090 Linker
::formatTemplates( $this->getTemplates(), $this->preview
, $this->section
!= '' ) ) );
2092 $wgOut->addHTML( Html
::rawElement( 'div', array( 'class' => 'hiddencats' ),
2093 Linker
::formatHiddenCategories( $this->mArticle
->getHiddenCategories() ) ) );
2095 if ( $this->isConflict
) {
2097 $this->showConflict();
2098 } catch ( MWContentSerializationException
$ex ) {
2099 // this can't really happen, but be nice if it does.
2100 $msg = wfMessage( 'content-failed-to-parse', $this->content_model
, $this->content_format
, $ex->getMessage() );
2101 $wgOut->addWikiText( '<div class="error">' . $msg->text() . '</div>');
2105 $wgOut->addHTML( $this->editFormTextBottom
. "\n</form>\n" );
2107 if ( !$wgUser->getOption( 'previewontop' ) ) {
2108 $this->displayPreviewArea( $previewOutput, false );
2111 wfProfileOut( __METHOD__
);
2115 * Extract the section title from current section text, if any.
2117 * @param string $text
2118 * @return Mixed|string or false
2120 public static function extractSectionTitle( $text ) {
2121 preg_match( "/^(=+)(.+)\\1\\s*(\n|$)/i", $text, $matches );
2122 if ( !empty( $matches[2] ) ) {
2124 return $wgParser->stripSectionName( trim( $matches[2] ) );
2130 protected function showHeader() {
2131 global $wgOut, $wgUser, $wgMaxArticleSize, $wgLang;
2133 if ( $this->mTitle
->isTalkPage() ) {
2134 $wgOut->addWikiMsg( 'talkpagetext' );
2137 # Optional notices on a per-namespace and per-page basis
2138 $editnotice_ns = 'editnotice-' . $this->mTitle
->getNamespace();
2139 $editnotice_ns_message = wfMessage( $editnotice_ns );
2140 if ( $editnotice_ns_message->exists() ) {
2141 $wgOut->addWikiText( $editnotice_ns_message->plain() );
2143 if ( MWNamespace
::hasSubpages( $this->mTitle
->getNamespace() ) ) {
2144 $parts = explode( '/', $this->mTitle
->getDBkey() );
2145 $editnotice_base = $editnotice_ns;
2146 while ( count( $parts ) > 0 ) {
2147 $editnotice_base .= '-' . array_shift( $parts );
2148 $editnotice_base_msg = wfMessage( $editnotice_base );
2149 if ( $editnotice_base_msg->exists() ) {
2150 $wgOut->addWikiText( $editnotice_base_msg->plain() );
2154 # Even if there are no subpages in namespace, we still don't want / in MW ns.
2155 $editnoticeText = $editnotice_ns . '-' . str_replace( '/', '-', $this->mTitle
->getDBkey() );
2156 $editnoticeMsg = wfMessage( $editnoticeText );
2157 if ( $editnoticeMsg->exists() ) {
2158 $wgOut->addWikiText( $editnoticeMsg->plain() );
2162 if ( $this->isConflict
) {
2163 $wgOut->wrapWikiMsg( "<div class='mw-explainconflict'>\n$1\n</div>", 'explainconflict' );
2164 $this->edittime
= $this->mArticle
->getTimestamp();
2166 if ( $this->section
!= '' && !$this->isSectionEditSupported() ) {
2167 // We use $this->section to much before this and getVal('wgSection') directly in other places
2168 // at this point we can't reset $this->section to '' to fallback to non-section editing.
2169 // Someone is welcome to try refactoring though
2170 $wgOut->showErrorPage( 'sectioneditnotsupported-title', 'sectioneditnotsupported-text' );
2174 if ( $this->section
!= '' && $this->section
!= 'new' ) {
2175 if ( !$this->summary
&& !$this->preview
&& !$this->diff
) {
2176 $sectionTitle = self
::extractSectionTitle( $this->textbox1
); //FIXME: use Content object
2177 if ( $sectionTitle !== false ) {
2178 $this->summary
= "/* $sectionTitle */ ";
2183 if ( $this->missingComment
) {
2184 $wgOut->wrapWikiMsg( "<div id='mw-missingcommenttext'>\n$1\n</div>", 'missingcommenttext' );
2187 if ( $this->missingSummary
&& $this->section
!= 'new' ) {
2188 $wgOut->wrapWikiMsg( "<div id='mw-missingsummary'>\n$1\n</div>", 'missingsummary' );
2191 if ( $this->missingSummary
&& $this->section
== 'new' ) {
2192 $wgOut->wrapWikiMsg( "<div id='mw-missingcommentheader'>\n$1\n</div>", 'missingcommentheader' );
2195 if ( $this->hookError
!== '' ) {
2196 $wgOut->addWikiText( $this->hookError
);
2199 if ( !$this->checkUnicodeCompliantBrowser() ) {
2200 $wgOut->addWikiMsg( 'nonunicodebrowser' );
2203 if ( $this->section
!= 'new' ) {
2204 $revision = $this->mArticle
->getRevisionFetched();
2206 // Let sysop know that this will make private content public if saved
2208 if ( !$revision->userCan( Revision
::DELETED_TEXT
) ) {
2209 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n", 'rev-deleted-text-permission' );
2210 } elseif ( $revision->isDeleted( Revision
::DELETED_TEXT
) ) {
2211 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n", 'rev-deleted-text-view' );
2214 if ( !$revision->isCurrent() ) {
2215 $this->mArticle
->setOldSubtitle( $revision->getId() );
2216 $wgOut->addWikiMsg( 'editingold' );
2218 } elseif ( $this->mTitle
->exists() ) {
2219 // Something went wrong
2221 $wgOut->wrapWikiMsg( "<div class='errorbox'>\n$1\n</div>\n",
2222 array( 'missing-revision', $this->oldid
) );
2227 if ( wfReadOnly() ) {
2228 $wgOut->wrapWikiMsg( "<div id=\"mw-read-only-warning\">\n$1\n</div>", array( 'readonlywarning', wfReadOnlyReason() ) );
2229 } elseif ( $wgUser->isAnon() ) {
2230 if ( $this->formtype
!= 'preview' ) {
2231 $wgOut->wrapWikiMsg( "<div id=\"mw-anon-edit-warning\">\n$1</div>", 'anoneditwarning' );
2233 $wgOut->wrapWikiMsg( "<div id=\"mw-anon-preview-warning\">\n$1</div>", 'anonpreviewwarning' );
2236 if ( $this->isCssJsSubpage
) {
2237 # Check the skin exists
2238 if ( $this->isWrongCaseCssJsPage
) {
2239 $wgOut->wrapWikiMsg( "<div class='error' id='mw-userinvalidcssjstitle'>\n$1\n</div>", array( 'userinvalidcssjstitle', $this->mTitle
->getSkinFromCssJsSubpage() ) );
2241 if ( $this->formtype
!== 'preview' ) {
2242 if ( $this->isCssSubpage
)
2243 $wgOut->wrapWikiMsg( "<div id='mw-usercssyoucanpreview'>\n$1\n</div>", array( 'usercssyoucanpreview' ) );
2244 if ( $this->isJsSubpage
)
2245 $wgOut->wrapWikiMsg( "<div id='mw-userjsyoucanpreview'>\n$1\n</div>", array( 'userjsyoucanpreview' ) );
2250 if ( $this->mTitle
->getNamespace() != NS_MEDIAWIKI
&& $this->mTitle
->isProtected( 'edit' ) ) {
2251 # Is the title semi-protected?
2252 if ( $this->mTitle
->isSemiProtected() ) {
2253 $noticeMsg = 'semiprotectedpagewarning';
2255 # Then it must be protected based on static groups (regular)
2256 $noticeMsg = 'protectedpagewarning';
2258 LogEventsList
::showLogExtract( $wgOut, 'protect', $this->mTitle
, '',
2259 array( 'lim' => 1, 'msgKey' => array( $noticeMsg ) ) );
2261 if ( $this->mTitle
->isCascadeProtected() ) {
2262 # Is this page under cascading protection from some source pages?
2263 list( $cascadeSources, /* $restrictions */ ) = $this->mTitle
->getCascadeProtectionSources();
2264 $notice = "<div class='mw-cascadeprotectedwarning'>\n$1\n";
2265 $cascadeSourcesCount = count( $cascadeSources );
2266 if ( $cascadeSourcesCount > 0 ) {
2267 # Explain, and list the titles responsible
2268 foreach ( $cascadeSources as $page ) {
2269 $notice .= '* [[:' . $page->getPrefixedText() . "]]\n";
2272 $notice .= '</div>';
2273 $wgOut->wrapWikiMsg( $notice, array( 'cascadeprotectedwarning', $cascadeSourcesCount ) );
2275 if ( !$this->mTitle
->exists() && $this->mTitle
->getRestrictions( 'create' ) ) {
2276 LogEventsList
::showLogExtract( $wgOut, 'protect', $this->mTitle
, '',
2278 'showIfEmpty' => false,
2279 'msgKey' => array( 'titleprotectedwarning' ),
2280 'wrap' => "<div class=\"mw-titleprotectedwarning\">\n$1</div>" ) );
2283 if ( $this->kblength
=== false ) {
2284 $this->kblength
= (int)( strlen( $this->textbox1
) / 1024 );
2287 if ( $this->tooBig ||
$this->kblength
> $wgMaxArticleSize ) {
2288 $wgOut->wrapWikiMsg( "<div class='error' id='mw-edit-longpageerror'>\n$1\n</div>",
2289 array( 'longpageerror', $wgLang->formatNum( $this->kblength
), $wgLang->formatNum( $wgMaxArticleSize ) ) );
2291 if ( !wfMessage( 'longpage-hint' )->isDisabled() ) {
2292 $wgOut->wrapWikiMsg( "<div id='mw-edit-longpage-hint'>\n$1\n</div>",
2293 array( 'longpage-hint', $wgLang->formatSize( strlen( $this->textbox1
) ), strlen( $this->textbox1
) )
2297 # Add header copyright warning
2298 $this->showHeaderCopyrightWarning();
2303 * Standard summary input and label (wgSummary), abstracted so EditPage
2304 * subclasses may reorganize the form.
2305 * Note that you do not need to worry about the label's for=, it will be
2306 * inferred by the id given to the input. You can remove them both by
2307 * passing array( 'id' => false ) to $userInputAttrs.
2309 * @param $summary string The value of the summary input
2310 * @param $labelText string The html to place inside the label
2311 * @param $inputAttrs array of attrs to use on the input
2312 * @param $spanLabelAttrs array of attrs to use on the span inside the label
2314 * @return array An array in the format array( $label, $input )
2316 function getSummaryInput( $summary = "", $labelText = null, $inputAttrs = null, $spanLabelAttrs = null ) {
2317 // Note: the maxlength is overriden in JS to 255 and to make it use UTF-8 bytes, not characters.
2318 $inputAttrs = ( is_array( $inputAttrs ) ?
$inputAttrs : array() ) +
array(
2319 'id' => 'wpSummary',
2320 'maxlength' => '200',
2323 'spellcheck' => 'true',
2324 ) + Linker
::tooltipAndAccesskeyAttribs( 'summary' );
2326 $spanLabelAttrs = ( is_array( $spanLabelAttrs ) ?
$spanLabelAttrs : array() ) +
array(
2327 'class' => $this->missingSummary ?
'mw-summarymissed' : 'mw-summary',
2328 'id' => "wpSummaryLabel"
2333 $label = Xml
::tags( 'label', $inputAttrs['id'] ?
array( 'for' => $inputAttrs['id'] ) : null, $labelText );
2334 $label = Xml
::tags( 'span', $spanLabelAttrs, $label );
2337 $input = Html
::input( 'wpSummary', $summary, 'text', $inputAttrs );
2339 return array( $label, $input );
2343 * @param $isSubjectPreview Boolean: true if this is the section subject/title
2344 * up top, or false if this is the comment summary
2345 * down below the textarea
2346 * @param $summary String: The text of the summary to display
2349 protected function showSummaryInput( $isSubjectPreview, $summary = "" ) {
2350 global $wgOut, $wgContLang;
2351 # Add a class if 'missingsummary' is triggered to allow styling of the summary line
2352 $summaryClass = $this->missingSummary ?
'mw-summarymissed' : 'mw-summary';
2353 if ( $isSubjectPreview ) {
2354 if ( $this->nosummary
) {
2358 if ( !$this->mShowSummaryField
) {
2362 $summary = $wgContLang->recodeForEdit( $summary );
2363 $labelText = wfMessage( $isSubjectPreview ?
'subject' : 'summary' )->parse();
2364 list( $label, $input ) = $this->getSummaryInput( $summary, $labelText, array( 'class' => $summaryClass ), array() );
2365 $wgOut->addHTML( "{$label} {$input}" );
2369 * @param $isSubjectPreview Boolean: true if this is the section subject/title
2370 * up top, or false if this is the comment summary
2371 * down below the textarea
2372 * @param $summary String: the text of the summary to display
2375 protected function getSummaryPreview( $isSubjectPreview, $summary = "" ) {
2376 if ( !$summary ||
( !$this->preview
&& !$this->diff
) )
2381 if ( $isSubjectPreview )
2382 $summary = wfMessage( 'newsectionsummary', $wgParser->stripSectionName( $summary ) )
2383 ->inContentLanguage()->text();
2385 $message = $isSubjectPreview ?
'subject-preview' : 'summary-preview';
2387 $summary = wfMessage( $message )->parse() . Linker
::commentBlock( $summary, $this->mTitle
, $isSubjectPreview );
2388 return Xml
::tags( 'div', array( 'class' => 'mw-summary-preview' ), $summary );
2391 protected function showFormBeforeText() {
2393 $section = htmlspecialchars( $this->section
);
2394 $wgOut->addHTML( <<<HTML
2395 <input type='hidden' value="{$section}" name="wpSection" />
2396 <input type='hidden' value="{$this->starttime}" name="wpStarttime" />
2397 <input type='hidden' value="{$this->edittime}" name="wpEdittime" />
2398 <input type='hidden' value="{$this->scrolltop}" name="wpScrolltop" id="wpScrolltop" />
2402 if ( !$this->checkUnicodeCompliantBrowser() )
2403 $wgOut->addHTML( Html
::hidden( 'safemode', '1' ) );
2406 protected function showFormAfterText() {
2407 global $wgOut, $wgUser;
2409 * To make it harder for someone to slip a user a page
2410 * which submits an edit form to the wiki without their
2411 * knowledge, a random token is associated with the login
2412 * session. If it's not passed back with the submission,
2413 * we won't save the page, or render user JavaScript and
2416 * For anon editors, who may not have a session, we just
2417 * include the constant suffix to prevent editing from
2418 * broken text-mangling proxies.
2420 $wgOut->addHTML( "\n" . Html
::hidden( "wpEditToken", $wgUser->getEditToken() ) . "\n" );
2424 * Subpage overridable method for printing the form for page content editing
2425 * By default this simply outputs wpTextbox1
2426 * Subclasses can override this to provide a custom UI for editing;
2427 * be it a form, or simply wpTextbox1 with a modified content that will be
2428 * reverse modified when extracted from the post data.
2429 * Note that this is basically the inverse for importContentFormData
2431 protected function showContentForm() {
2432 $this->showTextbox1();
2436 * Method to output wpTextbox1
2437 * The $textoverride method can be used by subclasses overriding showContentForm
2438 * to pass back to this method.
2440 * @param $customAttribs array of html attributes to use in the textarea
2441 * @param $textoverride String: optional text to override $this->textarea1 with
2443 protected function showTextbox1( $customAttribs = null, $textoverride = null ) {
2444 if ( $this->wasDeletedSinceLastEdit() && $this->formtype
== 'save' ) {
2445 $attribs = array( 'style' => 'display:none;' );
2447 $classes = array(); // Textarea CSS
2448 if ( $this->mTitle
->getNamespace() != NS_MEDIAWIKI
&& $this->mTitle
->isProtected( 'edit' ) ) {
2449 # Is the title semi-protected?
2450 if ( $this->mTitle
->isSemiProtected() ) {
2451 $classes[] = 'mw-textarea-sprotected';
2453 # Then it must be protected based on static groups (regular)
2454 $classes[] = 'mw-textarea-protected';
2456 # Is the title cascade-protected?
2457 if ( $this->mTitle
->isCascadeProtected() ) {
2458 $classes[] = 'mw-textarea-cprotected';
2462 $attribs = array( 'tabindex' => 1 );
2464 if ( is_array( $customAttribs ) ) {
2465 $attribs +
= $customAttribs;
2468 if ( count( $classes ) ) {
2469 if ( isset( $attribs['class'] ) ) {
2470 $classes[] = $attribs['class'];
2472 $attribs['class'] = implode( ' ', $classes );
2476 $this->showTextbox( $textoverride !== null ?
$textoverride : $this->textbox1
, 'wpTextbox1', $attribs );
2479 protected function showTextbox2() {
2480 $this->showTextbox( $this->textbox2
, 'wpTextbox2', array( 'tabindex' => 6, 'readonly' ) );
2483 protected function showTextbox( $text, $name, $customAttribs = array() ) {
2484 global $wgOut, $wgUser;
2486 $wikitext = $this->safeUnicodeOutput( $text );
2487 if ( strval( $wikitext ) !== '' ) {
2488 // Ensure there's a newline at the end, otherwise adding lines
2490 // But don't add a newline if the ext is empty, or Firefox in XHTML
2491 // mode will show an extra newline. A bit annoying.
2495 $attribs = $customAttribs +
array(
2498 'cols' => $wgUser->getIntOption( 'cols' ),
2499 'rows' => $wgUser->getIntOption( 'rows' ),
2500 'style' => '' // avoid php notices when appending preferences (appending allows customAttribs['style'] to still work
2503 $pageLang = $this->mTitle
->getPageLanguage();
2504 $attribs['lang'] = $pageLang->getCode();
2505 $attribs['dir'] = $pageLang->getDir();
2507 $wgOut->addHTML( Html
::textarea( $name, $wikitext, $attribs ) );
2510 protected function displayPreviewArea( $previewOutput, $isOnTop = false ) {
2514 $classes[] = 'ontop';
2516 $attribs = array( 'id' => 'wikiPreview', 'class' => implode( ' ', $classes ) );
2518 if ( $this->formtype
!= 'preview' )
2519 $attribs['style'] = 'display: none;';
2521 $wgOut->addHTML( Xml
::openElement( 'div', $attribs ) );
2523 if ( $this->formtype
== 'preview' ) {
2524 $this->showPreview( $previewOutput );
2527 $wgOut->addHTML( '</div>' );
2529 if ( $this->formtype
== 'diff' ) {
2532 } catch ( MWContentSerializationException
$ex ) {
2533 $msg = wfMessage( 'content-failed-to-parse', $this->content_model
, $this->content_format
, $ex->getMessage() );
2534 $wgOut->addWikiText( '<div class="error">' . $msg->text() . '</div>');
2540 * Append preview output to $wgOut.
2541 * Includes category rendering if this is a category page.
2543 * @param $text String: the HTML to be output for the preview.
2545 protected function showPreview( $text ) {
2547 if ( $this->mTitle
->getNamespace() == NS_CATEGORY
) {
2548 $this->mArticle
->openShowCategory();
2550 # This hook seems slightly odd here, but makes things more
2551 # consistent for extensions.
2552 wfRunHooks( 'OutputPageBeforeHTML', array( &$wgOut, &$text ) );
2553 $wgOut->addHTML( $text );
2554 if ( $this->mTitle
->getNamespace() == NS_CATEGORY
) {
2555 $this->mArticle
->closeShowCategory();
2560 * Get a diff between the current contents of the edit box and the
2561 * version of the page we're editing from.
2563 * If this is a section edit, we'll replace the section as for final
2564 * save and then make a comparison.
2566 function showDiff() {
2567 global $wgUser, $wgContLang, $wgParser, $wgOut;
2569 $oldtitlemsg = 'currentrev';
2570 # if message does not exist, show diff against the preloaded default
2571 if( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
&& !$this->mTitle
->exists() ) {
2572 $oldtext = $this->mTitle
->getDefaultMessageText();
2573 if( $oldtext !== false ) {
2574 $oldtitlemsg = 'defaultmessagetext';
2575 $oldContent = $this->toEditContent( $oldtext );
2580 $oldContent = $this->getOriginalContent();
2583 $textboxContent = $this->toEditContent( $this->textbox1
);
2585 $newContent = $this->mArticle
->replaceSectionContent(
2586 $this->section
, $textboxContent,
2587 $this->summary
, $this->edittime
);
2589 ContentHandler
::runLegacyHooks( 'EditPageGetDiffText', array( $this, &$newContent ) );
2590 wfRunHooks( 'EditPageGetDiffContent', array( $this, &$newContent ) );
2592 $popts = ParserOptions
::newFromUserAndLang( $wgUser, $wgContLang );
2593 $newContent = $newContent->preSaveTransform( $this->mTitle
, $wgUser, $popts );
2595 if ( ( $oldContent && !$oldContent->isEmpty() ) ||
( $newContent && !$newContent->isEmpty() ) ) {
2596 $oldtitle = wfMessage( $oldtitlemsg )->parse();
2597 $newtitle = wfMessage( 'yourtext' )->parse();
2599 $de = $oldContent->getContentHandler()->createDifferenceEngine( $this->mArticle
->getContext() );
2600 $de->setContent( $oldContent, $newContent );
2602 $difftext = $de->getDiff( $oldtitle, $newtitle );
2603 $de->showDiffStyle();
2608 $wgOut->addHTML( '<div id="wikiDiff">' . $difftext . '</div>' );
2612 * Show the header copyright warning.
2614 protected function showHeaderCopyrightWarning() {
2615 $msg = 'editpage-head-copy-warn';
2616 if ( !wfMessage( $msg )->isDisabled() ) {
2618 $wgOut->wrapWikiMsg( "<div class='editpage-head-copywarn'>\n$1\n</div>",
2619 'editpage-head-copy-warn' );
2624 * Give a chance for site and per-namespace customizations of
2625 * terms of service summary link that might exist separately
2626 * from the copyright notice.
2628 * This will display between the save button and the edit tools,
2629 * so should remain short!
2631 protected function showTosSummary() {
2632 $msg = 'editpage-tos-summary';
2633 wfRunHooks( 'EditPageTosSummary', array( $this->mTitle
, &$msg ) );
2634 if ( !wfMessage( $msg )->isDisabled() ) {
2636 $wgOut->addHTML( '<div class="mw-tos-summary">' );
2637 $wgOut->addWikiMsg( $msg );
2638 $wgOut->addHTML( '</div>' );
2642 protected function showEditTools() {
2644 $wgOut->addHTML( '<div class="mw-editTools">' .
2645 wfMessage( 'edittools' )->inContentLanguage()->parse() .
2650 * Get the copyright warning
2652 * Renamed to getCopyrightWarning(), old name kept around for backwards compatibility
2654 protected function getCopywarn() {
2655 return self
::getCopyrightWarning( $this->mTitle
);
2658 public static function getCopyrightWarning( $title ) {
2659 global $wgRightsText;
2660 if ( $wgRightsText ) {
2661 $copywarnMsg = array( 'copyrightwarning',
2662 '[[' . wfMessage( 'copyrightpage' )->inContentLanguage()->text() . ']]',
2665 $copywarnMsg = array( 'copyrightwarning2',
2666 '[[' . wfMessage( 'copyrightpage' )->inContentLanguage()->text() . ']]' );
2668 // Allow for site and per-namespace customization of contribution/copyright notice.
2669 wfRunHooks( 'EditPageCopyrightWarning', array( $title, &$copywarnMsg ) );
2671 return "<div id=\"editpage-copywarn\">\n" .
2672 call_user_func_array( 'wfMessage', $copywarnMsg )->plain() . "\n</div>";
2675 protected function showStandardInputs( &$tabindex = 2 ) {
2677 $wgOut->addHTML( "<div class='editOptions'>\n" );
2679 if ( $this->section
!= 'new' ) {
2680 $this->showSummaryInput( false, $this->summary
);
2681 $wgOut->addHTML( $this->getSummaryPreview( false, $this->summary
) );
2684 $checkboxes = $this->getCheckboxes( $tabindex,
2685 array( 'minor' => $this->minoredit
, 'watch' => $this->watchthis
) );
2686 $wgOut->addHTML( "<div class='editCheckboxes'>" . implode( $checkboxes, "\n" ) . "</div>\n" );
2688 // Show copyright warning.
2689 $wgOut->addWikiText( $this->getCopywarn() );
2690 $wgOut->addHTML( $this->editFormTextAfterWarn
);
2692 $wgOut->addHTML( "<div class='editButtons'>\n" );
2693 $wgOut->addHTML( implode( $this->getEditButtons( $tabindex ), "\n" ) . "\n" );
2695 $cancel = $this->getCancelLink();
2696 if ( $cancel !== '' ) {
2697 $cancel .= wfMessage( 'pipe-separator' )->text();
2699 $edithelpurl = Skin
::makeInternalOrExternalUrl( wfMessage( 'edithelppage' )->inContentLanguage()->text() );
2700 $edithelp = '<a target="helpwindow" href="' . $edithelpurl . '">' .
2701 wfMessage( 'edithelp' )->escaped() . '</a> ' .
2702 wfMessage( 'newwindow' )->parse();
2703 $wgOut->addHTML( " <span class='cancelLink'>{$cancel}</span>\n" );
2704 $wgOut->addHTML( " <span class='editHelp'>{$edithelp}</span>\n" );
2705 $wgOut->addHTML( "</div><!-- editButtons -->\n</div><!-- editOptions -->\n" );
2709 * Show an edit conflict. textbox1 is already shown in showEditForm().
2710 * If you want to use another entry point to this function, be careful.
2712 protected function showConflict() {
2715 if ( wfRunHooks( 'EditPageBeforeConflictDiff', array( &$this, &$wgOut ) ) ) {
2716 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
2718 $content1 = $this->toEditContent( $this->textbox1
);
2719 $content2 = $this->toEditContent( $this->textbox2
);
2721 $handler = ContentHandler
::getForModelID( $this->content_model
);
2722 $de = $handler->createDifferenceEngine( $this->mArticle
->getContext() );
2723 $de->setContent( $content2, $content1 );
2725 wfMessage( 'yourtext' )->parse(),
2726 wfMessage( 'storedversion' )->text()
2729 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
2730 $this->showTextbox2();
2737 public function getCancelLink() {
2738 $cancelParams = array();
2739 if ( !$this->isConflict
&& $this->oldid
> 0 ) {
2740 $cancelParams['oldid'] = $this->oldid
;
2743 return Linker
::linkKnown(
2744 $this->getContextTitle(),
2745 wfMessage( 'cancel' )->parse(),
2746 array( 'id' => 'mw-editform-cancel' ),
2752 * Returns the URL to use in the form's action attribute.
2753 * This is used by EditPage subclasses when simply customizing the action
2754 * variable in the constructor is not enough. This can be used when the
2755 * EditPage lives inside of a Special page rather than a custom page action.
2757 * @param $title Title object for which is being edited (where we go to for &action= links)
2760 protected function getActionURL( Title
$title ) {
2761 return $title->getLocalURL( array( 'action' => $this->action
) );
2765 * Check if a page was deleted while the user was editing it, before submit.
2766 * Note that we rely on the logging table, which hasn't been always there,
2767 * but that doesn't matter, because this only applies to brand new
2770 protected function wasDeletedSinceLastEdit() {
2771 if ( $this->deletedSinceEdit
!== null ) {
2772 return $this->deletedSinceEdit
;
2775 $this->deletedSinceEdit
= false;
2777 if ( $this->mTitle
->isDeletedQuick() ) {
2778 $this->lastDelete
= $this->getLastDelete();
2779 if ( $this->lastDelete
) {
2780 $deleteTime = wfTimestamp( TS_MW
, $this->lastDelete
->log_timestamp
);
2781 if ( $deleteTime > $this->starttime
) {
2782 $this->deletedSinceEdit
= true;
2787 return $this->deletedSinceEdit
;
2790 protected function getLastDelete() {
2791 $dbr = wfGetDB( DB_SLAVE
);
2792 $data = $dbr->selectRow(
2793 array( 'logging', 'user' ),
2804 array( 'log_namespace' => $this->mTitle
->getNamespace(),
2805 'log_title' => $this->mTitle
->getDBkey(),
2806 'log_type' => 'delete',
2807 'log_action' => 'delete',
2808 'user_id=log_user' ),
2810 array( 'LIMIT' => 1, 'ORDER BY' => 'log_timestamp DESC' )
2812 // Quick paranoid permission checks...
2813 if ( is_object( $data ) ) {
2814 if ( $data->log_deleted
& LogPage
::DELETED_USER
)
2815 $data->user_name
= wfMessage( 'rev-deleted-user' )->escaped();
2816 if ( $data->log_deleted
& LogPage
::DELETED_COMMENT
)
2817 $data->log_comment
= wfMessage( 'rev-deleted-comment' )->escaped();
2823 * Get the rendered text for previewing.
2826 function getPreviewText() {
2827 global $wgOut, $wgUser, $wgParser, $wgRawHtml, $wgLang;
2829 wfProfileIn( __METHOD__
);
2831 if ( $wgRawHtml && !$this->mTokenOk
) {
2832 // Could be an offsite preview attempt. This is very unsafe if
2833 // HTML is enabled, as it could be an attack.
2835 if ( $this->textbox1
!== '' ) {
2836 // Do not put big scary notice, if previewing the empty
2837 // string, which happens when you initially edit
2838 // a category page, due to automatic preview-on-open.
2839 $parsedNote = $wgOut->parse( "<div class='previewnote'>" .
2840 wfMessage( 'session_fail_preview_html' )->text() . "</div>", true, /* interface */true );
2842 wfProfileOut( __METHOD__
);
2849 $content = $this->toEditContent( $this->textbox1
);
2851 if ( $this->mTriedSave
&& !$this->mTokenOk
) {
2852 if ( $this->mTokenOkExceptSuffix
) {
2853 $note = wfMessage( 'token_suffix_mismatch' )->plain() ;
2856 $note = wfMessage( 'session_fail_preview' )->plain() ;
2858 } elseif ( $this->incompleteForm
) {
2859 $note = wfMessage( 'edit_form_incomplete' )->plain() ;
2861 $note = wfMessage( 'previewnote' )->plain() .
2862 ' [[#' . self
::EDITFORM_ID
. '|' . $wgLang->getArrow() . ' ' . wfMessage( 'continue-editing' )->text() . ']]';
2865 $parserOptions = $this->mArticle
->makeParserOptions( $this->mArticle
->getContext() );
2866 $parserOptions->setEditSection( false );
2867 $parserOptions->setTidy( true );
2868 $parserOptions->setIsPreview( true );
2869 $parserOptions->setIsSectionPreview( !is_null($this->section
) && $this->section
!== '' );
2871 # don't parse non-wikitext pages, show message about preview
2872 if ( $this->mTitle
->isCssJsSubpage() ||
$this->mTitle
->isCssOrJsPage() ) {
2873 if( $this->mTitle
->isCssJsSubpage() ) {
2875 } elseif( $this->mTitle
->isCssOrJsPage() ) {
2881 if ( $content->getModel() == CONTENT_MODEL_CSS
) {
2883 } elseif ( $content->getModel() == CONTENT_MODEL_JAVASCRIPT
) {
2889 # Used messages to make sure grep find them:
2890 # Messages: usercsspreview, userjspreview, sitecsspreview, sitejspreview
2891 if( $level && $format ) {
2892 $note = "<div id='mw-{$level}{$format}preview'>" . wfMessage( "{$level}{$format}preview" )->text() . "</div>";
2894 $note = wfMessage( 'previewnote' )->text() ;
2897 $note = wfMessage( 'previewnote' )->text() ;
2900 $rt = $content->getRedirectChain();
2902 $previewHTML = $this->mArticle
->viewRedirect( $rt, false );
2905 # If we're adding a comment, we need to show the
2906 # summary as the headline
2907 if ( $this->section
== "new" && $this->summary
!= "" ) {
2908 $content = $content->addSectionHeader( $this->summary
);
2911 $hook_args = array( $this, &$content );
2912 ContentHandler
::runLegacyHooks( 'EditPageGetPreviewText', $hook_args );
2913 wfRunHooks( 'EditPageGetPreviewContent', $hook_args );
2915 $parserOptions->enableLimitReport();
2917 # For CSS/JS pages, we should have called the ShowRawCssJs hook here.
2918 # But it's now deprecated, so never mind
2920 $content = $content->preSaveTransform( $this->mTitle
, $wgUser, $parserOptions );
2921 $parserOutput = $content->getParserOutput( $this->getArticle()->getTitle(), null, $parserOptions );
2923 $previewHTML = $parserOutput->getText();
2924 $this->mParserOutput
= $parserOutput;
2925 $wgOut->addParserOutputNoText( $parserOutput );
2927 if ( count( $parserOutput->getWarnings() ) ) {
2928 $note .= "\n\n" . implode( "\n\n", $parserOutput->getWarnings() );
2931 } catch (MWContentSerializationException
$ex) {
2932 $m = wfMessage('content-failed-to-parse', $this->content_model
, $this->content_format
, $ex->getMessage() );
2933 $note .= "\n\n" . $m->parse();
2937 if ( $this->isConflict
) {
2938 $conflict = '<h2 id="mw-previewconflict">' . wfMessage( 'previewconflict' )->escaped() . "</h2>\n";
2940 $conflict = '<hr />';
2943 $previewhead = "<div class='previewnote'>\n" .
2944 '<h2 id="mw-previewheader">' . wfMessage( 'preview' )->escaped() . "</h2>" .
2945 $wgOut->parse( $note, true, /* interface */true ) . $conflict . "</div>\n";
2947 $pageLang = $this->mTitle
->getPageLanguage();
2948 $attribs = array( 'lang' => $pageLang->getCode(), 'dir' => $pageLang->getDir(),
2949 'class' => 'mw-content-' . $pageLang->getDir() );
2950 $previewHTML = Html
::rawElement( 'div', $attribs, $previewHTML );
2952 wfProfileOut( __METHOD__
);
2953 return $previewhead . $previewHTML . $this->previewTextAfterContent
;
2959 function getTemplates() {
2960 if ( $this->preview ||
$this->section
!= '' ) {
2961 $templates = array();
2962 if ( !isset( $this->mParserOutput
) ) {
2965 foreach ( $this->mParserOutput
->getTemplates() as $ns => $template ) {
2966 foreach ( array_keys( $template ) as $dbk ) {
2967 $templates[] = Title
::makeTitle( $ns, $dbk );
2972 return $this->mTitle
->getTemplateLinksFrom();
2977 * Shows a bulletin board style toolbar for common editing functions.
2978 * It can be disabled in the user preferences.
2979 * The necessary JavaScript code can be found in skins/common/edit.js.
2983 static function getEditToolbar() {
2984 global $wgStylePath, $wgContLang, $wgLang, $wgOut;
2985 global $wgUseTeX, $wgEnableUploads, $wgForeignFileRepos;
2987 $imagesAvailable = $wgEnableUploads ||
count( $wgForeignFileRepos );
2990 * $toolarray is an array of arrays each of which includes the
2991 * filename of the button image (without path), the opening
2992 * tag, the closing tag, optionally a sample text that is
2993 * inserted between the two when no selection is highlighted
2994 * and. The tip text is shown when the user moves the mouse
2997 * Also here: accesskeys (key), which are not used yet until
2998 * someone can figure out a way to make them work in
2999 * IE. However, we should make sure these keys are not defined
3004 'image' => $wgLang->getImageFile( 'button-bold' ),
3005 'id' => 'mw-editbutton-bold',
3007 'close' => '\'\'\'',
3008 'sample' => wfMessage( 'bold_sample' )->text(),
3009 'tip' => wfMessage( 'bold_tip' )->text(),
3013 'image' => $wgLang->getImageFile( 'button-italic' ),
3014 'id' => 'mw-editbutton-italic',
3017 'sample' => wfMessage( 'italic_sample' )->text(),
3018 'tip' => wfMessage( 'italic_tip' )->text(),
3022 'image' => $wgLang->getImageFile( 'button-link' ),
3023 'id' => 'mw-editbutton-link',
3026 'sample' => wfMessage( 'link_sample' )->text(),
3027 'tip' => wfMessage( 'link_tip' )->text(),
3031 'image' => $wgLang->getImageFile( 'button-extlink' ),
3032 'id' => 'mw-editbutton-extlink',
3035 'sample' => wfMessage( 'extlink_sample' )->text(),
3036 'tip' => wfMessage( 'extlink_tip' )->text(),
3040 'image' => $wgLang->getImageFile( 'button-headline' ),
3041 'id' => 'mw-editbutton-headline',
3044 'sample' => wfMessage( 'headline_sample' )->text(),
3045 'tip' => wfMessage( 'headline_tip' )->text(),
3048 $imagesAvailable ?
array(
3049 'image' => $wgLang->getImageFile( 'button-image' ),
3050 'id' => 'mw-editbutton-image',
3051 'open' => '[[' . $wgContLang->getNsText( NS_FILE
) . ':',
3053 'sample' => wfMessage( 'image_sample' )->text(),
3054 'tip' => wfMessage( 'image_tip' )->text(),
3057 $imagesAvailable ?
array(
3058 'image' => $wgLang->getImageFile( 'button-media' ),
3059 'id' => 'mw-editbutton-media',
3060 'open' => '[[' . $wgContLang->getNsText( NS_MEDIA
) . ':',
3062 'sample' => wfMessage( 'media_sample' )->text(),
3063 'tip' => wfMessage( 'media_tip' )->text(),
3067 'image' => $wgLang->getImageFile( 'button-math' ),
3068 'id' => 'mw-editbutton-math',
3070 'close' => "</math>",
3071 'sample' => wfMessage( 'math_sample' )->text(),
3072 'tip' => wfMessage( 'math_tip' )->text(),
3076 'image' => $wgLang->getImageFile( 'button-nowiki' ),
3077 'id' => 'mw-editbutton-nowiki',
3078 'open' => "<nowiki>",
3079 'close' => "</nowiki>",
3080 'sample' => wfMessage( 'nowiki_sample' )->text(),
3081 'tip' => wfMessage( 'nowiki_tip' )->text(),
3085 'image' => $wgLang->getImageFile( 'button-sig' ),
3086 'id' => 'mw-editbutton-signature',
3090 'tip' => wfMessage( 'sig_tip' )->text(),
3094 'image' => $wgLang->getImageFile( 'button-hr' ),
3095 'id' => 'mw-editbutton-hr',
3096 'open' => "\n----\n",
3099 'tip' => wfMessage( 'hr_tip' )->text(),
3104 $script = 'mw.loader.using("mediawiki.action.edit", function() {';
3105 foreach ( $toolarray as $tool ) {
3111 $image = $wgStylePath . '/common/images/' . $tool['image'],
3112 // Note that we use the tip both for the ALT tag and the TITLE tag of the image.
3113 // Older browsers show a "speedtip" type message only for ALT.
3114 // Ideally these should be different, realistically they
3115 // probably don't need to be.
3116 $tip = $tool['tip'],
3117 $open = $tool['open'],
3118 $close = $tool['close'],
3119 $sample = $tool['sample'],
3120 $cssId = $tool['id'],
3123 $script .= Xml
::encodeJsCall( 'mw.toolbar.addButton', $params );
3126 // This used to be called on DOMReady from mediawiki.action.edit, which
3127 // ended up causing race conditions with the setup code above.
3129 "// Create button bar\n" .
3130 "$(function() { mw.toolbar.init(); } );\n";
3133 $wgOut->addScript( Html
::inlineScript( ResourceLoader
::makeLoaderConditionalScript( $script ) ) );
3135 $toolbar = '<div id="toolbar"></div>';
3137 wfRunHooks( 'EditPageBeforeEditToolbar', array( &$toolbar ) );
3143 * Returns an array of html code of the following checkboxes:
3146 * @param $tabindex int Current tabindex
3147 * @param $checked Array of checkbox => bool, where bool indicates the checked
3148 * status of the checkbox
3152 public function getCheckboxes( &$tabindex, $checked ) {
3155 $checkboxes = array();
3157 // don't show the minor edit checkbox if it's a new page or section
3158 if ( !$this->isNew
) {
3159 $checkboxes['minor'] = '';
3160 $minorLabel = wfMessage( 'minoredit' )->parse();
3161 if ( $wgUser->isAllowed( 'minoredit' ) ) {
3163 'tabindex' => ++
$tabindex,
3164 'accesskey' => wfMessage( 'accesskey-minoredit' )->text(),
3165 'id' => 'wpMinoredit',
3167 $checkboxes['minor'] =
3168 Xml
::check( 'wpMinoredit', $checked['minor'], $attribs ) .
3169 " <label for='wpMinoredit' id='mw-editpage-minoredit'" .
3170 Xml
::expandAttributes( array( 'title' => Linker
::titleAttrib( 'minoredit', 'withaccess' ) ) ) .
3171 ">{$minorLabel}</label>";
3175 $watchLabel = wfMessage( 'watchthis' )->parse();
3176 $checkboxes['watch'] = '';
3177 if ( $wgUser->isLoggedIn() ) {
3179 'tabindex' => ++
$tabindex,
3180 'accesskey' => wfMessage( 'accesskey-watch' )->text(),
3181 'id' => 'wpWatchthis',
3183 $checkboxes['watch'] =
3184 Xml
::check( 'wpWatchthis', $checked['watch'], $attribs ) .
3185 " <label for='wpWatchthis' id='mw-editpage-watch'" .
3186 Xml
::expandAttributes( array( 'title' => Linker
::titleAttrib( 'watch', 'withaccess' ) ) ) .
3187 ">{$watchLabel}</label>";
3189 wfRunHooks( 'EditPageBeforeEditChecks', array( &$this, &$checkboxes, &$tabindex ) );
3194 * Returns an array of html code of the following buttons:
3195 * save, diff, preview and live
3197 * @param $tabindex int Current tabindex
3201 public function getEditButtons( &$tabindex ) {
3208 'tabindex' => ++
$tabindex,
3209 'value' => wfMessage( 'savearticle' )->text(),
3210 'accesskey' => wfMessage( 'accesskey-save' )->text(),
3211 'title' => wfMessage( 'tooltip-save' )->text() . ' [' . wfMessage( 'accesskey-save' )->text() . ']',
3213 $buttons['save'] = Xml
::element( 'input', $temp, '' );
3215 ++
$tabindex; // use the same for preview and live preview
3217 'id' => 'wpPreview',
3218 'name' => 'wpPreview',
3220 'tabindex' => $tabindex,
3221 'value' => wfMessage( 'showpreview' )->text(),
3222 'accesskey' => wfMessage( 'accesskey-preview' )->text(),
3223 'title' => wfMessage( 'tooltip-preview' )->text() . ' [' . wfMessage( 'accesskey-preview' )->text() . ']',
3225 $buttons['preview'] = Xml
::element( 'input', $temp, '' );
3226 $buttons['live'] = '';
3232 'tabindex' => ++
$tabindex,
3233 'value' => wfMessage( 'showdiff' )->text(),
3234 'accesskey' => wfMessage( 'accesskey-diff' )->text(),
3235 'title' => wfMessage( 'tooltip-diff' )->text() . ' [' . wfMessage( 'accesskey-diff' )->text() . ']',
3237 $buttons['diff'] = Xml
::element( 'input', $temp, '' );
3239 wfRunHooks( 'EditPageBeforeEditButtons', array( &$this, &$buttons, &$tabindex ) );
3244 * Output preview text only. This can be sucked into the edit page
3245 * via JavaScript, and saves the server time rendering the skin as
3246 * well as theoretically being more robust on the client (doesn't
3247 * disturb the edit box's undo history, won't eat your text on
3250 * @todo This doesn't include category or interlanguage links.
3251 * Would need to enhance it a bit, "<s>maybe wrap them in XML
3252 * or something...</s>" that might also require more skin
3253 * initialization, so check whether that's a problem.
3255 function livePreview() {
3258 header( 'Content-type: text/xml; charset=utf-8' );
3259 header( 'Cache-control: no-cache' );
3261 $previewText = $this->getPreviewText();
3262 #$categories = $skin->getCategoryLinks();
3265 '<?xml version="1.0" encoding="UTF-8" ?>' . "\n" .
3266 Xml
::tags( 'livepreview', null,
3267 Xml
::element( 'preview', null, $previewText )
3268 #. Xml::element( 'category', null, $categories )
3274 * Call the stock "user is blocked" page
3276 * @deprecated in 1.19; throw an exception directly instead
3278 function blockedPage() {
3279 wfDeprecated( __METHOD__
, '1.19' );
3282 throw new UserBlockedError( $wgUser->getBlock() );
3286 * Produce the stock "please login to edit pages" page
3288 * @deprecated in 1.19; throw an exception directly instead
3290 function userNotLoggedInPage() {
3291 wfDeprecated( __METHOD__
, '1.19' );
3292 throw new PermissionsError( 'edit' );
3296 * Show an error page saying to the user that he has insufficient permissions
3297 * to create a new page
3299 * @deprecated in 1.19; throw an exception directly instead
3301 function noCreatePermission() {
3302 wfDeprecated( __METHOD__
, '1.19' );
3303 $permission = $this->mTitle
->isTalkPage() ?
'createtalk' : 'createpage';
3304 throw new PermissionsError( $permission );
3308 * Creates a basic error page which informs the user that
3309 * they have attempted to edit a nonexistent section.
3311 function noSuchSectionPage() {
3314 $wgOut->prepareErrorPage( wfMessage( 'nosuchsectiontitle' ) );
3316 $res = wfMessage( 'nosuchsectiontext', $this->section
)->parseAsBlock();
3317 wfRunHooks( 'EditPageNoSuchSection', array( &$this, &$res ) );
3318 $wgOut->addHTML( $res );
3320 $wgOut->returnToMain( false, $this->mTitle
);
3324 * Produce the stock "your edit contains spam" page
3326 * @param $match string Text which triggered one or more filters
3327 * @deprecated since 1.17 Use method spamPageWithContent() instead
3329 static function spamPage( $match = false ) {
3330 wfDeprecated( __METHOD__
, '1.17' );
3332 global $wgOut, $wgTitle;
3334 $wgOut->prepareErrorPage( wfMessage( 'spamprotectiontitle' ) );
3336 $wgOut->addHTML( '<div id="spamprotected">' );
3337 $wgOut->addWikiMsg( 'spamprotectiontext' );
3339 $wgOut->addWikiMsg( 'spamprotectionmatch', wfEscapeWikiText( $match ) );
3341 $wgOut->addHTML( '</div>' );
3343 $wgOut->returnToMain( false, $wgTitle );
3347 * Show "your edit contains spam" page with your diff and text
3349 * @param $match string|Array|bool Text (or array of texts) which triggered one or more filters
3351 public function spamPageWithContent( $match = false ) {
3352 global $wgOut, $wgLang;
3353 $this->textbox2
= $this->textbox1
;
3355 if( is_array( $match ) ){
3356 $match = $wgLang->listToText( $match );
3358 $wgOut->prepareErrorPage( wfMessage( 'spamprotectiontitle' ) );
3360 $wgOut->addHTML( '<div id="spamprotected">' );
3361 $wgOut->addWikiMsg( 'spamprotectiontext' );
3363 $wgOut->addWikiMsg( 'spamprotectionmatch', wfEscapeWikiText( $match ) );
3365 $wgOut->addHTML( '</div>' );
3367 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
3370 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
3371 $this->showTextbox2();
3373 $wgOut->addReturnTo( $this->getContextTitle(), array( 'action' => 'edit' ) );
3377 * Format an anchor fragment as it would appear for a given section name
3378 * @param $text String
3382 function sectionAnchor( $text ) {
3384 return $wgParser->guessSectionNameFromWikiText( $text );
3388 * Check if the browser is on a blacklist of user-agents known to
3389 * mangle UTF-8 data on form submission. Returns true if Unicode
3390 * should make it through, false if it's known to be a problem.
3394 function checkUnicodeCompliantBrowser() {
3395 global $wgBrowserBlackList, $wgRequest;
3397 $currentbrowser = $wgRequest->getHeader( 'User-Agent' );
3398 if ( $currentbrowser === false ) {
3399 // No User-Agent header sent? Trust it by default...
3403 foreach ( $wgBrowserBlackList as $browser ) {
3404 if ( preg_match( $browser, $currentbrowser ) ) {
3412 * Filter an input field through a Unicode de-armoring process if it
3413 * came from an old browser with known broken Unicode editing issues.
3415 * @param $request WebRequest
3416 * @param $field String
3420 function safeUnicodeInput( $request, $field ) {
3421 $text = rtrim( $request->getText( $field ) );
3422 return $request->getBool( 'safemode' )
3423 ?
$this->unmakesafe( $text )
3428 * @param $request WebRequest
3429 * @param $text string
3432 function safeUnicodeText( $request, $text ) {
3433 $text = rtrim( $text );
3434 return $request->getBool( 'safemode' )
3435 ?
$this->unmakesafe( $text )
3440 * Filter an output field through a Unicode armoring process if it is
3441 * going to an old browser with known broken Unicode editing issues.
3443 * @param $text String
3447 function safeUnicodeOutput( $text ) {
3449 $codedText = $wgContLang->recodeForEdit( $text );
3450 return $this->checkUnicodeCompliantBrowser()
3452 : $this->makesafe( $codedText );
3456 * A number of web browsers are known to corrupt non-ASCII characters
3457 * in a UTF-8 text editing environment. To protect against this,
3458 * detected browsers will be served an armored version of the text,
3459 * with non-ASCII chars converted to numeric HTML character references.
3461 * Preexisting such character references will have a 0 added to them
3462 * to ensure that round-trips do not alter the original data.
3464 * @param $invalue String
3468 function makesafe( $invalue ) {
3469 // Armor existing references for reversability.
3470 $invalue = strtr( $invalue, array( "&#x" => "�" ) );
3475 for ( $i = 0; $i < strlen( $invalue ); $i++
) {
3476 $bytevalue = ord( $invalue[$i] );
3477 if ( $bytevalue <= 0x7F ) { // 0xxx xxxx
3478 $result .= chr( $bytevalue );
3480 } elseif ( $bytevalue <= 0xBF ) { // 10xx xxxx
3481 $working = $working << 6;
3482 $working +
= ( $bytevalue & 0x3F );
3484 if ( $bytesleft <= 0 ) {
3485 $result .= "&#x" . strtoupper( dechex( $working ) ) . ";";
3487 } elseif ( $bytevalue <= 0xDF ) { // 110x xxxx
3488 $working = $bytevalue & 0x1F;
3490 } elseif ( $bytevalue <= 0xEF ) { // 1110 xxxx
3491 $working = $bytevalue & 0x0F;
3493 } else { // 1111 0xxx
3494 $working = $bytevalue & 0x07;
3502 * Reverse the previously applied transliteration of non-ASCII characters
3503 * back to UTF-8. Used to protect data from corruption by broken web browsers
3504 * as listed in $wgBrowserBlackList.
3506 * @param $invalue String
3510 function unmakesafe( $invalue ) {
3512 for ( $i = 0; $i < strlen( $invalue ); $i++
) {
3513 if ( ( substr( $invalue, $i, 3 ) == "&#x" ) && ( $invalue[$i +
3] != '0' ) ) {
3517 $hexstring .= $invalue[$i];
3519 } while ( ctype_xdigit( $invalue[$i] ) && ( $i < strlen( $invalue ) ) );
3521 // Do some sanity checks. These aren't needed for reversability,
3522 // but should help keep the breakage down if the editor
3523 // breaks one of the entities whilst editing.
3524 if ( ( substr( $invalue, $i, 1 ) == ";" ) and ( strlen( $hexstring ) <= 6 ) ) {
3525 $codepoint = hexdec( $hexstring );
3526 $result .= codepointToUtf8( $codepoint );
3528 $result .= "&#x" . $hexstring . substr( $invalue, $i, 1 );
3531 $result .= substr( $invalue, $i, 1 );
3534 // reverse the transform that we made for reversability reasons.
3535 return strtr( $result, array( "�" => "&#x" ) );