Fixed spacing in actions/cache/filebackend/filerepo/job folder
[mediawiki.git] / includes / EditPage.php
blobae35f3e7e1b7a7e57c48bcf399d4a215648050d3
1 <?php
2 /**
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
20 * @file
23 /**
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
27 * interfaces.
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.
38 class EditPage {
40 /**
41 * Status: Article successfully updated
43 const AS_SUCCESS_UPDATE = 200;
45 /**
46 * Status: Article successfully created
48 const AS_SUCCESS_NEW_ARTICLE = 201;
50 /**
51 * Status: Article update aborted by a hook function
53 const AS_HOOK_ERROR = 210;
55 /**
56 * Status: A hook function returned an error
58 const AS_HOOK_ERROR_EXPECTED = 212;
60 /**
61 * Status: User is blocked from editing this page
63 const AS_BLOCKED_PAGE_FOR_USER = 215;
65 /**
66 * Status: Content too big (> $wgMaxArticleSize)
68 const AS_CONTENT_TOO_BIG = 216;
70 /**
71 * Status: User cannot edit? (not used)
73 const AS_USER_CANNOT_EDIT = 217;
75 /**
76 * Status: this anonymous user is not allowed to edit this page
78 const AS_READ_ONLY_PAGE_ANON = 218;
80 /**
81 * Status: this logged in user is not allowed to edit this page
83 const AS_READ_ONLY_PAGE_LOGGED = 219;
85 /**
86 * Status: wiki is in readonly mode (wfReadOnly() == true)
88 const AS_READ_ONLY_PAGE = 220;
90 /**
91 * Status: rate limiter for action 'edit' was tripped
93 const AS_RATE_LIMITED = 221;
95 /**
96 * Status: article was deleted while editing and param wpRecreate == false or form
97 * was not posted
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 * editing 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;
134 * not used
136 const AS_OK = 230;
139 * Status: WikiPage::doEdit() was unsuccessful
141 const AS_END = 231;
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';
169 * Prefix of key for cookie used to pass post-edit state.
170 * The revision id edited is added after this
172 const POST_EDIT_COOKIE_KEY_PREFIX = 'PostEditRevision';
175 * Duration of PostEdit cookie, in seconds.
176 * The cookie will be removed instantly if the JavaScript runs.
178 * Otherwise, though, we don't want the cookies to accumulate.
179 * RFC 2109 ( https://www.ietf.org/rfc/rfc2109.txt ) specifies a possible limit of only 20 cookies per domain.
180 * This still applies at least to some versions of IE without full updates:
181 * https://blogs.msdn.com/b/ieinternals/archive/2009/08/20/wininet-ie-cookie-internals-faq.aspx
183 * A value of 20 minutes should be enough to take into account slow loads and minor
184 * clock skew while still avoiding cookie accumulation when JavaScript is turned off.
186 const POST_EDIT_COOKIE_DURATION = 1200;
189 * @var Article
191 var $mArticle;
194 * @var Title
196 var $mTitle;
197 private $mContextTitle = null;
198 var $action = 'submit';
199 var $isConflict = false;
200 var $isCssJsSubpage = false;
201 var $isCssSubpage = false;
202 var $isJsSubpage = false;
203 var $isWrongCaseCssJsPage = false;
204 var $isNew = false; // new page or new section
205 var $deletedSinceEdit;
206 var $formtype;
207 var $firsttime;
208 var $lastDelete;
209 var $mTokenOk = false;
210 var $mTokenOkExceptSuffix = false;
211 var $mTriedSave = false;
212 var $incompleteForm = false;
213 var $tooBig = false;
214 var $kblength = false;
215 var $missingComment = false;
216 var $missingSummary = false;
217 var $allowBlankSummary = false;
218 var $autoSumm = '';
219 var $hookError = '';
220 #var $mPreviewTemplates;
223 * @var ParserOutput
225 var $mParserOutput;
228 * Has a summary been preset using GET parameter &summary= ?
229 * @var Bool
231 var $hasPresetSummary = false;
233 var $mBaseRevision = false;
234 var $mShowSummaryField = true;
236 # Form values
237 var $save = false, $preview = false, $diff = false;
238 var $minoredit = false, $watchthis = false, $recreate = false;
239 var $textbox1 = '', $textbox2 = '', $summary = '', $nosummary = false;
240 var $edittime = '', $section = '', $sectiontitle = '', $starttime = '';
241 var $oldid = 0, $editintro = '', $scrolltop = null, $bot = true;
242 var $contentModel = null, $contentFormat = null;
244 # Placeholders for text injection by hooks (must be HTML)
245 # extensions should take care to _append_ to the present value
246 public $editFormPageTop = ''; // Before even the preview
247 public $editFormTextTop = '';
248 public $editFormTextBeforeContent = '';
249 public $editFormTextAfterWarn = '';
250 public $editFormTextAfterTools = '';
251 public $editFormTextBottom = '';
252 public $editFormTextAfterContent = '';
253 public $previewTextAfterContent = '';
254 public $mPreloadContent = null;
256 /* $didSave should be set to true whenever an article was successfully altered. */
257 public $didSave = false;
258 public $undidRev = 0;
260 public $suppressIntro = false;
263 * Set to true to allow editing of non-text content types.
265 * @var bool
267 public $allowNonTextContent = false;
270 * @param $article Article
272 public function __construct( Article $article ) {
273 $this->mArticle = $article;
274 $this->mTitle = $article->getTitle();
276 $this->contentModel = $this->mTitle->getContentModel();
278 $handler = ContentHandler::getForModelID( $this->contentModel );
279 $this->contentFormat = $handler->getDefaultFormat();
283 * @return Article
285 public function getArticle() {
286 return $this->mArticle;
290 * @since 1.19
291 * @return Title
293 public function getTitle() {
294 return $this->mTitle;
298 * Set the context Title object
300 * @param $title Title object or null
302 public function setContextTitle( $title ) {
303 $this->mContextTitle = $title;
307 * Get the context title object.
308 * If not set, $wgTitle will be returned. This behavior might change in
309 * the future to return $this->mTitle instead.
311 * @return Title object
313 public function getContextTitle() {
314 if ( is_null( $this->mContextTitle ) ) {
315 global $wgTitle;
316 return $wgTitle;
317 } else {
318 return $this->mContextTitle;
322 function submit() {
323 $this->edit();
327 * This is the function that gets called for "action=edit". It
328 * sets up various member variables, then passes execution to
329 * another function, usually showEditForm()
331 * The edit form is self-submitting, so that when things like
332 * preview and edit conflicts occur, we get the same form back
333 * with the extra stuff added. Only when the final submission
334 * is made and all is well do we actually save and redirect to
335 * the newly-edited page.
337 function edit() {
338 global $wgOut, $wgRequest, $wgUser;
339 // Allow extensions to modify/prevent this form or submission
340 if ( !wfRunHooks( 'AlternateEdit', array( $this ) ) ) {
341 return;
344 wfProfileIn( __METHOD__ );
345 wfDebug( __METHOD__ . ": enter\n" );
347 // If they used redlink=1 and the page exists, redirect to the main article
348 if ( $wgRequest->getBool( 'redlink' ) && $this->mTitle->exists() ) {
349 $wgOut->redirect( $this->mTitle->getFullURL() );
350 wfProfileOut( __METHOD__ );
351 return;
354 $this->importFormData( $wgRequest );
355 $this->firsttime = false;
357 if ( $this->live ) {
358 $this->livePreview();
359 wfProfileOut( __METHOD__ );
360 return;
363 if ( wfReadOnly() && $this->save ) {
364 // Force preview
365 $this->save = false;
366 $this->preview = true;
369 if ( $this->save ) {
370 $this->formtype = 'save';
371 } elseif ( $this->preview ) {
372 $this->formtype = 'preview';
373 } elseif ( $this->diff ) {
374 $this->formtype = 'diff';
375 } else { # First time through
376 $this->firsttime = true;
377 if ( $this->previewOnOpen() ) {
378 $this->formtype = 'preview';
379 } else {
380 $this->formtype = 'initial';
384 $permErrors = $this->getEditPermissionErrors();
385 if ( $permErrors ) {
386 wfDebug( __METHOD__ . ": User can't edit\n" );
387 // Auto-block user's IP if the account was "hard" blocked
388 $wgUser->spreadAnyEditBlock();
390 $this->displayPermissionsError( $permErrors );
392 wfProfileOut( __METHOD__ );
393 return;
396 wfProfileIn( __METHOD__ . "-business-end" );
398 $this->isConflict = false;
399 // css / js subpages of user pages get a special treatment
400 $this->isCssJsSubpage = $this->mTitle->isCssJsSubpage();
401 $this->isCssSubpage = $this->mTitle->isCssSubpage();
402 $this->isJsSubpage = $this->mTitle->isJsSubpage();
403 $this->isWrongCaseCssJsPage = $this->isWrongCaseCssJsPage();
405 # Show applicable editing introductions
406 if ( $this->formtype == 'initial' || $this->firsttime ) {
407 $this->showIntro();
410 # Attempt submission here. This will check for edit conflicts,
411 # and redundantly check for locked database, blocked IPs, etc.
412 # that edit() already checked just in case someone tries to sneak
413 # in the back door with a hand-edited submission URL.
415 if ( 'save' == $this->formtype ) {
416 if ( !$this->attemptSave() ) {
417 wfProfileOut( __METHOD__ . "-business-end" );
418 wfProfileOut( __METHOD__ );
419 return;
423 # First time through: get contents, set time for conflict
424 # checking, etc.
425 if ( 'initial' == $this->formtype || $this->firsttime ) {
426 if ( $this->initialiseForm() === false ) {
427 $this->noSuchSectionPage();
428 wfProfileOut( __METHOD__ . "-business-end" );
429 wfProfileOut( __METHOD__ );
430 return;
433 if ( !$this->mTitle->getArticleID() ) {
434 wfRunHooks( 'EditFormPreloadText', array( &$this->textbox1, &$this->mTitle ) );
435 } else {
436 wfRunHooks( 'EditFormInitialText', array( $this ) );
441 $this->showEditForm();
442 wfProfileOut( __METHOD__ . "-business-end" );
443 wfProfileOut( __METHOD__ );
447 * @return array
449 protected function getEditPermissionErrors() {
450 global $wgUser;
451 $permErrors = $this->mTitle->getUserPermissionsErrors( 'edit', $wgUser );
452 # Can this title be created?
453 if ( !$this->mTitle->exists() ) {
454 $permErrors = array_merge( $permErrors,
455 wfArrayDiff2( $this->mTitle->getUserPermissionsErrors( 'create', $wgUser ), $permErrors ) );
457 # Ignore some permissions errors when a user is just previewing/viewing diffs
458 $remove = array();
459 foreach ( $permErrors as $error ) {
460 if ( ( $this->preview || $this->diff ) &&
461 ( $error[0] == 'blockedtext' || $error[0] == 'autoblockedtext' ) )
463 $remove[] = $error;
466 $permErrors = wfArrayDiff2( $permErrors, $remove );
467 return $permErrors;
471 * Display a permissions error page, like OutputPage::showPermissionsErrorPage(),
472 * but with the following differences:
473 * - If redlink=1, the user will be redirected to the page
474 * - If there is content to display or the error occurs while either saving,
475 * previewing or showing the difference, it will be a
476 * "View source for ..." page displaying the source code after the error message.
478 * @since 1.19
479 * @param array $permErrors of permissions errors, as returned by
480 * Title::getUserPermissionsErrors().
481 * @throws PermissionsError
483 protected function displayPermissionsError( array $permErrors ) {
484 global $wgRequest, $wgOut;
486 if ( $wgRequest->getBool( 'redlink' ) ) {
487 // The edit page was reached via a red link.
488 // Redirect to the article page and let them click the edit tab if
489 // they really want a permission error.
490 $wgOut->redirect( $this->mTitle->getFullURL() );
491 return;
494 $content = $this->getContentObject();
496 # Use the normal message if there's nothing to display
497 if ( $this->firsttime && ( !$content || $content->isEmpty() ) ) {
498 $action = $this->mTitle->exists() ? 'edit' :
499 ( $this->mTitle->isTalkPage() ? 'createtalk' : 'createpage' );
500 throw new PermissionsError( $action, $permErrors );
503 $wgOut->setRobotPolicy( 'noindex,nofollow' );
504 $wgOut->setPageTitle( wfMessage( 'viewsource-title', $this->getContextTitle()->getPrefixedText() ) );
505 $wgOut->addBacklinkSubtitle( $this->getContextTitle() );
506 $wgOut->addWikiText( $wgOut->formatPermissionsErrorMessage( $permErrors, 'edit' ) );
507 $wgOut->addHTML( "<hr />\n" );
509 # If the user made changes, preserve them when showing the markup
510 # (This happens when a user is blocked during edit, for instance)
511 if ( !$this->firsttime ) {
512 $text = $this->textbox1;
513 $wgOut->addWikiMsg( 'viewyourtext' );
514 } else {
515 $text = $this->toEditText( $content );
516 $wgOut->addWikiMsg( 'viewsourcetext' );
519 $this->showTextbox( $text, 'wpTextbox1', array( 'readonly' ) );
521 $wgOut->addHTML( Html::rawElement( 'div', array( 'class' => 'templatesUsed' ),
522 Linker::formatTemplates( $this->getTemplates() ) ) );
524 if ( $this->mTitle->exists() ) {
525 $wgOut->returnToMain( null, $this->mTitle );
530 * Show a read-only error
531 * Parameters are the same as OutputPage:readOnlyPage()
532 * Redirect to the article page if redlink=1
533 * @deprecated in 1.19; use displayPermissionsError() instead
535 function readOnlyPage( $source = null, $protected = false, $reasons = array(), $action = null ) {
536 wfDeprecated( __METHOD__, '1.19' );
538 global $wgRequest, $wgOut;
539 if ( $wgRequest->getBool( 'redlink' ) ) {
540 // The edit page was reached via a red link.
541 // Redirect to the article page and let them click the edit tab if
542 // they really want a permission error.
543 $wgOut->redirect( $this->mTitle->getFullURL() );
544 } else {
545 $wgOut->readOnlyPage( $source, $protected, $reasons, $action );
550 * Should we show a preview when the edit form is first shown?
552 * @return bool
554 protected function previewOnOpen() {
555 global $wgRequest, $wgUser, $wgPreviewOnOpenNamespaces;
556 if ( $wgRequest->getVal( 'preview' ) == 'yes' ) {
557 // Explicit override from request
558 return true;
559 } elseif ( $wgRequest->getVal( 'preview' ) == 'no' ) {
560 // Explicit override from request
561 return false;
562 } elseif ( $this->section == 'new' ) {
563 // Nothing *to* preview for new sections
564 return false;
565 } elseif ( ( $wgRequest->getVal( 'preload' ) !== null || $this->mTitle->exists() ) && $wgUser->getOption( 'previewonfirst' ) ) {
566 // Standard preference behavior
567 return true;
568 } elseif ( !$this->mTitle->exists() &&
569 isset( $wgPreviewOnOpenNamespaces[$this->mTitle->getNamespace()] ) &&
570 $wgPreviewOnOpenNamespaces[$this->mTitle->getNamespace()] )
572 // Categories are special
573 return true;
574 } else {
575 return false;
580 * Checks whether the user entered a skin name in uppercase,
581 * e.g. "User:Example/Monobook.css" instead of "monobook.css"
583 * @return bool
585 protected function isWrongCaseCssJsPage() {
586 if ( $this->mTitle->isCssJsSubpage() ) {
587 $name = $this->mTitle->getSkinFromCssJsSubpage();
588 $skins = array_merge(
589 array_keys( Skin::getSkinNames() ),
590 array( 'common' )
592 return !in_array( $name, $skins )
593 && in_array( strtolower( $name ), $skins );
594 } else {
595 return false;
600 * Returns whether section editing is supported for the current page.
601 * Subclasses may override this to replace the default behavior, which is
602 * to check ContentHandler::supportsSections.
604 * @return bool true if this edit page supports sections, false otherwise.
606 protected function isSectionEditSupported() {
607 $contentHandler = ContentHandler::getForTitle( $this->mTitle );
608 return $contentHandler->supportsSections();
612 * This function collects the form data and uses it to populate various member variables.
613 * @param $request WebRequest
615 function importFormData( &$request ) {
616 global $wgContLang, $wgUser;
618 wfProfileIn( __METHOD__ );
620 # Section edit can come from either the form or a link
621 $this->section = $request->getVal( 'wpSection', $request->getVal( 'section' ) );
623 if ( $this->section !== null && $this->section !== '' && !$this->isSectionEditSupported() ) {
624 wfProfileOut( __METHOD__ );
625 throw new ErrorPageError( 'sectioneditnotsupported-title', 'sectioneditnotsupported-text' );
628 $this->isNew = !$this->mTitle->exists() || $this->section == 'new';
630 if ( $request->wasPosted() ) {
631 # These fields need to be checked for encoding.
632 # Also remove trailing whitespace, but don't remove _initial_
633 # whitespace from the text boxes. This may be significant formatting.
634 $this->textbox1 = $this->safeUnicodeInput( $request, 'wpTextbox1' );
635 if ( !$request->getCheck( 'wpTextbox2' ) ) {
636 // Skip this if wpTextbox2 has input, it indicates that we came
637 // from a conflict page with raw page text, not a custom form
638 // modified by subclasses
639 wfProfileIn( get_class( $this ) . "::importContentFormData" );
640 $textbox1 = $this->importContentFormData( $request );
641 if ( $textbox1 !== null ) {
642 $this->textbox1 = $textbox1;
645 wfProfileOut( get_class( $this ) . "::importContentFormData" );
648 # Truncate for whole multibyte characters
649 $this->summary = $wgContLang->truncate( $request->getText( 'wpSummary' ), 255 );
651 # If the summary consists of a heading, e.g. '==Foobar==', extract the title from the
652 # header syntax, e.g. 'Foobar'. This is mainly an issue when we are using wpSummary for
653 # section titles.
654 $this->summary = preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->summary );
656 # Treat sectiontitle the same way as summary.
657 # Note that wpSectionTitle is not yet a part of the actual edit form, as wpSummary is
658 # currently doing double duty as both edit summary and section title. Right now this
659 # is just to allow API edits to work around this limitation, but this should be
660 # incorporated into the actual edit form when EditPage is rewritten (Bugs 18654, 26312).
661 $this->sectiontitle = $wgContLang->truncate( $request->getText( 'wpSectionTitle' ), 255 );
662 $this->sectiontitle = preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->sectiontitle );
664 $this->edittime = $request->getVal( 'wpEdittime' );
665 $this->starttime = $request->getVal( 'wpStarttime' );
667 $this->scrolltop = $request->getIntOrNull( 'wpScrolltop' );
669 if ( $this->textbox1 === '' && $request->getVal( 'wpTextbox1' ) === null ) {
670 // wpTextbox1 field is missing, possibly due to being "too big"
671 // according to some filter rules such as Suhosin's setting for
672 // suhosin.request.max_value_length (d'oh)
673 $this->incompleteForm = true;
674 } else {
675 // edittime should be one of our last fields; if it's missing,
676 // the submission probably broke somewhere in the middle.
677 $this->incompleteForm = is_null( $this->edittime );
679 if ( $this->incompleteForm ) {
680 # If the form is incomplete, force to preview.
681 wfDebug( __METHOD__ . ": Form data appears to be incomplete\n" );
682 wfDebug( "POST DATA: " . var_export( $_POST, true ) . "\n" );
683 $this->preview = true;
684 } else {
685 /* Fallback for live preview */
686 $this->preview = $request->getCheck( 'wpPreview' ) || $request->getCheck( 'wpLivePreview' );
687 $this->diff = $request->getCheck( 'wpDiff' );
689 // Remember whether a save was requested, so we can indicate
690 // if we forced preview due to session failure.
691 $this->mTriedSave = !$this->preview;
693 if ( $this->tokenOk( $request ) ) {
694 # Some browsers will not report any submit button
695 # if the user hits enter in the comment box.
696 # The unmarked state will be assumed to be a save,
697 # if the form seems otherwise complete.
698 wfDebug( __METHOD__ . ": Passed token check.\n" );
699 } elseif ( $this->diff ) {
700 # Failed token check, but only requested "Show Changes".
701 wfDebug( __METHOD__ . ": Failed token check; Show Changes requested.\n" );
702 } else {
703 # Page might be a hack attempt posted from
704 # an external site. Preview instead of saving.
705 wfDebug( __METHOD__ . ": Failed token check; forcing preview\n" );
706 $this->preview = true;
709 $this->save = !$this->preview && !$this->diff;
710 if ( !preg_match( '/^\d{14}$/', $this->edittime ) ) {
711 $this->edittime = null;
714 if ( !preg_match( '/^\d{14}$/', $this->starttime ) ) {
715 $this->starttime = null;
718 $this->recreate = $request->getCheck( 'wpRecreate' );
720 $this->minoredit = $request->getCheck( 'wpMinoredit' );
721 $this->watchthis = $request->getCheck( 'wpWatchthis' );
723 # Don't force edit summaries when a user is editing their own user or talk page
724 if ( ( $this->mTitle->mNamespace == NS_USER || $this->mTitle->mNamespace == NS_USER_TALK ) &&
725 $this->mTitle->getText() == $wgUser->getName() )
727 $this->allowBlankSummary = true;
728 } else {
729 $this->allowBlankSummary = $request->getBool( 'wpIgnoreBlankSummary' ) || !$wgUser->getOption( 'forceeditsummary' );
732 $this->autoSumm = $request->getText( 'wpAutoSummary' );
733 } else {
734 # Not a posted form? Start with nothing.
735 wfDebug( __METHOD__ . ": Not a posted form.\n" );
736 $this->textbox1 = '';
737 $this->summary = '';
738 $this->sectiontitle = '';
739 $this->edittime = '';
740 $this->starttime = wfTimestampNow();
741 $this->edit = false;
742 $this->preview = false;
743 $this->save = false;
744 $this->diff = false;
745 $this->minoredit = false;
746 $this->watchthis = $request->getBool( 'watchthis', false ); // Watch may be overridden by request parameters
747 $this->recreate = false;
749 // When creating a new section, we can preload a section title by passing it as the
750 // preloadtitle parameter in the URL (Bug 13100)
751 if ( $this->section == 'new' && $request->getVal( 'preloadtitle' ) ) {
752 $this->sectiontitle = $request->getVal( 'preloadtitle' );
753 // Once wpSummary isn't being use for setting section titles, we should delete this.
754 $this->summary = $request->getVal( 'preloadtitle' );
756 elseif ( $this->section != 'new' && $request->getVal( 'summary' ) ) {
757 $this->summary = $request->getText( 'summary' );
758 if ( $this->summary !== '' ) {
759 $this->hasPresetSummary = true;
763 if ( $request->getVal( 'minor' ) ) {
764 $this->minoredit = true;
768 $this->oldid = $request->getInt( 'oldid' );
770 $this->bot = $request->getBool( 'bot', true );
771 $this->nosummary = $request->getBool( 'nosummary' );
773 $content_handler = ContentHandler::getForTitle( $this->mTitle );
774 $this->contentModel = $request->getText( 'model', $content_handler->getModelID() ); #may be overridden by revision
775 $this->contentFormat = $request->getText( 'format', $content_handler->getDefaultFormat() ); #may be overridden by revision
777 #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
778 #TODO: check if the desired content model supports the given content format!
780 $this->live = $request->getCheck( 'live' );
781 $this->editintro = $request->getText( 'editintro',
782 // Custom edit intro for new sections
783 $this->section === 'new' ? 'MediaWiki:addsection-editintro' : '' );
785 // Allow extensions to modify form data
786 wfRunHooks( 'EditPage::importFormData', array( $this, $request ) );
788 wfProfileOut( __METHOD__ );
792 * Subpage overridable method for extracting the page content data from the
793 * posted form to be placed in $this->textbox1, if using customized input
794 * this method should be overridden and return the page text that will be used
795 * for saving, preview parsing and so on...
797 * @param $request WebRequest
799 protected function importContentFormData( &$request ) {
800 return; // Don't do anything, EditPage already extracted wpTextbox1
804 * Initialise form fields in the object
805 * Called on the first invocation, e.g. when a user clicks an edit link
806 * @return bool -- if the requested section is valid
808 function initialiseForm() {
809 global $wgUser;
810 $this->edittime = $this->mArticle->getTimestamp();
812 $content = $this->getContentObject( false ); #TODO: track content object?!
813 if ( $content === false ) {
814 return false;
816 $this->textbox1 = $this->toEditText( $content );
818 // activate checkboxes if user wants them to be always active
819 # Sort out the "watch" checkbox
820 if ( $wgUser->getOption( 'watchdefault' ) ) {
821 # Watch all edits
822 $this->watchthis = true;
823 } elseif ( $wgUser->getOption( 'watchcreations' ) && !$this->mTitle->exists() ) {
824 # Watch creations
825 $this->watchthis = true;
826 } elseif ( $wgUser->isWatched( $this->mTitle ) ) {
827 # Already watched
828 $this->watchthis = true;
830 if ( $wgUser->getOption( 'minordefault' ) && !$this->isNew ) {
831 $this->minoredit = true;
833 if ( $this->textbox1 === false ) {
834 return false;
836 wfProxyCheck();
837 return true;
841 * Fetch initial editing page content.
843 * @param $def_text string|bool
844 * @return mixed string on success, $def_text for invalid sections
845 * @private
846 * @deprecated since 1.21, get WikiPage::getContent() instead.
848 function getContent( $def_text = false ) {
849 ContentHandler::deprecated( __METHOD__, '1.21' );
851 if ( $def_text !== null && $def_text !== false && $def_text !== '' ) {
852 $def_content = $this->toEditContent( $def_text );
853 } else {
854 $def_content = false;
857 $content = $this->getContentObject( $def_content );
859 // Note: EditPage should only be used with text based content anyway.
860 return $this->toEditText( $content );
864 * @param Content|null $def_content The default value to return
866 * @return mixed Content on success, $def_content for invalid sections
868 * @since 1.21
870 protected function getContentObject( $def_content = null ) {
871 global $wgOut, $wgRequest;
873 wfProfileIn( __METHOD__ );
875 $content = false;
877 // For message page not locally set, use the i18n message.
878 // For other non-existent articles, use preload text if any.
879 if ( !$this->mTitle->exists() || $this->section == 'new' ) {
880 if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI && $this->section != 'new' ) {
881 # If this is a system message, get the default text.
882 $msg = $this->mTitle->getDefaultMessageText();
884 $content = $this->toEditContent( $msg );
886 if ( $content === false ) {
887 # If requested, preload some text.
888 $preload = $wgRequest->getVal( 'preload',
889 // Custom preload text for new sections
890 $this->section === 'new' ? 'MediaWiki:addsection-preload' : '' );
892 $content = $this->getPreloadedContent( $preload );
894 // For existing pages, get text based on "undo" or section parameters.
895 } else {
896 if ( $this->section != '' ) {
897 // Get section edit text (returns $def_text for invalid sections)
898 $orig = $this->getOriginalContent();
899 $content = $orig ? $orig->getSection( $this->section ) : null;
901 if ( !$content ) {
902 $content = $def_content;
904 } else {
905 $undoafter = $wgRequest->getInt( 'undoafter' );
906 $undo = $wgRequest->getInt( 'undo' );
908 if ( $undo > 0 && $undoafter > 0 ) {
909 if ( $undo < $undoafter ) {
910 # If they got undoafter and undo round the wrong way, switch them
911 list( $undo, $undoafter ) = array( $undoafter, $undo );
914 $undorev = Revision::newFromId( $undo );
915 $oldrev = Revision::newFromId( $undoafter );
917 # Sanity check, make sure it's the right page,
918 # the revisions exist and they were not deleted.
919 # Otherwise, $content will be left as-is.
920 if ( !is_null( $undorev ) && !is_null( $oldrev ) &&
921 $undorev->getPage() == $oldrev->getPage() &&
922 $undorev->getPage() == $this->mTitle->getArticleID() &&
923 !$undorev->isDeleted( Revision::DELETED_TEXT ) &&
924 !$oldrev->isDeleted( Revision::DELETED_TEXT ) ) {
926 $content = $this->mArticle->getUndoContent( $undorev, $oldrev );
928 if ( $content === false ) {
929 # Warn the user that something went wrong
930 $undoMsg = 'failure';
931 } else {
932 # Inform the user of our success and set an automatic edit summary
933 $undoMsg = 'success';
935 # If we just undid one rev, use an autosummary
936 $firstrev = $oldrev->getNext();
937 if ( $firstrev && $firstrev->getId() == $undo ) {
938 $undoSummary = wfMessage( 'undo-summary', $undo, $undorev->getUserText() )->inContentLanguage()->text();
939 if ( $this->summary === '' ) {
940 $this->summary = $undoSummary;
941 } else {
942 $this->summary = $undoSummary . wfMessage( 'colon-separator' )
943 ->inContentLanguage()->text() . $this->summary;
945 $this->undidRev = $undo;
947 $this->formtype = 'diff';
949 } else {
950 // Failed basic sanity checks.
951 // Older revisions may have been removed since the link
952 // was created, or we may simply have got bogus input.
953 $undoMsg = 'norev';
956 $class = ( $undoMsg == 'success' ? '' : 'error ' ) . "mw-undo-{$undoMsg}";
957 $this->editFormPageTop .= $wgOut->parse( "<div class=\"{$class}\">" .
958 wfMessage( 'undo-' . $undoMsg )->plain() . '</div>', true, /* interface */true );
961 if ( $content === false ) {
962 $content = $this->getOriginalContent();
967 wfProfileOut( __METHOD__ );
968 return $content;
972 * Get the content of the wanted revision, without section extraction.
974 * The result of this function can be used to compare user's input with
975 * section replaced in its context (using WikiPage::replaceSection())
976 * to the original text of the edit.
978 * This differs from Article::getContent() that when a missing revision is
979 * encountered the result will be null and not the
980 * 'missing-revision' message.
982 * @since 1.19
983 * @return Content|null
985 private function getOriginalContent() {
986 if ( $this->section == 'new' ) {
987 return $this->getCurrentContent();
989 $revision = $this->mArticle->getRevisionFetched();
990 if ( $revision === null ) {
991 if ( !$this->contentModel ) {
992 $this->contentModel = $this->getTitle()->getContentModel();
994 $handler = ContentHandler::getForModelID( $this->contentModel );
996 return $handler->makeEmptyContent();
998 $content = $revision->getContent();
999 return $content;
1003 * Get the current content of the page. This is basically similar to
1004 * WikiPage::getContent( Revision::RAW ) except that when the page doesn't exist an empty
1005 * content object is returned instead of null.
1007 * @since 1.21
1008 * @return Content
1010 protected function getCurrentContent() {
1011 $rev = $this->mArticle->getRevision();
1012 $content = $rev ? $rev->getContent( Revision::RAW ) : null;
1014 if ( $content === false || $content === null ) {
1015 if ( !$this->contentModel ) {
1016 $this->contentModel = $this->getTitle()->getContentModel();
1018 $handler = ContentHandler::getForModelID( $this->contentModel );
1020 return $handler->makeEmptyContent();
1021 } else {
1022 # nasty side-effect, but needed for consistency
1023 $this->contentModel = $rev->getContentModel();
1024 $this->contentFormat = $rev->getContentFormat();
1026 return $content;
1031 * Use this method before edit() to preload some text into the edit box
1033 * @param $text string
1034 * @deprecated since 1.21, use setPreloadedContent() instead.
1036 public function setPreloadedText( $text ) {
1037 ContentHandler::deprecated( __METHOD__, "1.21" );
1039 $content = $this->toEditContent( $text );
1041 $this->setPreloadedContent( $content );
1045 * Use this method before edit() to preload some content into the edit box
1047 * @param $content Content
1049 * @since 1.21
1051 public function setPreloadedContent( Content $content ) {
1052 $this->mPreloadContent = $content;
1056 * Get the contents to be preloaded into the box, either set by
1057 * an earlier setPreloadText() or by loading the given page.
1059 * @param string $preload representing the title to preload from.
1061 * @return String
1063 * @deprecated since 1.21, use getPreloadedContent() instead
1065 protected function getPreloadedText( $preload ) {
1066 ContentHandler::deprecated( __METHOD__, "1.21" );
1068 $content = $this->getPreloadedContent( $preload );
1069 $text = $this->toEditText( $content );
1071 return $text;
1075 * Get the contents to be preloaded into the box, either set by
1076 * an earlier setPreloadText() or by loading the given page.
1078 * @param string $preload representing the title to preload from.
1080 * @return Content
1082 * @since 1.21
1084 protected function getPreloadedContent( $preload ) {
1085 global $wgUser;
1087 if ( !empty( $this->mPreloadContent ) ) {
1088 return $this->mPreloadContent;
1091 $handler = ContentHandler::getForTitle( $this->getTitle() );
1093 if ( $preload === '' ) {
1094 return $handler->makeEmptyContent();
1097 $title = Title::newFromText( $preload );
1098 # Check for existence to avoid getting MediaWiki:Noarticletext
1099 if ( $title === null || !$title->exists() || !$title->userCan( 'read', $wgUser ) ) {
1100 //TODO: somehow show a warning to the user!
1101 return $handler->makeEmptyContent();
1104 $page = WikiPage::factory( $title );
1105 if ( $page->isRedirect() ) {
1106 $title = $page->getRedirectTarget();
1107 # Same as before
1108 if ( $title === null || !$title->exists() || !$title->userCan( 'read', $wgUser ) ) {
1109 //TODO: somehow show a warning to the user!
1110 return $handler->makeEmptyContent();
1112 $page = WikiPage::factory( $title );
1115 $parserOptions = ParserOptions::newFromUser( $wgUser );
1116 $content = $page->getContent( Revision::RAW );
1118 if ( !$content ) {
1119 //TODO: somehow show a warning to the user!
1120 return $handler->makeEmptyContent();
1123 if ( $content->getModel() !== $handler->getModelID() ) {
1124 $converted = $content->convert( $handler->getModelID() );
1126 if ( !$converted ) {
1127 //TODO: somehow show a warning to the user!
1128 wfDebug( "Attempt to preload incompatible content: "
1129 . "can't convert " . $content->getModel()
1130 . " to " . $handler->getModelID() );
1132 return $handler->makeEmptyContent();
1135 $content = $converted;
1138 return $content->preloadTransform( $title, $parserOptions );
1142 * Make sure the form isn't faking a user's credentials.
1144 * @param $request WebRequest
1145 * @return bool
1146 * @private
1148 function tokenOk( &$request ) {
1149 global $wgUser;
1150 $token = $request->getVal( 'wpEditToken' );
1151 $this->mTokenOk = $wgUser->matchEditToken( $token );
1152 $this->mTokenOkExceptSuffix = $wgUser->matchEditTokenNoSuffix( $token );
1153 return $this->mTokenOk;
1157 * Sets post-edit cookie indicating the user just saved a particular revision.
1159 * This uses a temporary cookie for each revision ID so separate saves will never
1160 * interfere with each other.
1162 * The cookie is deleted in the mediawiki.action.view.postEdit JS module after
1163 * the redirect. It must be clearable by JavaScript code, so it must not be
1164 * marked HttpOnly. The JavaScript code converts the cookie to a wgPostEdit config
1165 * variable.
1167 * Since WebResponse::setcookie does not allow forcing HttpOnly for a single
1168 * cookie, we have to use PHP's setcookie() directly.
1170 * We use a path of '/' since wgCookiePath is not exposed to JS
1172 * If the variable were set on the server, it would be cached, which is unwanted
1173 * since the post-edit state should only apply to the load right after the save.
1175 protected function setPostEditCookie() {
1176 global $wgCookiePrefix, $wgCookieDomain;
1177 $revisionId = $this->mArticle->getLatest();
1178 $postEditKey = self::POST_EDIT_COOKIE_KEY_PREFIX . $revisionId;
1180 setcookie( $wgCookiePrefix . $postEditKey, '1', time() + self::POST_EDIT_COOKIE_DURATION, '/', $wgCookieDomain );
1184 * Attempt submission
1185 * @throws UserBlockedError|ReadOnlyError|ThrottledError|PermissionsError
1186 * @return bool false if output is done, true if the rest of the form should be displayed
1188 function attemptSave() {
1189 global $wgUser, $wgOut;
1191 $resultDetails = false;
1192 # Allow bots to exempt some edits from bot flagging
1193 $bot = $wgUser->isAllowed( 'bot' ) && $this->bot;
1194 $status = $this->internalAttemptSave( $resultDetails, $bot );
1195 // FIXME: once the interface for internalAttemptSave() is made nicer, this should use the message in $status
1196 if ( $status->value == self::AS_SUCCESS_UPDATE || $status->value == self::AS_SUCCESS_NEW_ARTICLE ) {
1197 $this->didSave = true;
1198 if ( !$resultDetails['nullEdit'] ) {
1199 $this->setPostEditCookie();
1203 switch ( $status->value ) {
1204 case self::AS_HOOK_ERROR_EXPECTED:
1205 case self::AS_CONTENT_TOO_BIG:
1206 case self::AS_ARTICLE_WAS_DELETED:
1207 case self::AS_CONFLICT_DETECTED:
1208 case self::AS_SUMMARY_NEEDED:
1209 case self::AS_TEXTBOX_EMPTY:
1210 case self::AS_MAX_ARTICLE_SIZE_EXCEEDED:
1211 case self::AS_END:
1212 return true;
1214 case self::AS_HOOK_ERROR:
1215 return false;
1217 case self::AS_PARSE_ERROR:
1218 $wgOut->addWikiText( '<div class="error">' . $status->getWikiText() . '</div>' );
1219 return true;
1221 case self::AS_SUCCESS_NEW_ARTICLE:
1222 $query = $resultDetails['redirect'] ? 'redirect=no' : '';
1223 $anchor = isset ( $resultDetails['sectionanchor'] ) ? $resultDetails['sectionanchor'] : '';
1224 $wgOut->redirect( $this->mTitle->getFullURL( $query ) . $anchor );
1225 return false;
1227 case self::AS_SUCCESS_UPDATE:
1228 $extraQuery = '';
1229 $sectionanchor = $resultDetails['sectionanchor'];
1231 // Give extensions a chance to modify URL query on update
1232 wfRunHooks( 'ArticleUpdateBeforeRedirect', array( $this->mArticle, &$sectionanchor, &$extraQuery ) );
1234 if ( $resultDetails['redirect'] ) {
1235 if ( $extraQuery == '' ) {
1236 $extraQuery = 'redirect=no';
1237 } else {
1238 $extraQuery = 'redirect=no&' . $extraQuery;
1241 $wgOut->redirect( $this->mTitle->getFullURL( $extraQuery ) . $sectionanchor );
1242 return false;
1244 case self::AS_BLANK_ARTICLE:
1245 $wgOut->redirect( $this->getContextTitle()->getFullURL() );
1246 return false;
1248 case self::AS_SPAM_ERROR:
1249 $this->spamPageWithContent( $resultDetails['spam'] );
1250 return false;
1252 case self::AS_BLOCKED_PAGE_FOR_USER:
1253 throw new UserBlockedError( $wgUser->getBlock() );
1255 case self::AS_IMAGE_REDIRECT_ANON:
1256 case self::AS_IMAGE_REDIRECT_LOGGED:
1257 throw new PermissionsError( 'upload' );
1259 case self::AS_READ_ONLY_PAGE_ANON:
1260 case self::AS_READ_ONLY_PAGE_LOGGED:
1261 throw new PermissionsError( 'edit' );
1263 case self::AS_READ_ONLY_PAGE:
1264 throw new ReadOnlyError;
1266 case self::AS_RATE_LIMITED:
1267 throw new ThrottledError();
1269 case self::AS_NO_CREATE_PERMISSION:
1270 $permission = $this->mTitle->isTalkPage() ? 'createtalk' : 'createpage';
1271 throw new PermissionsError( $permission );
1273 default:
1274 // We don't recognize $status->value. The only way that can happen
1275 // is if an extension hook aborted from inside ArticleSave.
1276 // Render the status object into $this->hookError
1277 // FIXME this sucks, we should just use the Status object throughout
1278 $this->hookError = '<div class="error">' . $status->getWikitext() .
1279 '</div>';
1280 return true;
1285 * Run hooks that can filter edits just before they get saved.
1287 * @param Content $content the Content to filter.
1288 * @param Status $status for reporting the outcome to the caller
1289 * @param User $user the user performing the edit
1291 * @return bool
1293 protected function runPostMergeFilters( Content $content, Status $status, User $user ) {
1294 // Run old style post-section-merge edit filter
1295 if ( !ContentHandler::runLegacyHooks( 'EditFilterMerged',
1296 array( $this, $content, &$this->hookError, $this->summary ) ) ) {
1298 # Error messages etc. could be handled within the hook...
1299 $status->fatal( 'hookaborted' );
1300 $status->value = self::AS_HOOK_ERROR;
1301 return false;
1302 } elseif ( $this->hookError != '' ) {
1303 # ...or the hook could be expecting us to produce an error
1304 $status->fatal( 'hookaborted' );
1305 $status->value = self::AS_HOOK_ERROR_EXPECTED;
1306 return false;
1309 // Run new style post-section-merge edit filter
1310 if ( !wfRunHooks( 'EditFilterMergedContent',
1311 array( $this->mArticle->getContext(), $content, $status, $this->summary,
1312 $user, $this->minoredit ) ) ) {
1314 # Error messages etc. could be handled within the hook...
1315 // XXX: $status->value may already be something informative...
1316 $this->hookError = $status->getWikiText();
1317 $status->fatal( 'hookaborted' );
1318 $status->value = self::AS_HOOK_ERROR;
1319 return false;
1320 } elseif ( !$status->isOK() ) {
1321 # ...or the hook could be expecting us to produce an error
1322 // FIXME this sucks, we should just use the Status object throughout
1323 $this->hookError = $status->getWikiText();
1324 $status->fatal( 'hookaborted' );
1325 $status->value = self::AS_HOOK_ERROR_EXPECTED;
1326 return false;
1329 return true;
1333 * Attempt submission (no UI)
1335 * @param array $result array to add statuses to, currently with the possible keys:
1336 * spam - string - Spam string from content if any spam is detected by matchSpamRegex
1337 * sectionanchor - string - Section anchor for a section save
1338 * nullEdit - boolean - Set if doEditContent is OK. True if null edit, false otherwise.
1339 * redirect - boolean - Set if doEditContent is OK. True if resulting revision is a redirect
1340 * @param bool $bot True if edit is being made under the bot right.
1342 * @return Status object, possibly with a message, but always with one of the AS_* constants in $status->value,
1344 * FIXME: This interface is TERRIBLE, but hard to get rid of due to various error display idiosyncrasies. There are
1345 * also lots of cases where error metadata is set in the object and retrieved later instead of being returned, e.g.
1346 * AS_CONTENT_TOO_BIG and AS_BLOCKED_PAGE_FOR_USER. All that stuff needs to be cleaned up some time.
1348 function internalAttemptSave( &$result, $bot = false ) {
1349 global $wgUser, $wgRequest, $wgParser, $wgMaxArticleSize;
1351 $status = Status::newGood();
1353 wfProfileIn( __METHOD__ );
1354 wfProfileIn( __METHOD__ . '-checks' );
1356 if ( !wfRunHooks( 'EditPage::attemptSave', array( $this ) ) ) {
1357 wfDebug( "Hook 'EditPage::attemptSave' aborted article saving\n" );
1358 $status->fatal( 'hookaborted' );
1359 $status->value = self::AS_HOOK_ERROR;
1360 wfProfileOut( __METHOD__ . '-checks' );
1361 wfProfileOut( __METHOD__ );
1362 return $status;
1365 try {
1366 # Construct Content object
1367 $textbox_content = $this->toEditContent( $this->textbox1 );
1368 } catch ( MWContentSerializationException $ex ) {
1369 $status->fatal( 'content-failed-to-parse', $this->contentModel, $this->contentFormat, $ex->getMessage() );
1370 $status->value = self::AS_PARSE_ERROR;
1371 wfProfileOut( __METHOD__ . '-checks' );
1372 wfProfileOut( __METHOD__ );
1373 return $status;
1376 # Check image redirect
1377 if ( $this->mTitle->getNamespace() == NS_FILE &&
1378 $textbox_content->isRedirect() &&
1379 !$wgUser->isAllowed( 'upload' ) ) {
1380 $code = $wgUser->isAnon() ? self::AS_IMAGE_REDIRECT_ANON : self::AS_IMAGE_REDIRECT_LOGGED;
1381 $status->setResult( false, $code );
1383 wfProfileOut( __METHOD__ . '-checks' );
1384 wfProfileOut( __METHOD__ );
1386 return $status;
1389 # Check for spam
1390 $match = self::matchSummarySpamRegex( $this->summary );
1391 if ( $match === false ) {
1392 $match = self::matchSpamRegex( $this->textbox1 );
1394 if ( $match !== false ) {
1395 $result['spam'] = $match;
1396 $ip = $wgRequest->getIP();
1397 $pdbk = $this->mTitle->getPrefixedDBkey();
1398 $match = str_replace( "\n", '', $match );
1399 wfDebugLog( 'SpamRegex', "$ip spam regex hit [[$pdbk]]: \"$match\"" );
1400 $status->fatal( 'spamprotectionmatch', $match );
1401 $status->value = self::AS_SPAM_ERROR;
1402 wfProfileOut( __METHOD__ . '-checks' );
1403 wfProfileOut( __METHOD__ );
1404 return $status;
1406 if ( !wfRunHooks( 'EditFilter', array( $this, $this->textbox1, $this->section, &$this->hookError, $this->summary ) ) ) {
1407 # Error messages etc. could be handled within the hook...
1408 $status->fatal( 'hookaborted' );
1409 $status->value = self::AS_HOOK_ERROR;
1410 wfProfileOut( __METHOD__ . '-checks' );
1411 wfProfileOut( __METHOD__ );
1412 return $status;
1413 } elseif ( $this->hookError != '' ) {
1414 # ...or the hook could be expecting us to produce an error
1415 $status->fatal( 'hookaborted' );
1416 $status->value = self::AS_HOOK_ERROR_EXPECTED;
1417 wfProfileOut( __METHOD__ . '-checks' );
1418 wfProfileOut( __METHOD__ );
1419 return $status;
1422 if ( $wgUser->isBlockedFrom( $this->mTitle, false ) ) {
1423 // Auto-block user's IP if the account was "hard" blocked
1424 $wgUser->spreadAnyEditBlock();
1425 # Check block state against master, thus 'false'.
1426 $status->setResult( false, self::AS_BLOCKED_PAGE_FOR_USER );
1427 wfProfileOut( __METHOD__ . '-checks' );
1428 wfProfileOut( __METHOD__ );
1429 return $status;
1432 $this->kblength = (int)( strlen( $this->textbox1 ) / 1024 );
1433 if ( $this->kblength > $wgMaxArticleSize ) {
1434 // Error will be displayed by showEditForm()
1435 $this->tooBig = true;
1436 $status->setResult( false, self::AS_CONTENT_TOO_BIG );
1437 wfProfileOut( __METHOD__ . '-checks' );
1438 wfProfileOut( __METHOD__ );
1439 return $status;
1442 if ( !$wgUser->isAllowed( 'edit' ) ) {
1443 if ( $wgUser->isAnon() ) {
1444 $status->setResult( false, self::AS_READ_ONLY_PAGE_ANON );
1445 wfProfileOut( __METHOD__ . '-checks' );
1446 wfProfileOut( __METHOD__ );
1447 return $status;
1448 } else {
1449 $status->fatal( 'readonlytext' );
1450 $status->value = self::AS_READ_ONLY_PAGE_LOGGED;
1451 wfProfileOut( __METHOD__ . '-checks' );
1452 wfProfileOut( __METHOD__ );
1453 return $status;
1457 if ( wfReadOnly() ) {
1458 $status->fatal( 'readonlytext' );
1459 $status->value = self::AS_READ_ONLY_PAGE;
1460 wfProfileOut( __METHOD__ . '-checks' );
1461 wfProfileOut( __METHOD__ );
1462 return $status;
1464 if ( $wgUser->pingLimiter() ) {
1465 $status->fatal( 'actionthrottledtext' );
1466 $status->value = self::AS_RATE_LIMITED;
1467 wfProfileOut( __METHOD__ . '-checks' );
1468 wfProfileOut( __METHOD__ );
1469 return $status;
1472 # If the article has been deleted while editing, don't save it without
1473 # confirmation
1474 if ( $this->wasDeletedSinceLastEdit() && !$this->recreate ) {
1475 $status->setResult( false, self::AS_ARTICLE_WAS_DELETED );
1476 wfProfileOut( __METHOD__ . '-checks' );
1477 wfProfileOut( __METHOD__ );
1478 return $status;
1481 wfProfileOut( __METHOD__ . '-checks' );
1483 # Load the page data from the master. If anything changes in the meantime,
1484 # we detect it by using page_latest like a token in a 1 try compare-and-swap.
1485 $this->mArticle->loadPageData( 'fromdbmaster' );
1486 $new = !$this->mArticle->exists();
1488 if ( $new ) {
1489 // Late check for create permission, just in case *PARANOIA*
1490 if ( !$this->mTitle->userCan( 'create', $wgUser ) ) {
1491 $status->fatal( 'nocreatetext' );
1492 $status->value = self::AS_NO_CREATE_PERMISSION;
1493 wfDebug( __METHOD__ . ": no create permission\n" );
1494 wfProfileOut( __METHOD__ );
1495 return $status;
1498 # Don't save a new article if it's blank.
1499 if ( $this->textbox1 == '' ) {
1500 $status->setResult( false, self::AS_BLANK_ARTICLE );
1501 wfProfileOut( __METHOD__ );
1502 return $status;
1505 if ( !$this->runPostMergeFilters( $textbox_content, $status, $wgUser ) ) {
1506 wfProfileOut( __METHOD__ );
1507 return $status;
1510 $content = $textbox_content;
1512 $result['sectionanchor'] = '';
1513 if ( $this->section == 'new' ) {
1514 if ( $this->sectiontitle !== '' ) {
1515 // Insert the section title above the content.
1516 $content = $content->addSectionHeader( $this->sectiontitle );
1518 // Jump to the new section
1519 $result['sectionanchor'] = $wgParser->guessLegacySectionNameFromWikiText( $this->sectiontitle );
1521 // If no edit summary was specified, create one automatically from the section
1522 // title and have it link to the new section. Otherwise, respect the summary as
1523 // passed.
1524 if ( $this->summary === '' ) {
1525 $cleanSectionTitle = $wgParser->stripSectionName( $this->sectiontitle );
1526 $this->summary = wfMessage( 'newsectionsummary' )
1527 ->rawParams( $cleanSectionTitle )->inContentLanguage()->text();
1529 } elseif ( $this->summary !== '' ) {
1530 // Insert the section title above the content.
1531 $content = $content->addSectionHeader( $this->summary );
1533 // Jump to the new section
1534 $result['sectionanchor'] = $wgParser->guessLegacySectionNameFromWikiText( $this->summary );
1536 // Create a link to the new section from the edit summary.
1537 $cleanSummary = $wgParser->stripSectionName( $this->summary );
1538 $this->summary = wfMessage( 'newsectionsummary' )
1539 ->rawParams( $cleanSummary )->inContentLanguage()->text();
1543 $status->value = self::AS_SUCCESS_NEW_ARTICLE;
1545 } else { # not $new
1547 # Article exists. Check for edit conflict.
1549 $this->mArticle->clear(); # Force reload of dates, etc.
1550 $timestamp = $this->mArticle->getTimestamp();
1552 wfDebug( "timestamp: {$timestamp}, edittime: {$this->edittime}\n" );
1554 if ( $timestamp != $this->edittime ) {
1555 $this->isConflict = true;
1556 if ( $this->section == 'new' ) {
1557 if ( $this->mArticle->getUserText() == $wgUser->getName() &&
1558 $this->mArticle->getComment() == $this->summary ) {
1559 // Probably a duplicate submission of a new comment.
1560 // This can happen when squid resends a request after
1561 // a timeout but the first one actually went through.
1562 wfDebug( __METHOD__ . ": duplicate new section submission; trigger edit conflict!\n" );
1563 } else {
1564 // New comment; suppress conflict.
1565 $this->isConflict = false;
1566 wfDebug( __METHOD__ . ": conflict suppressed; new section\n" );
1568 } elseif ( $this->section == '' && Revision::userWasLastToEdit( DB_MASTER, $this->mTitle->getArticleID(),
1569 $wgUser->getId(), $this->edittime ) ) {
1570 # Suppress edit conflict with self, except for section edits where merging is required.
1571 wfDebug( __METHOD__ . ": Suppressing edit conflict, same user.\n" );
1572 $this->isConflict = false;
1576 // If sectiontitle is set, use it, otherwise use the summary as the section title (for
1577 // backwards compatibility with old forms/bots).
1578 if ( $this->sectiontitle !== '' ) {
1579 $sectionTitle = $this->sectiontitle;
1580 } else {
1581 $sectionTitle = $this->summary;
1584 $content = null;
1586 if ( $this->isConflict ) {
1587 wfDebug( __METHOD__ . ": conflict! getting section '{$this->section}' for time '{$this->edittime}'"
1588 . " (article time '{$timestamp}')\n" );
1590 $content = $this->mArticle->replaceSectionContent( $this->section, $textbox_content, $sectionTitle, $this->edittime );
1591 } else {
1592 wfDebug( __METHOD__ . ": getting section '{$this->section}'\n" );
1593 $content = $this->mArticle->replaceSectionContent( $this->section, $textbox_content, $sectionTitle );
1596 if ( is_null( $content ) ) {
1597 wfDebug( __METHOD__ . ": activating conflict; section replace failed.\n" );
1598 $this->isConflict = true;
1599 $content = $textbox_content; // do not try to merge here!
1600 } elseif ( $this->isConflict ) {
1601 # Attempt merge
1602 if ( $this->mergeChangesIntoContent( $content ) ) {
1603 // Successful merge! Maybe we should tell the user the good news?
1604 $this->isConflict = false;
1605 wfDebug( __METHOD__ . ": Suppressing edit conflict, successful merge.\n" );
1606 } else {
1607 $this->section = '';
1608 $this->textbox1 = ContentHandler::getContentText( $content );
1609 wfDebug( __METHOD__ . ": Keeping edit conflict, failed merge.\n" );
1613 if ( $this->isConflict ) {
1614 $status->setResult( false, self::AS_CONFLICT_DETECTED );
1615 wfProfileOut( __METHOD__ );
1616 return $status;
1619 if ( !$this->runPostMergeFilters( $content, $status, $wgUser ) ) {
1620 wfProfileOut( __METHOD__ );
1621 return $status;
1624 if ( $this->section == 'new' ) {
1625 // Handle the user preference to force summaries here
1626 if ( !$this->allowBlankSummary && trim( $this->summary ) == '' ) {
1627 $this->missingSummary = true;
1628 $status->fatal( 'missingsummary' ); // or 'missingcommentheader' if $section == 'new'. Blegh
1629 $status->value = self::AS_SUMMARY_NEEDED;
1630 wfProfileOut( __METHOD__ );
1631 return $status;
1634 // Do not allow the user to post an empty comment
1635 if ( $this->textbox1 == '' ) {
1636 $this->missingComment = true;
1637 $status->fatal( 'missingcommenttext' );
1638 $status->value = self::AS_TEXTBOX_EMPTY;
1639 wfProfileOut( __METHOD__ );
1640 return $status;
1642 } elseif ( !$this->allowBlankSummary
1643 && !$content->equals( $this->getOriginalContent() )
1644 && !$content->isRedirect()
1645 && md5( $this->summary ) == $this->autoSumm
1647 $this->missingSummary = true;
1648 $status->fatal( 'missingsummary' );
1649 $status->value = self::AS_SUMMARY_NEEDED;
1650 wfProfileOut( __METHOD__ );
1651 return $status;
1654 # All's well
1655 wfProfileIn( __METHOD__ . '-sectionanchor' );
1656 $sectionanchor = '';
1657 if ( $this->section == 'new' ) {
1658 if ( $this->sectiontitle !== '' ) {
1659 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $this->sectiontitle );
1660 // If no edit summary was specified, create one automatically from the section
1661 // title and have it link to the new section. Otherwise, respect the summary as
1662 // passed.
1663 if ( $this->summary === '' ) {
1664 $cleanSectionTitle = $wgParser->stripSectionName( $this->sectiontitle );
1665 $this->summary = wfMessage( 'newsectionsummary' )
1666 ->rawParams( $cleanSectionTitle )->inContentLanguage()->text();
1668 } elseif ( $this->summary !== '' ) {
1669 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $this->summary );
1670 # This is a new section, so create a link to the new section
1671 # in the revision summary.
1672 $cleanSummary = $wgParser->stripSectionName( $this->summary );
1673 $this->summary = wfMessage( 'newsectionsummary' )
1674 ->rawParams( $cleanSummary )->inContentLanguage()->text();
1676 } elseif ( $this->section != '' ) {
1677 # Try to get a section anchor from the section source, redirect to edited section if header found
1678 # XXX: might be better to integrate this into Article::replaceSection
1679 # for duplicate heading checking and maybe parsing
1680 $hasmatch = preg_match( "/^ *([=]{1,6})(.*?)(\\1) *\\n/i", $this->textbox1, $matches );
1681 # we can't deal with anchors, includes, html etc in the header for now,
1682 # headline would need to be parsed to improve this
1683 if ( $hasmatch && strlen( $matches[2] ) > 0 ) {
1684 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $matches[2] );
1687 $result['sectionanchor'] = $sectionanchor;
1688 wfProfileOut( __METHOD__ . '-sectionanchor' );
1690 // Save errors may fall down to the edit form, but we've now
1691 // merged the section into full text. Clear the section field
1692 // so that later submission of conflict forms won't try to
1693 // replace that into a duplicated mess.
1694 $this->textbox1 = $this->toEditText( $content );
1695 $this->section = '';
1697 $status->value = self::AS_SUCCESS_UPDATE;
1700 // Check for length errors again now that the section is merged in
1701 $this->kblength = (int)( strlen( $this->toEditText( $content ) ) / 1024 );
1702 if ( $this->kblength > $wgMaxArticleSize ) {
1703 $this->tooBig = true;
1704 $status->setResult( false, self::AS_MAX_ARTICLE_SIZE_EXCEEDED );
1705 wfProfileOut( __METHOD__ );
1706 return $status;
1709 $flags = EDIT_DEFER_UPDATES | EDIT_AUTOSUMMARY |
1710 ( $new ? EDIT_NEW : EDIT_UPDATE ) |
1711 ( ( $this->minoredit && !$this->isNew ) ? EDIT_MINOR : 0 ) |
1712 ( $bot ? EDIT_FORCE_BOT : 0 );
1714 $doEditStatus = $this->mArticle->doEditContent( $content, $this->summary, $flags,
1715 false, null, $this->contentFormat );
1717 if ( !$doEditStatus->isOK() ) {
1718 // Failure from doEdit()
1719 // Show the edit conflict page for certain recognized errors from doEdit(),
1720 // but don't show it for errors from extension hooks
1721 $errors = $doEditStatus->getErrorsArray();
1722 if ( in_array( $errors[0][0], array( 'edit-gone-missing', 'edit-conflict',
1723 'edit-already-exists' ) ) )
1725 $this->isConflict = true;
1726 // Destroys data doEdit() put in $status->value but who cares
1727 $doEditStatus->value = self::AS_END;
1729 wfProfileOut( __METHOD__ );
1730 return $doEditStatus;
1733 $result['nullEdit'] = $doEditStatus->hasMessage( 'edit-no-change' );
1734 $result['redirect'] = $content->isRedirect();
1735 $this->updateWatchlist();
1736 wfProfileOut( __METHOD__ );
1737 return $status;
1741 * Register the change of watch status
1743 protected function updateWatchlist() {
1744 global $wgUser;
1746 if ( $wgUser->isLoggedIn() && $this->watchthis != $wgUser->isWatched( $this->mTitle ) ) {
1747 $fname = __METHOD__;
1748 $title = $this->mTitle;
1749 $watch = $this->watchthis;
1751 // Do this in its own transaction to reduce contention...
1752 $dbw = wfGetDB( DB_MASTER );
1753 $dbw->onTransactionIdle( function() use ( $dbw, $title, $watch, $wgUser, $fname ) {
1754 $dbw->begin( $fname );
1755 if ( $watch ) {
1756 WatchAction::doWatch( $title, $wgUser );
1757 } else {
1758 WatchAction::doUnwatch( $title, $wgUser );
1760 $dbw->commit( $fname );
1761 } );
1766 * Attempts to merge text content with base and current revisions
1768 * @param $editText string
1770 * @return bool
1771 * @deprecated since 1.21, use mergeChangesIntoContent() instead
1773 function mergeChangesInto( &$editText ) {
1774 ContentHandler::deprecated( __METHOD__, "1.21" );
1776 $editContent = $this->toEditContent( $editText );
1778 $ok = $this->mergeChangesIntoContent( $editContent );
1780 if ( $ok ) {
1781 $editText = $this->toEditText( $editContent );
1782 return true;
1784 return false;
1788 * Attempts to do 3-way merge of edit content with a base revision
1789 * and current content, in case of edit conflict, in whichever way appropriate
1790 * for the content type.
1792 * @since 1.21
1794 * @param $editContent
1796 * @return bool
1798 private function mergeChangesIntoContent( &$editContent ) {
1799 wfProfileIn( __METHOD__ );
1801 $db = wfGetDB( DB_MASTER );
1803 // This is the revision the editor started from
1804 $baseRevision = $this->getBaseRevision();
1805 $baseContent = $baseRevision ? $baseRevision->getContent() : null;
1807 if ( is_null( $baseContent ) ) {
1808 wfProfileOut( __METHOD__ );
1809 return false;
1812 // The current state, we want to merge updates into it
1813 $currentRevision = Revision::loadFromTitle( $db, $this->mTitle );
1814 $currentContent = $currentRevision ? $currentRevision->getContent() : null;
1816 if ( is_null( $currentContent ) ) {
1817 wfProfileOut( __METHOD__ );
1818 return false;
1821 $handler = ContentHandler::getForModelID( $baseContent->getModel() );
1823 $result = $handler->merge3( $baseContent, $editContent, $currentContent );
1825 if ( $result ) {
1826 $editContent = $result;
1827 wfProfileOut( __METHOD__ );
1828 return true;
1831 wfProfileOut( __METHOD__ );
1832 return false;
1836 * @return Revision
1838 function getBaseRevision() {
1839 if ( !$this->mBaseRevision ) {
1840 $db = wfGetDB( DB_MASTER );
1841 $baseRevision = Revision::loadFromTimestamp(
1842 $db, $this->mTitle, $this->edittime );
1843 return $this->mBaseRevision = $baseRevision;
1844 } else {
1845 return $this->mBaseRevision;
1850 * Check given input text against $wgSpamRegex, and return the text of the first match.
1852 * @param $text string
1854 * @return string|bool matching string or false
1856 public static function matchSpamRegex( $text ) {
1857 global $wgSpamRegex;
1858 // For back compatibility, $wgSpamRegex may be a single string or an array of regexes.
1859 $regexes = (array)$wgSpamRegex;
1860 return self::matchSpamRegexInternal( $text, $regexes );
1864 * Check given input text against $wgSpamRegex, and return the text of the first match.
1866 * @param $text string
1868 * @return string|bool matching string or false
1870 public static function matchSummarySpamRegex( $text ) {
1871 global $wgSummarySpamRegex;
1872 $regexes = (array)$wgSummarySpamRegex;
1873 return self::matchSpamRegexInternal( $text, $regexes );
1877 * @param $text string
1878 * @param $regexes array
1879 * @return bool|string
1881 protected static function matchSpamRegexInternal( $text, $regexes ) {
1882 foreach ( $regexes as $regex ) {
1883 $matches = array();
1884 if ( preg_match( $regex, $text, $matches ) ) {
1885 return $matches[0];
1888 return false;
1891 function setHeaders() {
1892 global $wgOut, $wgUser;
1894 $wgOut->addModules( 'mediawiki.action.edit' );
1896 if ( $wgUser->getOption( 'uselivepreview', false ) ) {
1897 $wgOut->addModules( 'mediawiki.action.edit.preview' );
1900 if ( $wgUser->getOption( 'useeditwarning', false ) ) {
1901 $wgOut->addModules( 'mediawiki.action.edit.editWarning' );
1904 // Bug #19334: textarea jumps when editing articles in IE8
1905 $wgOut->addStyle( 'common/IE80Fixes.css', 'screen', 'IE 8' );
1907 $wgOut->setRobotPolicy( 'noindex,nofollow' );
1909 # Enabled article-related sidebar, toplinks, etc.
1910 $wgOut->setArticleRelated( true );
1912 $contextTitle = $this->getContextTitle();
1913 if ( $this->isConflict ) {
1914 $msg = 'editconflict';
1915 } elseif ( $contextTitle->exists() && $this->section != '' ) {
1916 $msg = $this->section == 'new' ? 'editingcomment' : 'editingsection';
1917 } else {
1918 $msg = $contextTitle->exists() || ( $contextTitle->getNamespace() == NS_MEDIAWIKI && $contextTitle->getDefaultMessageText() !== false ) ?
1919 'editing' : 'creating';
1921 # Use the title defined by DISPLAYTITLE magic word when present
1922 $displayTitle = isset( $this->mParserOutput ) ? $this->mParserOutput->getDisplayTitle() : false;
1923 if ( $displayTitle === false ) {
1924 $displayTitle = $contextTitle->getPrefixedText();
1926 $wgOut->setPageTitle( wfMessage( $msg, $displayTitle ) );
1930 * Show all applicable editing introductions
1932 protected function showIntro() {
1933 global $wgOut, $wgUser;
1934 if ( $this->suppressIntro ) {
1935 return;
1938 $namespace = $this->mTitle->getNamespace();
1940 if ( $namespace == NS_MEDIAWIKI ) {
1941 # Show a warning if editing an interface message
1942 $wgOut->wrapWikiMsg( "<div class='mw-editinginterface'>\n$1\n</div>", 'editinginterface' );
1943 } elseif ( $namespace == NS_FILE ) {
1944 # Show a hint to shared repo
1945 $file = wfFindFile( $this->mTitle );
1946 if ( $file && !$file->isLocal() ) {
1947 $descUrl = $file->getDescriptionUrl();
1948 # there must be a description url to show a hint to shared repo
1949 if ( $descUrl ) {
1950 if ( !$this->mTitle->exists() ) {
1951 $wgOut->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-create\">\n$1\n</div>", array(
1952 'sharedupload-desc-create', $file->getRepo()->getDisplayName(), $descUrl
1953 ) );
1954 } else {
1955 $wgOut->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-edit\">\n$1\n</div>", array(
1956 'sharedupload-desc-edit', $file->getRepo()->getDisplayName(), $descUrl
1957 ) );
1963 # Show a warning message when someone creates/edits a user (talk) page but the user does not exist
1964 # Show log extract when the user is currently blocked
1965 if ( $namespace == NS_USER || $namespace == NS_USER_TALK ) {
1966 $parts = explode( '/', $this->mTitle->getText(), 2 );
1967 $username = $parts[0];
1968 $user = User::newFromName( $username, false /* allow IP users*/ );
1969 $ip = User::isIP( $username );
1970 if ( !( $user && $user->isLoggedIn() ) && !$ip ) { # User does not exist
1971 $wgOut->wrapWikiMsg( "<div class=\"mw-userpage-userdoesnotexist error\">\n$1\n</div>",
1972 array( 'userpage-userdoesnotexist', wfEscapeWikiText( $username ) ) );
1973 } elseif ( $user->isBlocked() ) { # Show log extract if the user is currently blocked
1974 LogEventsList::showLogExtract(
1975 $wgOut,
1976 'block',
1977 $user->getUserPage(),
1979 array(
1980 'lim' => 1,
1981 'showIfEmpty' => false,
1982 'msgKey' => array(
1983 'blocked-notice-logextract',
1984 $user->getName() # Support GENDER in notice
1990 # Try to add a custom edit intro, or use the standard one if this is not possible.
1991 if ( !$this->showCustomIntro() && !$this->mTitle->exists() ) {
1992 if ( $wgUser->isLoggedIn() ) {
1993 $wgOut->wrapWikiMsg( "<div class=\"mw-newarticletext\">\n$1\n</div>", 'newarticletext' );
1994 } else {
1995 $wgOut->wrapWikiMsg( "<div class=\"mw-newarticletextanon\">\n$1\n</div>", 'newarticletextanon' );
1998 # Give a notice if the user is editing a deleted/moved page...
1999 if ( !$this->mTitle->exists() ) {
2000 LogEventsList::showLogExtract( $wgOut, array( 'delete', 'move' ), $this->mTitle,
2002 array(
2003 'lim' => 10,
2004 'conds' => array( "log_action != 'revision'" ),
2005 'showIfEmpty' => false,
2006 'msgKey' => array( 'recreate-moveddeleted-warn' )
2013 * Attempt to show a custom editing introduction, if supplied
2015 * @return bool
2017 protected function showCustomIntro() {
2018 if ( $this->editintro ) {
2019 $title = Title::newFromText( $this->editintro );
2020 if ( $title instanceof Title && $title->exists() && $title->userCan( 'read' ) ) {
2021 global $wgOut;
2022 // Added using template syntax, to take <noinclude>'s into account.
2023 $wgOut->addWikiTextTitleTidy( '{{:' . $title->getFullText() . '}}', $this->mTitle );
2024 return true;
2027 return false;
2031 * Gets an editable textual representation of $content.
2032 * The textual representation can be turned by into a Content object by the
2033 * toEditContent() method.
2035 * If $content is null or false or a string, $content is returned unchanged.
2037 * If the given Content object is not of a type that can be edited using the text base EditPage,
2038 * an exception will be raised. Set $this->allowNonTextContent to true to allow editing of non-textual
2039 * content.
2041 * @param Content|null|bool|string $content
2042 * @return String the editable text form of the content.
2044 * @throws MWException if $content is not an instance of TextContent and $this->allowNonTextContent is not true.
2046 protected function toEditText( $content ) {
2047 if ( $content === null || $content === false ) {
2048 return $content;
2051 if ( is_string( $content ) ) {
2052 return $content;
2055 if ( !$this->allowNonTextContent && !( $content instanceof TextContent ) ) {
2056 throw new MWException( "This content model can not be edited as text: "
2057 . ContentHandler::getLocalizedName( $content->getModel() ) );
2060 return $content->serialize( $this->contentFormat );
2064 * Turns the given text into a Content object by unserializing it.
2066 * If the resulting Content object is not of a type that can be edited using the text base EditPage,
2067 * an exception will be raised. Set $this->allowNonTextContent to true to allow editing of non-textual
2068 * content.
2070 * @param string|null|bool $text Text to unserialize
2071 * @return Content The content object created from $text. If $text was false or null, false resp. null will be
2072 * returned instead.
2074 * @throws MWException if unserializing the text results in a Content object that is not an instance of TextContent
2075 * and $this->allowNonTextContent is not true.
2077 protected function toEditContent( $text ) {
2078 if ( $text === false || $text === null ) {
2079 return $text;
2082 $content = ContentHandler::makeContent( $text, $this->getTitle(),
2083 $this->contentModel, $this->contentFormat );
2085 if ( !$this->allowNonTextContent && !( $content instanceof TextContent ) ) {
2086 throw new MWException( "This content model can not be edited as text: "
2087 . ContentHandler::getLocalizedName( $content->getModel() ) );
2090 return $content;
2094 * Send the edit form and related headers to $wgOut
2095 * @param $formCallback Callback|null that takes an OutputPage parameter; will be called
2096 * during form output near the top, for captchas and the like.
2098 function showEditForm( $formCallback = null ) {
2099 global $wgOut, $wgUser;
2101 wfProfileIn( __METHOD__ );
2103 # need to parse the preview early so that we know which templates are used,
2104 # otherwise users with "show preview after edit box" will get a blank list
2105 # we parse this near the beginning so that setHeaders can do the title
2106 # setting work instead of leaving it in getPreviewText
2107 $previewOutput = '';
2108 if ( $this->formtype == 'preview' ) {
2109 $previewOutput = $this->getPreviewText();
2112 wfRunHooks( 'EditPage::showEditForm:initial', array( &$this, &$wgOut ) );
2114 $this->setHeaders();
2116 if ( $this->showHeader() === false ) {
2117 wfProfileOut( __METHOD__ );
2118 return;
2121 $wgOut->addHTML( $this->editFormPageTop );
2123 if ( $wgUser->getOption( 'previewontop' ) ) {
2124 $this->displayPreviewArea( $previewOutput, true );
2127 $wgOut->addHTML( $this->editFormTextTop );
2129 $showToolbar = true;
2130 if ( $this->wasDeletedSinceLastEdit() ) {
2131 if ( $this->formtype == 'save' ) {
2132 // Hide the toolbar and edit area, user can click preview to get it back
2133 // Add an confirmation checkbox and explanation.
2134 $showToolbar = false;
2135 } else {
2136 $wgOut->wrapWikiMsg( "<div class='error mw-deleted-while-editing'>\n$1\n</div>",
2137 'deletedwhileediting' );
2141 //@todo: add EditForm plugin interface and use it here!
2142 // search for textarea1 and textares2, and allow EditForm to override all uses.
2143 $wgOut->addHTML( Html::openElement( 'form', array( 'id' => self::EDITFORM_ID, 'name' => self::EDITFORM_ID,
2144 'method' => 'post', 'action' => $this->getActionURL( $this->getContextTitle() ),
2145 'enctype' => 'multipart/form-data' ) ) );
2147 if ( is_callable( $formCallback ) ) {
2148 call_user_func_array( $formCallback, array( &$wgOut ) );
2151 wfRunHooks( 'EditPage::showEditForm:fields', array( &$this, &$wgOut ) );
2153 // Put these up at the top to ensure they aren't lost on early form submission
2154 $this->showFormBeforeText();
2156 if ( $this->wasDeletedSinceLastEdit() && 'save' == $this->formtype ) {
2157 $username = $this->lastDelete->user_name;
2158 $comment = $this->lastDelete->log_comment;
2160 // It is better to not parse the comment at all than to have templates expanded in the middle
2161 // TODO: can the checkLabel be moved outside of the div so that wrapWikiMsg could be used?
2162 $key = $comment === ''
2163 ? 'confirmrecreate-noreason'
2164 : 'confirmrecreate';
2165 $wgOut->addHTML(
2166 '<div class="mw-confirm-recreate">' .
2167 wfMessage( $key, $username, "<nowiki>$comment</nowiki>" )->parse() .
2168 Xml::checkLabel( wfMessage( 'recreate' )->text(), 'wpRecreate', 'wpRecreate', false,
2169 array( 'title' => Linker::titleAttrib( 'recreate' ), 'tabindex' => 1, 'id' => 'wpRecreate' )
2171 '</div>'
2175 # When the summary is hidden, also hide them on preview/show changes
2176 if ( $this->nosummary ) {
2177 $wgOut->addHTML( Html::hidden( 'nosummary', true ) );
2180 # If a blank edit summary was previously provided, and the appropriate
2181 # user preference is active, pass a hidden tag as wpIgnoreBlankSummary. This will stop the
2182 # user being bounced back more than once in the event that a summary
2183 # is not required.
2184 #####
2185 # For a bit more sophisticated detection of blank summaries, hash the
2186 # automatic one and pass that in the hidden field wpAutoSummary.
2187 if ( $this->missingSummary || ( $this->section == 'new' && $this->nosummary ) ) {
2188 $wgOut->addHTML( Html::hidden( 'wpIgnoreBlankSummary', true ) );
2191 if ( $this->undidRev ) {
2192 $wgOut->addHTML( Html::hidden( 'wpUndidRevision', $this->undidRev ) );
2195 if ( $this->hasPresetSummary ) {
2196 // If a summary has been preset using &summary= we don't want to prompt for
2197 // a different summary. Only prompt for a summary if the summary is blanked.
2198 // (Bug 17416)
2199 $this->autoSumm = md5( '' );
2202 $autosumm = $this->autoSumm ? $this->autoSumm : md5( $this->summary );
2203 $wgOut->addHTML( Html::hidden( 'wpAutoSummary', $autosumm ) );
2205 $wgOut->addHTML( Html::hidden( 'oldid', $this->oldid ) );
2207 $wgOut->addHTML( Html::hidden( 'format', $this->contentFormat ) );
2208 $wgOut->addHTML( Html::hidden( 'model', $this->contentModel ) );
2210 if ( $this->section == 'new' ) {
2211 $this->showSummaryInput( true, $this->summary );
2212 $wgOut->addHTML( $this->getSummaryPreview( true, $this->summary ) );
2215 $wgOut->addHTML( $this->editFormTextBeforeContent );
2217 if ( !$this->isCssJsSubpage && $showToolbar && $wgUser->getOption( 'showtoolbar' ) ) {
2218 $wgOut->addHTML( EditPage::getEditToolbar() );
2221 if ( $this->isConflict ) {
2222 // In an edit conflict bypass the overridable content form method
2223 // and fallback to the raw wpTextbox1 since editconflicts can't be
2224 // resolved between page source edits and custom ui edits using the
2225 // custom edit ui.
2226 $this->textbox2 = $this->textbox1;
2228 $content = $this->getCurrentContent();
2229 $this->textbox1 = $this->toEditText( $content );
2231 $this->showTextbox1();
2232 } else {
2233 $this->showContentForm();
2236 $wgOut->addHTML( $this->editFormTextAfterContent );
2238 $this->showStandardInputs();
2240 $this->showFormAfterText();
2242 $this->showTosSummary();
2244 $this->showEditTools();
2246 $wgOut->addHTML( $this->editFormTextAfterTools . "\n" );
2248 $wgOut->addHTML( Html::rawElement( 'div', array( 'class' => 'templatesUsed' ),
2249 Linker::formatTemplates( $this->getTemplates(), $this->preview, $this->section != '' ) ) );
2251 $wgOut->addHTML( Html::rawElement( 'div', array( 'class' => 'hiddencats' ),
2252 Linker::formatHiddenCategories( $this->mArticle->getHiddenCategories() ) ) );
2254 if ( $this->isConflict ) {
2255 try {
2256 $this->showConflict();
2257 } catch ( MWContentSerializationException $ex ) {
2258 // this can't really happen, but be nice if it does.
2259 $msg = wfMessage( 'content-failed-to-parse', $this->contentModel, $this->contentFormat, $ex->getMessage() );
2260 $wgOut->addWikiText( '<div class="error">' . $msg->text() . '</div>' );
2264 $wgOut->addHTML( $this->editFormTextBottom . "\n</form>\n" );
2266 if ( !$wgUser->getOption( 'previewontop' ) ) {
2267 $this->displayPreviewArea( $previewOutput, false );
2270 wfProfileOut( __METHOD__ );
2274 * Extract the section title from current section text, if any.
2276 * @param string $text
2277 * @return Mixed|string or false
2279 public static function extractSectionTitle( $text ) {
2280 preg_match( "/^(=+)(.+)\\1\\s*(\n|$)/i", $text, $matches );
2281 if ( !empty( $matches[2] ) ) {
2282 global $wgParser;
2283 return $wgParser->stripSectionName( trim( $matches[2] ) );
2284 } else {
2285 return false;
2289 protected function showHeader() {
2290 global $wgOut, $wgUser, $wgMaxArticleSize, $wgLang;
2292 if ( $this->mTitle->isTalkPage() ) {
2293 $wgOut->addWikiMsg( 'talkpagetext' );
2296 // Add edit notices
2297 $wgOut->addHTML( implode( "\n", $this->mTitle->getEditNotices() ) );
2299 if ( $this->isConflict ) {
2300 $wgOut->wrapWikiMsg( "<div class='mw-explainconflict'>\n$1\n</div>", 'explainconflict' );
2301 $this->edittime = $this->mArticle->getTimestamp();
2302 } else {
2303 if ( $this->section != '' && !$this->isSectionEditSupported() ) {
2304 // We use $this->section to much before this and getVal('wgSection') directly in other places
2305 // at this point we can't reset $this->section to '' to fallback to non-section editing.
2306 // Someone is welcome to try refactoring though
2307 $wgOut->showErrorPage( 'sectioneditnotsupported-title', 'sectioneditnotsupported-text' );
2308 return false;
2311 if ( $this->section != '' && $this->section != 'new' ) {
2312 if ( !$this->summary && !$this->preview && !$this->diff ) {
2313 $sectionTitle = self::extractSectionTitle( $this->textbox1 ); //FIXME: use Content object
2314 if ( $sectionTitle !== false ) {
2315 $this->summary = "/* $sectionTitle */ ";
2320 if ( $this->missingComment ) {
2321 $wgOut->wrapWikiMsg( "<div id='mw-missingcommenttext'>\n$1\n</div>", 'missingcommenttext' );
2324 if ( $this->missingSummary && $this->section != 'new' ) {
2325 $wgOut->wrapWikiMsg( "<div id='mw-missingsummary'>\n$1\n</div>", 'missingsummary' );
2328 if ( $this->missingSummary && $this->section == 'new' ) {
2329 $wgOut->wrapWikiMsg( "<div id='mw-missingcommentheader'>\n$1\n</div>", 'missingcommentheader' );
2332 if ( $this->hookError !== '' ) {
2333 $wgOut->addWikiText( $this->hookError );
2336 if ( !$this->checkUnicodeCompliantBrowser() ) {
2337 $wgOut->addWikiMsg( 'nonunicodebrowser' );
2340 if ( $this->section != 'new' ) {
2341 $revision = $this->mArticle->getRevisionFetched();
2342 if ( $revision ) {
2343 // Let sysop know that this will make private content public if saved
2345 if ( !$revision->userCan( Revision::DELETED_TEXT, $wgUser ) ) {
2346 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n", 'rev-deleted-text-permission' );
2347 } elseif ( $revision->isDeleted( Revision::DELETED_TEXT ) ) {
2348 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n", 'rev-deleted-text-view' );
2351 if ( !$revision->isCurrent() ) {
2352 $this->mArticle->setOldSubtitle( $revision->getId() );
2353 $wgOut->addWikiMsg( 'editingold' );
2355 } elseif ( $this->mTitle->exists() ) {
2356 // Something went wrong
2358 $wgOut->wrapWikiMsg( "<div class='errorbox'>\n$1\n</div>\n",
2359 array( 'missing-revision', $this->oldid ) );
2364 if ( wfReadOnly() ) {
2365 $wgOut->wrapWikiMsg( "<div id=\"mw-read-only-warning\">\n$1\n</div>", array( 'readonlywarning', wfReadOnlyReason() ) );
2366 } elseif ( $wgUser->isAnon() ) {
2367 if ( $this->formtype != 'preview' ) {
2368 $wgOut->wrapWikiMsg( "<div id=\"mw-anon-edit-warning\">\n$1</div>", 'anoneditwarning' );
2369 } else {
2370 $wgOut->wrapWikiMsg( "<div id=\"mw-anon-preview-warning\">\n$1</div>", 'anonpreviewwarning' );
2372 } else {
2373 if ( $this->isCssJsSubpage ) {
2374 # Check the skin exists
2375 if ( $this->isWrongCaseCssJsPage ) {
2376 $wgOut->wrapWikiMsg( "<div class='error' id='mw-userinvalidcssjstitle'>\n$1\n</div>", array( 'userinvalidcssjstitle', $this->mTitle->getSkinFromCssJsSubpage() ) );
2378 if ( $this->formtype !== 'preview' ) {
2379 if ( $this->isCssSubpage ) {
2380 $wgOut->wrapWikiMsg( "<div id='mw-usercssyoucanpreview'>\n$1\n</div>", array( 'usercssyoucanpreview' ) );
2383 if ( $this->isJsSubpage ) {
2384 $wgOut->wrapWikiMsg( "<div id='mw-userjsyoucanpreview'>\n$1\n</div>", array( 'userjsyoucanpreview' ) );
2390 if ( $this->mTitle->getNamespace() != NS_MEDIAWIKI && $this->mTitle->isProtected( 'edit' ) ) {
2391 # Is the title semi-protected?
2392 if ( $this->mTitle->isSemiProtected() ) {
2393 $noticeMsg = 'semiprotectedpagewarning';
2394 } else {
2395 # Then it must be protected based on static groups (regular)
2396 $noticeMsg = 'protectedpagewarning';
2398 LogEventsList::showLogExtract( $wgOut, 'protect', $this->mTitle, '',
2399 array( 'lim' => 1, 'msgKey' => array( $noticeMsg ) ) );
2401 if ( $this->mTitle->isCascadeProtected() ) {
2402 # Is this page under cascading protection from some source pages?
2403 list( $cascadeSources, /* $restrictions */ ) = $this->mTitle->getCascadeProtectionSources();
2404 $notice = "<div class='mw-cascadeprotectedwarning'>\n$1\n";
2405 $cascadeSourcesCount = count( $cascadeSources );
2406 if ( $cascadeSourcesCount > 0 ) {
2407 # Explain, and list the titles responsible
2408 foreach ( $cascadeSources as $page ) {
2409 $notice .= '* [[:' . $page->getPrefixedText() . "]]\n";
2412 $notice .= '</div>';
2413 $wgOut->wrapWikiMsg( $notice, array( 'cascadeprotectedwarning', $cascadeSourcesCount ) );
2415 if ( !$this->mTitle->exists() && $this->mTitle->getRestrictions( 'create' ) ) {
2416 LogEventsList::showLogExtract( $wgOut, 'protect', $this->mTitle, '',
2417 array( 'lim' => 1,
2418 'showIfEmpty' => false,
2419 'msgKey' => array( 'titleprotectedwarning' ),
2420 'wrap' => "<div class=\"mw-titleprotectedwarning\">\n$1</div>" ) );
2423 if ( $this->kblength === false ) {
2424 $this->kblength = (int)( strlen( $this->textbox1 ) / 1024 );
2427 if ( $this->tooBig || $this->kblength > $wgMaxArticleSize ) {
2428 $wgOut->wrapWikiMsg( "<div class='error' id='mw-edit-longpageerror'>\n$1\n</div>",
2429 array( 'longpageerror', $wgLang->formatNum( $this->kblength ), $wgLang->formatNum( $wgMaxArticleSize ) ) );
2430 } else {
2431 if ( !wfMessage( 'longpage-hint' )->isDisabled() ) {
2432 $wgOut->wrapWikiMsg( "<div id='mw-edit-longpage-hint'>\n$1\n</div>",
2433 array( 'longpage-hint', $wgLang->formatSize( strlen( $this->textbox1 ) ), strlen( $this->textbox1 ) )
2437 # Add header copyright warning
2438 $this->showHeaderCopyrightWarning();
2442 * Standard summary input and label (wgSummary), abstracted so EditPage
2443 * subclasses may reorganize the form.
2444 * Note that you do not need to worry about the label's for=, it will be
2445 * inferred by the id given to the input. You can remove them both by
2446 * passing array( 'id' => false ) to $userInputAttrs.
2448 * @param string $summary The value of the summary input
2449 * @param string $labelText The html to place inside the label
2450 * @param array $inputAttrs of attrs to use on the input
2451 * @param array $spanLabelAttrs of attrs to use on the span inside the label
2453 * @return array An array in the format array( $label, $input )
2455 function getSummaryInput( $summary = "", $labelText = null, $inputAttrs = null, $spanLabelAttrs = null ) {
2456 // Note: the maxlength is overridden in JS to 255 and to make it use UTF-8 bytes, not characters.
2457 $inputAttrs = ( is_array( $inputAttrs ) ? $inputAttrs : array() ) + array(
2458 'id' => 'wpSummary',
2459 'maxlength' => '200',
2460 'tabindex' => '1',
2461 'size' => 60,
2462 'spellcheck' => 'true',
2463 ) + Linker::tooltipAndAccesskeyAttribs( 'summary' );
2465 $spanLabelAttrs = ( is_array( $spanLabelAttrs ) ? $spanLabelAttrs : array() ) + array(
2466 'class' => $this->missingSummary ? 'mw-summarymissed' : 'mw-summary',
2467 'id' => "wpSummaryLabel"
2470 $label = null;
2471 if ( $labelText ) {
2472 $label = Xml::tags( 'label', $inputAttrs['id'] ? array( 'for' => $inputAttrs['id'] ) : null, $labelText );
2473 $label = Xml::tags( 'span', $spanLabelAttrs, $label );
2476 $input = Html::input( 'wpSummary', $summary, 'text', $inputAttrs );
2478 return array( $label, $input );
2482 * @param $isSubjectPreview Boolean: true if this is the section subject/title
2483 * up top, or false if this is the comment summary
2484 * down below the textarea
2485 * @param string $summary The text of the summary to display
2486 * @return String
2488 protected function showSummaryInput( $isSubjectPreview, $summary = "" ) {
2489 global $wgOut, $wgContLang;
2490 # Add a class if 'missingsummary' is triggered to allow styling of the summary line
2491 $summaryClass = $this->missingSummary ? 'mw-summarymissed' : 'mw-summary';
2492 if ( $isSubjectPreview ) {
2493 if ( $this->nosummary ) {
2494 return;
2496 } else {
2497 if ( !$this->mShowSummaryField ) {
2498 return;
2501 $summary = $wgContLang->recodeForEdit( $summary );
2502 $labelText = wfMessage( $isSubjectPreview ? 'subject' : 'summary' )->parse();
2503 list( $label, $input ) = $this->getSummaryInput( $summary, $labelText, array( 'class' => $summaryClass ), array() );
2504 $wgOut->addHTML( "{$label} {$input}" );
2508 * @param $isSubjectPreview Boolean: true if this is the section subject/title
2509 * up top, or false if this is the comment summary
2510 * down below the textarea
2511 * @param string $summary the text of the summary to display
2512 * @return String
2514 protected function getSummaryPreview( $isSubjectPreview, $summary = "" ) {
2515 // avoid spaces in preview, gets always trimmed on save
2516 $summary = trim( $summary );
2517 if ( !$summary || ( !$this->preview && !$this->diff ) ) {
2518 return "";
2521 global $wgParser;
2523 if ( $isSubjectPreview ) {
2524 $summary = wfMessage( 'newsectionsummary', $wgParser->stripSectionName( $summary ) )
2525 ->inContentLanguage()->text();
2528 $message = $isSubjectPreview ? 'subject-preview' : 'summary-preview';
2530 $summary = wfMessage( $message )->parse() . Linker::commentBlock( $summary, $this->mTitle, $isSubjectPreview );
2531 return Xml::tags( 'div', array( 'class' => 'mw-summary-preview' ), $summary );
2534 protected function showFormBeforeText() {
2535 global $wgOut;
2536 $section = htmlspecialchars( $this->section );
2537 $wgOut->addHTML( <<<HTML
2538 <input type='hidden' value="{$section}" name="wpSection" />
2539 <input type='hidden' value="{$this->starttime}" name="wpStarttime" />
2540 <input type='hidden' value="{$this->edittime}" name="wpEdittime" />
2541 <input type='hidden' value="{$this->scrolltop}" name="wpScrolltop" id="wpScrolltop" />
2543 HTML
2545 if ( !$this->checkUnicodeCompliantBrowser() ) {
2546 $wgOut->addHTML( Html::hidden( 'safemode', '1' ) );
2550 protected function showFormAfterText() {
2551 global $wgOut, $wgUser;
2553 * To make it harder for someone to slip a user a page
2554 * which submits an edit form to the wiki without their
2555 * knowledge, a random token is associated with the login
2556 * session. If it's not passed back with the submission,
2557 * we won't save the page, or render user JavaScript and
2558 * CSS previews.
2560 * For anon editors, who may not have a session, we just
2561 * include the constant suffix to prevent editing from
2562 * broken text-mangling proxies.
2564 $wgOut->addHTML( "\n" . Html::hidden( "wpEditToken", $wgUser->getEditToken() ) . "\n" );
2568 * Subpage overridable method for printing the form for page content editing
2569 * By default this simply outputs wpTextbox1
2570 * Subclasses can override this to provide a custom UI for editing;
2571 * be it a form, or simply wpTextbox1 with a modified content that will be
2572 * reverse modified when extracted from the post data.
2573 * Note that this is basically the inverse for importContentFormData
2575 protected function showContentForm() {
2576 $this->showTextbox1();
2580 * Method to output wpTextbox1
2581 * The $textoverride method can be used by subclasses overriding showContentForm
2582 * to pass back to this method.
2584 * @param array $customAttribs of html attributes to use in the textarea
2585 * @param string $textoverride optional text to override $this->textarea1 with
2587 protected function showTextbox1( $customAttribs = null, $textoverride = null ) {
2588 if ( $this->wasDeletedSinceLastEdit() && $this->formtype == 'save' ) {
2589 $attribs = array( 'style' => 'display:none;' );
2590 } else {
2591 $classes = array(); // Textarea CSS
2592 if ( $this->mTitle->getNamespace() != NS_MEDIAWIKI && $this->mTitle->isProtected( 'edit' ) ) {
2593 # Is the title semi-protected?
2594 if ( $this->mTitle->isSemiProtected() ) {
2595 $classes[] = 'mw-textarea-sprotected';
2596 } else {
2597 # Then it must be protected based on static groups (regular)
2598 $classes[] = 'mw-textarea-protected';
2600 # Is the title cascade-protected?
2601 if ( $this->mTitle->isCascadeProtected() ) {
2602 $classes[] = 'mw-textarea-cprotected';
2606 $attribs = array( 'tabindex' => 1 );
2608 if ( is_array( $customAttribs ) ) {
2609 $attribs += $customAttribs;
2612 if ( count( $classes ) ) {
2613 if ( isset( $attribs['class'] ) ) {
2614 $classes[] = $attribs['class'];
2616 $attribs['class'] = implode( ' ', $classes );
2620 $this->showTextbox( $textoverride !== null ? $textoverride : $this->textbox1, 'wpTextbox1', $attribs );
2623 protected function showTextbox2() {
2624 $this->showTextbox( $this->textbox2, 'wpTextbox2', array( 'tabindex' => 6, 'readonly' ) );
2627 protected function showTextbox( $text, $name, $customAttribs = array() ) {
2628 global $wgOut, $wgUser;
2630 $wikitext = $this->safeUnicodeOutput( $text );
2631 if ( strval( $wikitext ) !== '' ) {
2632 // Ensure there's a newline at the end, otherwise adding lines
2633 // is awkward.
2634 // But don't add a newline if the ext is empty, or Firefox in XHTML
2635 // mode will show an extra newline. A bit annoying.
2636 $wikitext .= "\n";
2639 $attribs = $customAttribs + array(
2640 'accesskey' => ',',
2641 'id' => $name,
2642 'cols' => $wgUser->getIntOption( 'cols' ),
2643 'rows' => $wgUser->getIntOption( 'rows' ),
2644 'style' => '' // avoid php notices when appending preferences (appending allows customAttribs['style'] to still work
2647 $pageLang = $this->mTitle->getPageLanguage();
2648 $attribs['lang'] = $pageLang->getCode();
2649 $attribs['dir'] = $pageLang->getDir();
2651 $wgOut->addHTML( Html::textarea( $name, $wikitext, $attribs ) );
2654 protected function displayPreviewArea( $previewOutput, $isOnTop = false ) {
2655 global $wgOut;
2656 $classes = array();
2657 if ( $isOnTop ) {
2658 $classes[] = 'ontop';
2661 $attribs = array( 'id' => 'wikiPreview', 'class' => implode( ' ', $classes ) );
2663 if ( $this->formtype != 'preview' ) {
2664 $attribs['style'] = 'display: none;';
2667 $wgOut->addHTML( Xml::openElement( 'div', $attribs ) );
2669 if ( $this->formtype == 'preview' ) {
2670 $this->showPreview( $previewOutput );
2673 $wgOut->addHTML( '</div>' );
2675 if ( $this->formtype == 'diff' ) {
2676 try {
2677 $this->showDiff();
2678 } catch ( MWContentSerializationException $ex ) {
2679 $msg = wfMessage( 'content-failed-to-parse', $this->contentModel, $this->contentFormat, $ex->getMessage() );
2680 $wgOut->addWikiText( '<div class="error">' . $msg->text() . '</div>' );
2686 * Append preview output to $wgOut.
2687 * Includes category rendering if this is a category page.
2689 * @param string $text the HTML to be output for the preview.
2691 protected function showPreview( $text ) {
2692 global $wgOut;
2693 if ( $this->mTitle->getNamespace() == NS_CATEGORY ) {
2694 $this->mArticle->openShowCategory();
2696 # This hook seems slightly odd here, but makes things more
2697 # consistent for extensions.
2698 wfRunHooks( 'OutputPageBeforeHTML', array( &$wgOut, &$text ) );
2699 $wgOut->addHTML( $text );
2700 if ( $this->mTitle->getNamespace() == NS_CATEGORY ) {
2701 $this->mArticle->closeShowCategory();
2706 * Get a diff between the current contents of the edit box and the
2707 * version of the page we're editing from.
2709 * If this is a section edit, we'll replace the section as for final
2710 * save and then make a comparison.
2712 function showDiff() {
2713 global $wgUser, $wgContLang, $wgOut;
2715 $oldtitlemsg = 'currentrev';
2716 # if message does not exist, show diff against the preloaded default
2717 if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI && !$this->mTitle->exists() ) {
2718 $oldtext = $this->mTitle->getDefaultMessageText();
2719 if ( $oldtext !== false ) {
2720 $oldtitlemsg = 'defaultmessagetext';
2721 $oldContent = $this->toEditContent( $oldtext );
2722 } else {
2723 $oldContent = null;
2725 } else {
2726 $oldContent = $this->getCurrentContent();
2729 $textboxContent = $this->toEditContent( $this->textbox1 );
2731 $newContent = $this->mArticle->replaceSectionContent(
2732 $this->section, $textboxContent,
2733 $this->summary, $this->edittime );
2735 if ( $newContent ) {
2736 ContentHandler::runLegacyHooks( 'EditPageGetDiffText', array( $this, &$newContent ) );
2737 wfRunHooks( 'EditPageGetDiffContent', array( $this, &$newContent ) );
2739 $popts = ParserOptions::newFromUserAndLang( $wgUser, $wgContLang );
2740 $newContent = $newContent->preSaveTransform( $this->mTitle, $wgUser, $popts );
2743 if ( ( $oldContent && !$oldContent->isEmpty() ) || ( $newContent && !$newContent->isEmpty() ) ) {
2744 $oldtitle = wfMessage( $oldtitlemsg )->parse();
2745 $newtitle = wfMessage( 'yourtext' )->parse();
2747 if ( !$oldContent ) {
2748 $oldContent = $newContent->getContentHandler()->makeEmptyContent();
2751 if ( !$newContent ) {
2752 $newContent = $oldContent->getContentHandler()->makeEmptyContent();
2755 $de = $oldContent->getContentHandler()->createDifferenceEngine( $this->mArticle->getContext() );
2756 $de->setContent( $oldContent, $newContent );
2758 $difftext = $de->getDiff( $oldtitle, $newtitle );
2759 $de->showDiffStyle();
2760 } else {
2761 $difftext = '';
2764 $wgOut->addHTML( '<div id="wikiDiff">' . $difftext . '</div>' );
2768 * Show the header copyright warning.
2770 protected function showHeaderCopyrightWarning() {
2771 $msg = 'editpage-head-copy-warn';
2772 if ( !wfMessage( $msg )->isDisabled() ) {
2773 global $wgOut;
2774 $wgOut->wrapWikiMsg( "<div class='editpage-head-copywarn'>\n$1\n</div>",
2775 'editpage-head-copy-warn' );
2780 * Give a chance for site and per-namespace customizations of
2781 * terms of service summary link that might exist separately
2782 * from the copyright notice.
2784 * This will display between the save button and the edit tools,
2785 * so should remain short!
2787 protected function showTosSummary() {
2788 $msg = 'editpage-tos-summary';
2789 wfRunHooks( 'EditPageTosSummary', array( $this->mTitle, &$msg ) );
2790 if ( !wfMessage( $msg )->isDisabled() ) {
2791 global $wgOut;
2792 $wgOut->addHTML( '<div class="mw-tos-summary">' );
2793 $wgOut->addWikiMsg( $msg );
2794 $wgOut->addHTML( '</div>' );
2798 protected function showEditTools() {
2799 global $wgOut;
2800 $wgOut->addHTML( '<div class="mw-editTools">' .
2801 wfMessage( 'edittools' )->inContentLanguage()->parse() .
2802 '</div>' );
2806 * Get the copyright warning
2808 * Renamed to getCopyrightWarning(), old name kept around for backwards compatibility
2810 protected function getCopywarn() {
2811 return self::getCopyrightWarning( $this->mTitle );
2814 public static function getCopyrightWarning( $title ) {
2815 global $wgRightsText;
2816 if ( $wgRightsText ) {
2817 $copywarnMsg = array( 'copyrightwarning',
2818 '[[' . wfMessage( 'copyrightpage' )->inContentLanguage()->text() . ']]',
2819 $wgRightsText );
2820 } else {
2821 $copywarnMsg = array( 'copyrightwarning2',
2822 '[[' . wfMessage( 'copyrightpage' )->inContentLanguage()->text() . ']]' );
2824 // Allow for site and per-namespace customization of contribution/copyright notice.
2825 wfRunHooks( 'EditPageCopyrightWarning', array( $title, &$copywarnMsg ) );
2827 return "<div id=\"editpage-copywarn\">\n" .
2828 call_user_func_array( 'wfMessage', $copywarnMsg )->plain() . "\n</div>";
2831 protected function showStandardInputs( &$tabindex = 2 ) {
2832 global $wgOut;
2833 $wgOut->addHTML( "<div class='editOptions'>\n" );
2835 if ( $this->section != 'new' ) {
2836 $this->showSummaryInput( false, $this->summary );
2837 $wgOut->addHTML( $this->getSummaryPreview( false, $this->summary ) );
2840 $checkboxes = $this->getCheckboxes( $tabindex,
2841 array( 'minor' => $this->minoredit, 'watch' => $this->watchthis ) );
2842 $wgOut->addHTML( "<div class='editCheckboxes'>" . implode( $checkboxes, "\n" ) . "</div>\n" );
2844 // Show copyright warning.
2845 $wgOut->addWikiText( $this->getCopywarn() );
2846 $wgOut->addHTML( $this->editFormTextAfterWarn );
2848 $wgOut->addHTML( "<div class='editButtons'>\n" );
2849 $wgOut->addHTML( implode( $this->getEditButtons( $tabindex ), "\n" ) . "\n" );
2851 $cancel = $this->getCancelLink();
2852 if ( $cancel !== '' ) {
2853 $cancel .= wfMessage( 'pipe-separator' )->text();
2855 $edithelpurl = Skin::makeInternalOrExternalUrl( wfMessage( 'edithelppage' )->inContentLanguage()->text() );
2856 $edithelp = '<a target="helpwindow" href="' . $edithelpurl . '">' .
2857 wfMessage( 'edithelp' )->escaped() . '</a> ' .
2858 wfMessage( 'newwindow' )->parse();
2859 $wgOut->addHTML( " <span class='cancelLink'>{$cancel}</span>\n" );
2860 $wgOut->addHTML( " <span class='editHelp'>{$edithelp}</span>\n" );
2861 $wgOut->addHTML( "</div><!-- editButtons -->\n" );
2862 wfRunHooks( 'EditPage::showStandardInputs:options', array( $this, $wgOut, &$tabindex ) );
2863 $wgOut->addHTML( "</div><!-- editOptions -->\n" );
2867 * Show an edit conflict. textbox1 is already shown in showEditForm().
2868 * If you want to use another entry point to this function, be careful.
2870 protected function showConflict() {
2871 global $wgOut;
2873 if ( wfRunHooks( 'EditPageBeforeConflictDiff', array( &$this, &$wgOut ) ) ) {
2874 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
2876 $content1 = $this->toEditContent( $this->textbox1 );
2877 $content2 = $this->toEditContent( $this->textbox2 );
2879 $handler = ContentHandler::getForModelID( $this->contentModel );
2880 $de = $handler->createDifferenceEngine( $this->mArticle->getContext() );
2881 $de->setContent( $content2, $content1 );
2882 $de->showDiff(
2883 wfMessage( 'yourtext' )->parse(),
2884 wfMessage( 'storedversion' )->text()
2887 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
2888 $this->showTextbox2();
2893 * @return string
2895 public function getCancelLink() {
2896 $cancelParams = array();
2897 if ( !$this->isConflict && $this->oldid > 0 ) {
2898 $cancelParams['oldid'] = $this->oldid;
2901 return Linker::linkKnown(
2902 $this->getContextTitle(),
2903 wfMessage( 'cancel' )->parse(),
2904 array( 'id' => 'mw-editform-cancel' ),
2905 $cancelParams
2910 * Returns the URL to use in the form's action attribute.
2911 * This is used by EditPage subclasses when simply customizing the action
2912 * variable in the constructor is not enough. This can be used when the
2913 * EditPage lives inside of a Special page rather than a custom page action.
2915 * @param $title Title object for which is being edited (where we go to for &action= links)
2916 * @return string
2918 protected function getActionURL( Title $title ) {
2919 return $title->getLocalURL( array( 'action' => $this->action ) );
2923 * Check if a page was deleted while the user was editing it, before submit.
2924 * Note that we rely on the logging table, which hasn't been always there,
2925 * but that doesn't matter, because this only applies to brand new
2926 * deletes.
2928 protected function wasDeletedSinceLastEdit() {
2929 if ( $this->deletedSinceEdit !== null ) {
2930 return $this->deletedSinceEdit;
2933 $this->deletedSinceEdit = false;
2935 if ( $this->mTitle->isDeletedQuick() ) {
2936 $this->lastDelete = $this->getLastDelete();
2937 if ( $this->lastDelete ) {
2938 $deleteTime = wfTimestamp( TS_MW, $this->lastDelete->log_timestamp );
2939 if ( $deleteTime > $this->starttime ) {
2940 $this->deletedSinceEdit = true;
2945 return $this->deletedSinceEdit;
2948 protected function getLastDelete() {
2949 $dbr = wfGetDB( DB_SLAVE );
2950 $data = $dbr->selectRow(
2951 array( 'logging', 'user' ),
2952 array(
2953 'log_type',
2954 'log_action',
2955 'log_timestamp',
2956 'log_user',
2957 'log_namespace',
2958 'log_title',
2959 'log_comment',
2960 'log_params',
2961 'log_deleted',
2962 'user_name'
2963 ), array(
2964 'log_namespace' => $this->mTitle->getNamespace(),
2965 'log_title' => $this->mTitle->getDBkey(),
2966 'log_type' => 'delete',
2967 'log_action' => 'delete',
2968 'user_id=log_user'
2970 __METHOD__,
2971 array( 'LIMIT' => 1, 'ORDER BY' => 'log_timestamp DESC' )
2973 // Quick paranoid permission checks...
2974 if ( is_object( $data ) ) {
2975 if ( $data->log_deleted & LogPage::DELETED_USER ) {
2976 $data->user_name = wfMessage( 'rev-deleted-user' )->escaped();
2979 if ( $data->log_deleted & LogPage::DELETED_COMMENT ) {
2980 $data->log_comment = wfMessage( 'rev-deleted-comment' )->escaped();
2983 return $data;
2987 * Get the rendered text for previewing.
2988 * @throws MWException
2989 * @return string
2991 function getPreviewText() {
2992 global $wgOut, $wgUser, $wgRawHtml, $wgLang;
2994 wfProfileIn( __METHOD__ );
2996 if ( $wgRawHtml && !$this->mTokenOk ) {
2997 // Could be an offsite preview attempt. This is very unsafe if
2998 // HTML is enabled, as it could be an attack.
2999 $parsedNote = '';
3000 if ( $this->textbox1 !== '' ) {
3001 // Do not put big scary notice, if previewing the empty
3002 // string, which happens when you initially edit
3003 // a category page, due to automatic preview-on-open.
3004 $parsedNote = $wgOut->parse( "<div class='previewnote'>" .
3005 wfMessage( 'session_fail_preview_html' )->text() . "</div>", true, /* interface */true );
3007 wfProfileOut( __METHOD__ );
3008 return $parsedNote;
3011 $note = '';
3013 try {
3014 $content = $this->toEditContent( $this->textbox1 );
3016 $previewHTML = '';
3017 if ( !wfRunHooks( 'AlternateEditPreview', array( $this, &$content, &$previewHTML, &$this->mParserOutput ) ) ) {
3018 wfProfileOut( __METHOD__ );
3019 return $previewHTML;
3022 if ( $this->mTriedSave && !$this->mTokenOk ) {
3023 if ( $this->mTokenOkExceptSuffix ) {
3024 $note = wfMessage( 'token_suffix_mismatch' )->plain();
3026 } else {
3027 $note = wfMessage( 'session_fail_preview' )->plain();
3029 } elseif ( $this->incompleteForm ) {
3030 $note = wfMessage( 'edit_form_incomplete' )->plain();
3031 } else {
3032 $note = wfMessage( 'previewnote' )->plain() .
3033 ' [[#' . self::EDITFORM_ID . '|' . $wgLang->getArrow() . ' ' . wfMessage( 'continue-editing' )->text() . ']]';
3036 $parserOptions = $this->mArticle->makeParserOptions( $this->mArticle->getContext() );
3037 $parserOptions->setEditSection( false );
3038 $parserOptions->setIsPreview( true );
3039 $parserOptions->setIsSectionPreview( !is_null( $this->section ) && $this->section !== '' );
3041 # don't parse non-wikitext pages, show message about preview
3042 if ( $this->mTitle->isCssJsSubpage() || $this->mTitle->isCssOrJsPage() ) {
3043 if ( $this->mTitle->isCssJsSubpage() ) {
3044 $level = 'user';
3045 } elseif ( $this->mTitle->isCssOrJsPage() ) {
3046 $level = 'site';
3047 } else {
3048 $level = false;
3051 if ( $content->getModel() == CONTENT_MODEL_CSS ) {
3052 $format = 'css';
3053 } elseif ( $content->getModel() == CONTENT_MODEL_JAVASCRIPT ) {
3054 $format = 'js';
3055 } else {
3056 $format = false;
3059 # Used messages to make sure grep find them:
3060 # Messages: usercsspreview, userjspreview, sitecsspreview, sitejspreview
3061 if ( $level && $format ) {
3062 $note = "<div id='mw-{$level}{$format}preview'>" . wfMessage( "{$level}{$format}preview" )->text() . "</div>";
3066 $rt = $content->getRedirectChain();
3067 if ( $rt ) {
3068 $previewHTML = $this->mArticle->viewRedirect( $rt, false );
3069 } else {
3071 # If we're adding a comment, we need to show the
3072 # summary as the headline
3073 if ( $this->section === "new" && $this->summary !== "" ) {
3074 $content = $content->addSectionHeader( $this->summary );
3077 $hook_args = array( $this, &$content );
3078 ContentHandler::runLegacyHooks( 'EditPageGetPreviewText', $hook_args );
3079 wfRunHooks( 'EditPageGetPreviewContent', $hook_args );
3081 $parserOptions->enableLimitReport();
3083 # For CSS/JS pages, we should have called the ShowRawCssJs hook here.
3084 # But it's now deprecated, so never mind
3086 $content = $content->preSaveTransform( $this->mTitle, $wgUser, $parserOptions );
3087 $parserOutput = $content->getParserOutput( $this->getArticle()->getTitle(), null, $parserOptions );
3089 $previewHTML = $parserOutput->getText();
3090 $this->mParserOutput = $parserOutput;
3091 $wgOut->addParserOutputNoText( $parserOutput );
3093 if ( count( $parserOutput->getWarnings() ) ) {
3094 $note .= "\n\n" . implode( "\n\n", $parserOutput->getWarnings() );
3097 } catch ( MWContentSerializationException $ex ) {
3098 $m = wfMessage( 'content-failed-to-parse', $this->contentModel, $this->contentFormat, $ex->getMessage() );
3099 $note .= "\n\n" . $m->parse();
3100 $previewHTML = '';
3103 if ( $this->isConflict ) {
3104 $conflict = '<h2 id="mw-previewconflict">' . wfMessage( 'previewconflict' )->escaped() . "</h2>\n";
3105 } else {
3106 $conflict = '<hr />';
3109 $previewhead = "<div class='previewnote'>\n" .
3110 '<h2 id="mw-previewheader">' . wfMessage( 'preview' )->escaped() . "</h2>" .
3111 $wgOut->parse( $note, true, /* interface */true ) . $conflict . "</div>\n";
3113 $pageLang = $this->mTitle->getPageLanguage();
3114 $attribs = array( 'lang' => $pageLang->getCode(), 'dir' => $pageLang->getDir(),
3115 'class' => 'mw-content-' . $pageLang->getDir() );
3116 $previewHTML = Html::rawElement( 'div', $attribs, $previewHTML );
3118 wfProfileOut( __METHOD__ );
3119 return $previewhead . $previewHTML . $this->previewTextAfterContent;
3123 * @return Array
3125 function getTemplates() {
3126 if ( $this->preview || $this->section != '' ) {
3127 $templates = array();
3128 if ( !isset( $this->mParserOutput ) ) {
3129 return $templates;
3131 foreach ( $this->mParserOutput->getTemplates() as $ns => $template ) {
3132 foreach ( array_keys( $template ) as $dbk ) {
3133 $templates[] = Title::makeTitle( $ns, $dbk );
3136 return $templates;
3137 } else {
3138 return $this->mTitle->getTemplateLinksFrom();
3143 * Shows a bulletin board style toolbar for common editing functions.
3144 * It can be disabled in the user preferences.
3145 * The necessary JavaScript code can be found in skins/common/edit.js.
3147 * @return string
3149 static function getEditToolbar() {
3150 global $wgStylePath, $wgContLang, $wgLang, $wgOut;
3151 global $wgUseTeX, $wgEnableUploads, $wgForeignFileRepos;
3153 $imagesAvailable = $wgEnableUploads || count( $wgForeignFileRepos );
3156 * $toolarray is an array of arrays each of which includes the
3157 * filename of the button image (without path), the opening
3158 * tag, the closing tag, optionally a sample text that is
3159 * inserted between the two when no selection is highlighted
3160 * and. The tip text is shown when the user moves the mouse
3161 * over the button.
3163 * Also here: accesskeys (key), which are not used yet until
3164 * someone can figure out a way to make them work in
3165 * IE. However, we should make sure these keys are not defined
3166 * on the edit page.
3168 $toolarray = array(
3169 array(
3170 'image' => $wgLang->getImageFile( 'button-bold' ),
3171 'id' => 'mw-editbutton-bold',
3172 'open' => '\'\'\'',
3173 'close' => '\'\'\'',
3174 'sample' => wfMessage( 'bold_sample' )->text(),
3175 'tip' => wfMessage( 'bold_tip' )->text(),
3176 'key' => 'B'
3178 array(
3179 'image' => $wgLang->getImageFile( 'button-italic' ),
3180 'id' => 'mw-editbutton-italic',
3181 'open' => '\'\'',
3182 'close' => '\'\'',
3183 'sample' => wfMessage( 'italic_sample' )->text(),
3184 'tip' => wfMessage( 'italic_tip' )->text(),
3185 'key' => 'I'
3187 array(
3188 'image' => $wgLang->getImageFile( 'button-link' ),
3189 'id' => 'mw-editbutton-link',
3190 'open' => '[[',
3191 'close' => ']]',
3192 'sample' => wfMessage( 'link_sample' )->text(),
3193 'tip' => wfMessage( 'link_tip' )->text(),
3194 'key' => 'L'
3196 array(
3197 'image' => $wgLang->getImageFile( 'button-extlink' ),
3198 'id' => 'mw-editbutton-extlink',
3199 'open' => '[',
3200 'close' => ']',
3201 'sample' => wfMessage( 'extlink_sample' )->text(),
3202 'tip' => wfMessage( 'extlink_tip' )->text(),
3203 'key' => 'X'
3205 array(
3206 'image' => $wgLang->getImageFile( 'button-headline' ),
3207 'id' => 'mw-editbutton-headline',
3208 'open' => "\n== ",
3209 'close' => " ==\n",
3210 'sample' => wfMessage( 'headline_sample' )->text(),
3211 'tip' => wfMessage( 'headline_tip' )->text(),
3212 'key' => 'H'
3214 $imagesAvailable ? array(
3215 'image' => $wgLang->getImageFile( 'button-image' ),
3216 'id' => 'mw-editbutton-image',
3217 'open' => '[[' . $wgContLang->getNsText( NS_FILE ) . ':',
3218 'close' => ']]',
3219 'sample' => wfMessage( 'image_sample' )->text(),
3220 'tip' => wfMessage( 'image_tip' )->text(),
3221 'key' => 'D',
3222 ) : false,
3223 $imagesAvailable ? array(
3224 'image' => $wgLang->getImageFile( 'button-media' ),
3225 'id' => 'mw-editbutton-media',
3226 'open' => '[[' . $wgContLang->getNsText( NS_MEDIA ) . ':',
3227 'close' => ']]',
3228 'sample' => wfMessage( 'media_sample' )->text(),
3229 'tip' => wfMessage( 'media_tip' )->text(),
3230 'key' => 'M'
3231 ) : false,
3232 $wgUseTeX ? array(
3233 'image' => $wgLang->getImageFile( 'button-math' ),
3234 'id' => 'mw-editbutton-math',
3235 'open' => "<math>",
3236 'close' => "</math>",
3237 'sample' => wfMessage( 'math_sample' )->text(),
3238 'tip' => wfMessage( 'math_tip' )->text(),
3239 'key' => 'C'
3240 ) : false,
3241 array(
3242 'image' => $wgLang->getImageFile( 'button-nowiki' ),
3243 'id' => 'mw-editbutton-nowiki',
3244 'open' => "<nowiki>",
3245 'close' => "</nowiki>",
3246 'sample' => wfMessage( 'nowiki_sample' )->text(),
3247 'tip' => wfMessage( 'nowiki_tip' )->text(),
3248 'key' => 'N'
3250 array(
3251 'image' => $wgLang->getImageFile( 'button-sig' ),
3252 'id' => 'mw-editbutton-signature',
3253 'open' => '--~~~~',
3254 'close' => '',
3255 'sample' => '',
3256 'tip' => wfMessage( 'sig_tip' )->text(),
3257 'key' => 'Y'
3259 array(
3260 'image' => $wgLang->getImageFile( 'button-hr' ),
3261 'id' => 'mw-editbutton-hr',
3262 'open' => "\n----\n",
3263 'close' => '',
3264 'sample' => '',
3265 'tip' => wfMessage( 'hr_tip' )->text(),
3266 'key' => 'R'
3270 $script = 'mw.loader.using("mediawiki.action.edit", function() {';
3271 foreach ( $toolarray as $tool ) {
3272 if ( !$tool ) {
3273 continue;
3276 $params = array(
3277 $image = $wgStylePath . '/common/images/' . $tool['image'],
3278 // Note that we use the tip both for the ALT tag and the TITLE tag of the image.
3279 // Older browsers show a "speedtip" type message only for ALT.
3280 // Ideally these should be different, realistically they
3281 // probably don't need to be.
3282 $tip = $tool['tip'],
3283 $open = $tool['open'],
3284 $close = $tool['close'],
3285 $sample = $tool['sample'],
3286 $cssId = $tool['id'],
3289 $script .= Xml::encodeJsCall( 'mw.toolbar.addButton', $params );
3292 // This used to be called on DOMReady from mediawiki.action.edit, which
3293 // ended up causing race conditions with the setup code above.
3294 $script .= "\n" .
3295 "// Create button bar\n" .
3296 "$(function() { mw.toolbar.init(); } );\n";
3298 $script .= '});';
3299 $wgOut->addScript( Html::inlineScript( ResourceLoader::makeLoaderConditionalScript( $script ) ) );
3301 $toolbar = '<div id="toolbar"></div>';
3303 wfRunHooks( 'EditPageBeforeEditToolbar', array( &$toolbar ) );
3305 return $toolbar;
3309 * Returns an array of html code of the following checkboxes:
3310 * minor and watch
3312 * @param int $tabindex Current tabindex
3313 * @param array $checked of checkbox => bool, where bool indicates the checked
3314 * status of the checkbox
3316 * @return array
3318 public function getCheckboxes( &$tabindex, $checked ) {
3319 global $wgUser;
3321 $checkboxes = array();
3323 // don't show the minor edit checkbox if it's a new page or section
3324 if ( !$this->isNew ) {
3325 $checkboxes['minor'] = '';
3326 $minorLabel = wfMessage( 'minoredit' )->parse();
3327 if ( $wgUser->isAllowed( 'minoredit' ) ) {
3328 $attribs = array(
3329 'tabindex' => ++$tabindex,
3330 'accesskey' => wfMessage( 'accesskey-minoredit' )->text(),
3331 'id' => 'wpMinoredit',
3333 $checkboxes['minor'] =
3334 Xml::check( 'wpMinoredit', $checked['minor'], $attribs ) .
3335 "&#160;<label for='wpMinoredit' id='mw-editpage-minoredit'" .
3336 Xml::expandAttributes( array( 'title' => Linker::titleAttrib( 'minoredit', 'withaccess' ) ) ) .
3337 ">{$minorLabel}</label>";
3341 $watchLabel = wfMessage( 'watchthis' )->parse();
3342 $checkboxes['watch'] = '';
3343 if ( $wgUser->isLoggedIn() ) {
3344 $attribs = array(
3345 'tabindex' => ++$tabindex,
3346 'accesskey' => wfMessage( 'accesskey-watch' )->text(),
3347 'id' => 'wpWatchthis',
3349 $checkboxes['watch'] =
3350 Xml::check( 'wpWatchthis', $checked['watch'], $attribs ) .
3351 "&#160;<label for='wpWatchthis' id='mw-editpage-watch'" .
3352 Xml::expandAttributes( array( 'title' => Linker::titleAttrib( 'watch', 'withaccess' ) ) ) .
3353 ">{$watchLabel}</label>";
3355 wfRunHooks( 'EditPageBeforeEditChecks', array( &$this, &$checkboxes, &$tabindex ) );
3356 return $checkboxes;
3360 * Returns an array of html code of the following buttons:
3361 * save, diff, preview and live
3363 * @param int $tabindex Current tabindex
3365 * @return array
3367 public function getEditButtons( &$tabindex ) {
3368 $buttons = array();
3370 $temp = array(
3371 'id' => 'wpSave',
3372 'name' => 'wpSave',
3373 'type' => 'submit',
3374 'tabindex' => ++$tabindex,
3375 'value' => wfMessage( 'savearticle' )->text(),
3376 'accesskey' => wfMessage( 'accesskey-save' )->text(),
3377 'title' => wfMessage( 'tooltip-save' )->text() . ' [' . wfMessage( 'accesskey-save' )->text() . ']',
3379 $buttons['save'] = Xml::element( 'input', $temp, '' );
3381 ++$tabindex; // use the same for preview and live preview
3382 $temp = array(
3383 'id' => 'wpPreview',
3384 'name' => 'wpPreview',
3385 'type' => 'submit',
3386 'tabindex' => $tabindex,
3387 'value' => wfMessage( 'showpreview' )->text(),
3388 'accesskey' => wfMessage( 'accesskey-preview' )->text(),
3389 'title' => wfMessage( 'tooltip-preview' )->text() . ' [' . wfMessage( 'accesskey-preview' )->text() . ']',
3391 $buttons['preview'] = Xml::element( 'input', $temp, '' );
3392 $buttons['live'] = '';
3394 $temp = array(
3395 'id' => 'wpDiff',
3396 'name' => 'wpDiff',
3397 'type' => 'submit',
3398 'tabindex' => ++$tabindex,
3399 'value' => wfMessage( 'showdiff' )->text(),
3400 'accesskey' => wfMessage( 'accesskey-diff' )->text(),
3401 'title' => wfMessage( 'tooltip-diff' )->text() . ' [' . wfMessage( 'accesskey-diff' )->text() . ']',
3403 $buttons['diff'] = Xml::element( 'input', $temp, '' );
3405 wfRunHooks( 'EditPageBeforeEditButtons', array( &$this, &$buttons, &$tabindex ) );
3406 return $buttons;
3410 * Output preview text only. This can be sucked into the edit page
3411 * via JavaScript, and saves the server time rendering the skin as
3412 * well as theoretically being more robust on the client (doesn't
3413 * disturb the edit box's undo history, won't eat your text on
3414 * failure, etc).
3416 * @todo This doesn't include category or interlanguage links.
3417 * Would need to enhance it a bit, "<s>maybe wrap them in XML
3418 * or something...</s>" that might also require more skin
3419 * initialization, so check whether that's a problem.
3421 function livePreview() {
3422 global $wgOut;
3423 $wgOut->disable();
3424 header( 'Content-type: text/xml; charset=utf-8' );
3425 header( 'Cache-control: no-cache' );
3427 $previewText = $this->getPreviewText();
3428 #$categories = $skin->getCategoryLinks();
3430 $s =
3431 '<?xml version="1.0" encoding="UTF-8" ?>' . "\n" .
3432 Xml::tags( 'livepreview', null,
3433 Xml::element( 'preview', null, $previewText )
3434 #. Xml::element( 'category', null, $categories )
3436 echo $s;
3440 * Call the stock "user is blocked" page
3442 * @deprecated in 1.19; throw an exception directly instead
3444 function blockedPage() {
3445 wfDeprecated( __METHOD__, '1.19' );
3446 global $wgUser;
3448 throw new UserBlockedError( $wgUser->getBlock() );
3452 * Produce the stock "please login to edit pages" page
3454 * @deprecated in 1.19; throw an exception directly instead
3456 function userNotLoggedInPage() {
3457 wfDeprecated( __METHOD__, '1.19' );
3458 throw new PermissionsError( 'edit' );
3462 * Show an error page saying to the user that he has insufficient permissions
3463 * to create a new page
3465 * @deprecated in 1.19; throw an exception directly instead
3467 function noCreatePermission() {
3468 wfDeprecated( __METHOD__, '1.19' );
3469 $permission = $this->mTitle->isTalkPage() ? 'createtalk' : 'createpage';
3470 throw new PermissionsError( $permission );
3474 * Creates a basic error page which informs the user that
3475 * they have attempted to edit a nonexistent section.
3477 function noSuchSectionPage() {
3478 global $wgOut;
3480 $wgOut->prepareErrorPage( wfMessage( 'nosuchsectiontitle' ) );
3482 $res = wfMessage( 'nosuchsectiontext', $this->section )->parseAsBlock();
3483 wfRunHooks( 'EditPageNoSuchSection', array( &$this, &$res ) );
3484 $wgOut->addHTML( $res );
3486 $wgOut->returnToMain( false, $this->mTitle );
3490 * Produce the stock "your edit contains spam" page
3492 * @param string|bool $match Text which triggered one or more filters
3493 * @deprecated since 1.17 Use method spamPageWithContent() instead
3495 static function spamPage( $match = false ) {
3496 wfDeprecated( __METHOD__, '1.17' );
3498 global $wgOut, $wgTitle;
3500 $wgOut->prepareErrorPage( wfMessage( 'spamprotectiontitle' ) );
3502 $wgOut->addHTML( '<div id="spamprotected">' );
3503 $wgOut->addWikiMsg( 'spamprotectiontext' );
3504 if ( $match ) {
3505 $wgOut->addWikiMsg( 'spamprotectionmatch', wfEscapeWikiText( $match ) );
3507 $wgOut->addHTML( '</div>' );
3509 $wgOut->returnToMain( false, $wgTitle );
3513 * Show "your edit contains spam" page with your diff and text
3515 * @param $match string|Array|bool Text (or array of texts) which triggered one or more filters
3517 public function spamPageWithContent( $match = false ) {
3518 global $wgOut, $wgLang;
3519 $this->textbox2 = $this->textbox1;
3521 if ( is_array( $match ) ) {
3522 $match = $wgLang->listToText( $match );
3524 $wgOut->prepareErrorPage( wfMessage( 'spamprotectiontitle' ) );
3526 $wgOut->addHTML( '<div id="spamprotected">' );
3527 $wgOut->addWikiMsg( 'spamprotectiontext' );
3528 if ( $match ) {
3529 $wgOut->addWikiMsg( 'spamprotectionmatch', wfEscapeWikiText( $match ) );
3531 $wgOut->addHTML( '</div>' );
3533 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
3534 $this->showDiff();
3536 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
3537 $this->showTextbox2();
3539 $wgOut->addReturnTo( $this->getContextTitle(), array( 'action' => 'edit' ) );
3543 * Format an anchor fragment as it would appear for a given section name
3544 * @param $text String
3545 * @return String
3546 * @private
3548 function sectionAnchor( $text ) {
3549 global $wgParser;
3550 return $wgParser->guessSectionNameFromWikiText( $text );
3554 * Check if the browser is on a blacklist of user-agents known to
3555 * mangle UTF-8 data on form submission. Returns true if Unicode
3556 * should make it through, false if it's known to be a problem.
3557 * @return bool
3558 * @private
3560 function checkUnicodeCompliantBrowser() {
3561 global $wgBrowserBlackList, $wgRequest;
3563 $currentbrowser = $wgRequest->getHeader( 'User-Agent' );
3564 if ( $currentbrowser === false ) {
3565 // No User-Agent header sent? Trust it by default...
3566 return true;
3569 foreach ( $wgBrowserBlackList as $browser ) {
3570 if ( preg_match( $browser, $currentbrowser ) ) {
3571 return false;
3574 return true;
3578 * Filter an input field through a Unicode de-armoring process if it
3579 * came from an old browser with known broken Unicode editing issues.
3581 * @param $request WebRequest
3582 * @param $field String
3583 * @return String
3584 * @private
3586 function safeUnicodeInput( $request, $field ) {
3587 $text = rtrim( $request->getText( $field ) );
3588 return $request->getBool( 'safemode' )
3589 ? $this->unmakesafe( $text )
3590 : $text;
3594 * @param $request WebRequest
3595 * @param $text string
3596 * @return string
3598 function safeUnicodeText( $request, $text ) {
3599 $text = rtrim( $text );
3600 return $request->getBool( 'safemode' )
3601 ? $this->unmakesafe( $text )
3602 : $text;
3606 * Filter an output field through a Unicode armoring process if it is
3607 * going to an old browser with known broken Unicode editing issues.
3609 * @param $text String
3610 * @return String
3611 * @private
3613 function safeUnicodeOutput( $text ) {
3614 global $wgContLang;
3615 $codedText = $wgContLang->recodeForEdit( $text );
3616 return $this->checkUnicodeCompliantBrowser()
3617 ? $codedText
3618 : $this->makesafe( $codedText );
3622 * A number of web browsers are known to corrupt non-ASCII characters
3623 * in a UTF-8 text editing environment. To protect against this,
3624 * detected browsers will be served an armored version of the text,
3625 * with non-ASCII chars converted to numeric HTML character references.
3627 * Preexisting such character references will have a 0 added to them
3628 * to ensure that round-trips do not alter the original data.
3630 * @param $invalue String
3631 * @return String
3632 * @private
3634 function makesafe( $invalue ) {
3635 // Armor existing references for reversibility.
3636 $invalue = strtr( $invalue, array( "&#x" => "&#x0" ) );
3638 $bytesleft = 0;
3639 $result = "";
3640 $working = 0;
3641 for ( $i = 0; $i < strlen( $invalue ); $i++ ) {
3642 $bytevalue = ord( $invalue[$i] );
3643 if ( $bytevalue <= 0x7F ) { // 0xxx xxxx
3644 $result .= chr( $bytevalue );
3645 $bytesleft = 0;
3646 } elseif ( $bytevalue <= 0xBF ) { // 10xx xxxx
3647 $working = $working << 6;
3648 $working += ( $bytevalue & 0x3F );
3649 $bytesleft--;
3650 if ( $bytesleft <= 0 ) {
3651 $result .= "&#x" . strtoupper( dechex( $working ) ) . ";";
3653 } elseif ( $bytevalue <= 0xDF ) { // 110x xxxx
3654 $working = $bytevalue & 0x1F;
3655 $bytesleft = 1;
3656 } elseif ( $bytevalue <= 0xEF ) { // 1110 xxxx
3657 $working = $bytevalue & 0x0F;
3658 $bytesleft = 2;
3659 } else { // 1111 0xxx
3660 $working = $bytevalue & 0x07;
3661 $bytesleft = 3;
3664 return $result;
3668 * Reverse the previously applied transliteration of non-ASCII characters
3669 * back to UTF-8. Used to protect data from corruption by broken web browsers
3670 * as listed in $wgBrowserBlackList.
3672 * @param $invalue String
3673 * @return String
3674 * @private
3676 function unmakesafe( $invalue ) {
3677 $result = "";
3678 for ( $i = 0; $i < strlen( $invalue ); $i++ ) {
3679 if ( ( substr( $invalue, $i, 3 ) == "&#x" ) && ( $invalue[$i + 3] != '0' ) ) {
3680 $i += 3;
3681 $hexstring = "";
3682 do {
3683 $hexstring .= $invalue[$i];
3684 $i++;
3685 } while ( ctype_xdigit( $invalue[$i] ) && ( $i < strlen( $invalue ) ) );
3687 // Do some sanity checks. These aren't needed for reversibility,
3688 // but should help keep the breakage down if the editor
3689 // breaks one of the entities whilst editing.
3690 if ( ( substr( $invalue, $i, 1 ) == ";" ) and ( strlen( $hexstring ) <= 6 ) ) {
3691 $codepoint = hexdec( $hexstring );
3692 $result .= codepointToUtf8( $codepoint );
3693 } else {
3694 $result .= "&#x" . $hexstring . substr( $invalue, $i, 1 );
3696 } else {
3697 $result .= substr( $invalue, $i, 1 );
3700 // reverse the transform that we made for reversibility reasons.
3701 return strtr( $result, array( "&#x0" => "&#x" ) );