Localisation updates from http://translatewiki.net.
[mediawiki.git] / includes / EditPage.php
blob1b59430a7609bb07b66af90c32d56715fd74bf8a
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 $wgOut->addModules( 'mediawiki.action.edit.collapsibleFooter' );
526 if ( $this->mTitle->exists() ) {
527 $wgOut->returnToMain( null, $this->mTitle );
532 * Show a read-only error
533 * Parameters are the same as OutputPage:readOnlyPage()
534 * Redirect to the article page if redlink=1
535 * @deprecated in 1.19; use displayPermissionsError() instead
537 function readOnlyPage( $source = null, $protected = false, $reasons = array(), $action = null ) {
538 wfDeprecated( __METHOD__, '1.19' );
540 global $wgRequest, $wgOut;
541 if ( $wgRequest->getBool( 'redlink' ) ) {
542 // The edit page was reached via a red link.
543 // Redirect to the article page and let them click the edit tab if
544 // they really want a permission error.
545 $wgOut->redirect( $this->mTitle->getFullURL() );
546 } else {
547 $wgOut->readOnlyPage( $source, $protected, $reasons, $action );
552 * Should we show a preview when the edit form is first shown?
554 * @return bool
556 protected function previewOnOpen() {
557 global $wgRequest, $wgUser, $wgPreviewOnOpenNamespaces;
558 if ( $wgRequest->getVal( 'preview' ) == 'yes' ) {
559 // Explicit override from request
560 return true;
561 } elseif ( $wgRequest->getVal( 'preview' ) == 'no' ) {
562 // Explicit override from request
563 return false;
564 } elseif ( $this->section == 'new' ) {
565 // Nothing *to* preview for new sections
566 return false;
567 } elseif ( ( $wgRequest->getVal( 'preload' ) !== null || $this->mTitle->exists() ) && $wgUser->getOption( 'previewonfirst' ) ) {
568 // Standard preference behavior
569 return true;
570 } elseif ( !$this->mTitle->exists() &&
571 isset( $wgPreviewOnOpenNamespaces[$this->mTitle->getNamespace()] ) &&
572 $wgPreviewOnOpenNamespaces[$this->mTitle->getNamespace()] )
574 // Categories are special
575 return true;
576 } else {
577 return false;
582 * Checks whether the user entered a skin name in uppercase,
583 * e.g. "User:Example/Monobook.css" instead of "monobook.css"
585 * @return bool
587 protected function isWrongCaseCssJsPage() {
588 if ( $this->mTitle->isCssJsSubpage() ) {
589 $name = $this->mTitle->getSkinFromCssJsSubpage();
590 $skins = array_merge(
591 array_keys( Skin::getSkinNames() ),
592 array( 'common' )
594 return !in_array( $name, $skins )
595 && in_array( strtolower( $name ), $skins );
596 } else {
597 return false;
602 * Returns whether section editing is supported for the current page.
603 * Subclasses may override this to replace the default behavior, which is
604 * to check ContentHandler::supportsSections.
606 * @return bool true if this edit page supports sections, false otherwise.
608 protected function isSectionEditSupported() {
609 $contentHandler = ContentHandler::getForTitle( $this->mTitle );
610 return $contentHandler->supportsSections();
614 * This function collects the form data and uses it to populate various member variables.
615 * @param $request WebRequest
617 function importFormData( &$request ) {
618 global $wgContLang, $wgUser;
620 wfProfileIn( __METHOD__ );
622 # Section edit can come from either the form or a link
623 $this->section = $request->getVal( 'wpSection', $request->getVal( 'section' ) );
625 if ( $this->section !== null && $this->section !== '' && !$this->isSectionEditSupported() ) {
626 wfProfileOut( __METHOD__ );
627 throw new ErrorPageError( 'sectioneditnotsupported-title', 'sectioneditnotsupported-text' );
630 $this->isNew = !$this->mTitle->exists() || $this->section == 'new';
632 if ( $request->wasPosted() ) {
633 # These fields need to be checked for encoding.
634 # Also remove trailing whitespace, but don't remove _initial_
635 # whitespace from the text boxes. This may be significant formatting.
636 $this->textbox1 = $this->safeUnicodeInput( $request, 'wpTextbox1' );
637 if ( !$request->getCheck( 'wpTextbox2' ) ) {
638 // Skip this if wpTextbox2 has input, it indicates that we came
639 // from a conflict page with raw page text, not a custom form
640 // modified by subclasses
641 wfProfileIn( get_class( $this ) . "::importContentFormData" );
642 $textbox1 = $this->importContentFormData( $request );
643 if ( $textbox1 !== null ) {
644 $this->textbox1 = $textbox1;
647 wfProfileOut( get_class( $this ) . "::importContentFormData" );
650 # Truncate for whole multibyte characters
651 $this->summary = $wgContLang->truncate( $request->getText( 'wpSummary' ), 255 );
653 # If the summary consists of a heading, e.g. '==Foobar==', extract the title from the
654 # header syntax, e.g. 'Foobar'. This is mainly an issue when we are using wpSummary for
655 # section titles.
656 $this->summary = preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->summary );
658 # Treat sectiontitle the same way as summary.
659 # Note that wpSectionTitle is not yet a part of the actual edit form, as wpSummary is
660 # currently doing double duty as both edit summary and section title. Right now this
661 # is just to allow API edits to work around this limitation, but this should be
662 # incorporated into the actual edit form when EditPage is rewritten (Bugs 18654, 26312).
663 $this->sectiontitle = $wgContLang->truncate( $request->getText( 'wpSectionTitle' ), 255 );
664 $this->sectiontitle = preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->sectiontitle );
666 $this->edittime = $request->getVal( 'wpEdittime' );
667 $this->starttime = $request->getVal( 'wpStarttime' );
669 $this->scrolltop = $request->getIntOrNull( 'wpScrolltop' );
671 if ( $this->textbox1 === '' && $request->getVal( 'wpTextbox1' ) === null ) {
672 // wpTextbox1 field is missing, possibly due to being "too big"
673 // according to some filter rules such as Suhosin's setting for
674 // suhosin.request.max_value_length (d'oh)
675 $this->incompleteForm = true;
676 } else {
677 // edittime should be one of our last fields; if it's missing,
678 // the submission probably broke somewhere in the middle.
679 $this->incompleteForm = is_null( $this->edittime );
681 if ( $this->incompleteForm ) {
682 # If the form is incomplete, force to preview.
683 wfDebug( __METHOD__ . ": Form data appears to be incomplete\n" );
684 wfDebug( "POST DATA: " . var_export( $_POST, true ) . "\n" );
685 $this->preview = true;
686 } else {
687 /* Fallback for live preview */
688 $this->preview = $request->getCheck( 'wpPreview' ) || $request->getCheck( 'wpLivePreview' );
689 $this->diff = $request->getCheck( 'wpDiff' );
691 // Remember whether a save was requested, so we can indicate
692 // if we forced preview due to session failure.
693 $this->mTriedSave = !$this->preview;
695 if ( $this->tokenOk( $request ) ) {
696 # Some browsers will not report any submit button
697 # if the user hits enter in the comment box.
698 # The unmarked state will be assumed to be a save,
699 # if the form seems otherwise complete.
700 wfDebug( __METHOD__ . ": Passed token check.\n" );
701 } elseif ( $this->diff ) {
702 # Failed token check, but only requested "Show Changes".
703 wfDebug( __METHOD__ . ": Failed token check; Show Changes requested.\n" );
704 } else {
705 # Page might be a hack attempt posted from
706 # an external site. Preview instead of saving.
707 wfDebug( __METHOD__ . ": Failed token check; forcing preview\n" );
708 $this->preview = true;
711 $this->save = !$this->preview && !$this->diff;
712 if ( !preg_match( '/^\d{14}$/', $this->edittime ) ) {
713 $this->edittime = null;
716 if ( !preg_match( '/^\d{14}$/', $this->starttime ) ) {
717 $this->starttime = null;
720 $this->recreate = $request->getCheck( 'wpRecreate' );
722 $this->minoredit = $request->getCheck( 'wpMinoredit' );
723 $this->watchthis = $request->getCheck( 'wpWatchthis' );
725 # Don't force edit summaries when a user is editing their own user or talk page
726 if ( ( $this->mTitle->mNamespace == NS_USER || $this->mTitle->mNamespace == NS_USER_TALK ) &&
727 $this->mTitle->getText() == $wgUser->getName() )
729 $this->allowBlankSummary = true;
730 } else {
731 $this->allowBlankSummary = $request->getBool( 'wpIgnoreBlankSummary' ) || !$wgUser->getOption( 'forceeditsummary' );
734 $this->autoSumm = $request->getText( 'wpAutoSummary' );
735 } else {
736 # Not a posted form? Start with nothing.
737 wfDebug( __METHOD__ . ": Not a posted form.\n" );
738 $this->textbox1 = '';
739 $this->summary = '';
740 $this->sectiontitle = '';
741 $this->edittime = '';
742 $this->starttime = wfTimestampNow();
743 $this->edit = false;
744 $this->preview = false;
745 $this->save = false;
746 $this->diff = false;
747 $this->minoredit = false;
748 $this->watchthis = $request->getBool( 'watchthis', false ); // Watch may be overridden by request parameters
749 $this->recreate = false;
751 // When creating a new section, we can preload a section title by passing it as the
752 // preloadtitle parameter in the URL (Bug 13100)
753 if ( $this->section == 'new' && $request->getVal( 'preloadtitle' ) ) {
754 $this->sectiontitle = $request->getVal( 'preloadtitle' );
755 // Once wpSummary isn't being use for setting section titles, we should delete this.
756 $this->summary = $request->getVal( 'preloadtitle' );
758 elseif ( $this->section != 'new' && $request->getVal( 'summary' ) ) {
759 $this->summary = $request->getText( 'summary' );
760 if ( $this->summary !== '' ) {
761 $this->hasPresetSummary = true;
765 if ( $request->getVal( 'minor' ) ) {
766 $this->minoredit = true;
770 $this->oldid = $request->getInt( 'oldid' );
772 $this->bot = $request->getBool( 'bot', true );
773 $this->nosummary = $request->getBool( 'nosummary' );
775 $content_handler = ContentHandler::getForTitle( $this->mTitle );
776 $this->contentModel = $request->getText( 'model', $content_handler->getModelID() ); #may be overridden by revision
777 $this->contentFormat = $request->getText( 'format', $content_handler->getDefaultFormat() ); #may be overridden by revision
779 #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
780 #TODO: check if the desired content model supports the given content format!
782 $this->live = $request->getCheck( 'live' );
783 $this->editintro = $request->getText( 'editintro',
784 // Custom edit intro for new sections
785 $this->section === 'new' ? 'MediaWiki:addsection-editintro' : '' );
787 // Allow extensions to modify form data
788 wfRunHooks( 'EditPage::importFormData', array( $this, $request ) );
790 wfProfileOut( __METHOD__ );
794 * Subpage overridable method for extracting the page content data from the
795 * posted form to be placed in $this->textbox1, if using customized input
796 * this method should be overridden and return the page text that will be used
797 * for saving, preview parsing and so on...
799 * @param $request WebRequest
801 protected function importContentFormData( &$request ) {
802 return; // Don't do anything, EditPage already extracted wpTextbox1
806 * Initialise form fields in the object
807 * Called on the first invocation, e.g. when a user clicks an edit link
808 * @return bool -- if the requested section is valid
810 function initialiseForm() {
811 global $wgUser;
812 $this->edittime = $this->mArticle->getTimestamp();
814 $content = $this->getContentObject( false ); #TODO: track content object?!
815 if ( $content === false ) {
816 return false;
818 $this->textbox1 = $this->toEditText( $content );
820 // activate checkboxes if user wants them to be always active
821 # Sort out the "watch" checkbox
822 if ( $wgUser->getOption( 'watchdefault' ) ) {
823 # Watch all edits
824 $this->watchthis = true;
825 } elseif ( $wgUser->getOption( 'watchcreations' ) && !$this->mTitle->exists() ) {
826 # Watch creations
827 $this->watchthis = true;
828 } elseif ( $wgUser->isWatched( $this->mTitle ) ) {
829 # Already watched
830 $this->watchthis = true;
832 if ( $wgUser->getOption( 'minordefault' ) && !$this->isNew ) {
833 $this->minoredit = true;
835 if ( $this->textbox1 === false ) {
836 return false;
838 wfProxyCheck();
839 return true;
843 * Fetch initial editing page content.
845 * @param $def_text string|bool
846 * @return mixed string on success, $def_text for invalid sections
847 * @private
848 * @deprecated since 1.21, get WikiPage::getContent() instead.
850 function getContent( $def_text = false ) {
851 ContentHandler::deprecated( __METHOD__, '1.21' );
853 if ( $def_text !== null && $def_text !== false && $def_text !== '' ) {
854 $def_content = $this->toEditContent( $def_text );
855 } else {
856 $def_content = false;
859 $content = $this->getContentObject( $def_content );
861 // Note: EditPage should only be used with text based content anyway.
862 return $this->toEditText( $content );
866 * @param Content|null $def_content The default value to return
868 * @return mixed Content on success, $def_content for invalid sections
870 * @since 1.21
872 protected function getContentObject( $def_content = null ) {
873 global $wgOut, $wgRequest;
875 wfProfileIn( __METHOD__ );
877 $content = false;
879 // For message page not locally set, use the i18n message.
880 // For other non-existent articles, use preload text if any.
881 if ( !$this->mTitle->exists() || $this->section == 'new' ) {
882 if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI && $this->section != 'new' ) {
883 # If this is a system message, get the default text.
884 $msg = $this->mTitle->getDefaultMessageText();
886 $content = $this->toEditContent( $msg );
888 if ( $content === false ) {
889 # If requested, preload some text.
890 $preload = $wgRequest->getVal( 'preload',
891 // Custom preload text for new sections
892 $this->section === 'new' ? 'MediaWiki:addsection-preload' : '' );
894 $content = $this->getPreloadedContent( $preload );
896 // For existing pages, get text based on "undo" or section parameters.
897 } else {
898 if ( $this->section != '' ) {
899 // Get section edit text (returns $def_text for invalid sections)
900 $orig = $this->getOriginalContent();
901 $content = $orig ? $orig->getSection( $this->section ) : null;
903 if ( !$content ) {
904 $content = $def_content;
906 } else {
907 $undoafter = $wgRequest->getInt( 'undoafter' );
908 $undo = $wgRequest->getInt( 'undo' );
910 if ( $undo > 0 && $undoafter > 0 ) {
911 if ( $undo < $undoafter ) {
912 # If they got undoafter and undo round the wrong way, switch them
913 list( $undo, $undoafter ) = array( $undoafter, $undo );
916 $undorev = Revision::newFromId( $undo );
917 $oldrev = Revision::newFromId( $undoafter );
919 # Sanity check, make sure it's the right page,
920 # the revisions exist and they were not deleted.
921 # Otherwise, $content will be left as-is.
922 if ( !is_null( $undorev ) && !is_null( $oldrev ) &&
923 $undorev->getPage() == $oldrev->getPage() &&
924 $undorev->getPage() == $this->mTitle->getArticleID() &&
925 !$undorev->isDeleted( Revision::DELETED_TEXT ) &&
926 !$oldrev->isDeleted( Revision::DELETED_TEXT ) ) {
928 $content = $this->mArticle->getUndoContent( $undorev, $oldrev );
930 if ( $content === false ) {
931 # Warn the user that something went wrong
932 $undoMsg = 'failure';
933 } else {
934 # Inform the user of our success and set an automatic edit summary
935 $undoMsg = 'success';
937 # If we just undid one rev, use an autosummary
938 $firstrev = $oldrev->getNext();
939 if ( $firstrev && $firstrev->getId() == $undo ) {
940 $userText = $undorev->getUserText();
941 if ( $userText === '' ) {
942 $undoSummary = wfMessage(
943 'undo-summary-username-hidden',
944 $undo
945 )->inContentLanguage()->text();
946 } else {
947 $undoSummary = wfMessage(
948 'undo-summary',
949 $undo,
950 $userText
951 )->inContentLanguage()->text();
953 if ( $this->summary === '' ) {
954 $this->summary = $undoSummary;
955 } else {
956 $this->summary = $undoSummary . wfMessage( 'colon-separator' )
957 ->inContentLanguage()->text() . $this->summary;
959 $this->undidRev = $undo;
961 $this->formtype = 'diff';
963 } else {
964 // Failed basic sanity checks.
965 // Older revisions may have been removed since the link
966 // was created, or we may simply have got bogus input.
967 $undoMsg = 'norev';
970 $class = ( $undoMsg == 'success' ? '' : 'error ' ) . "mw-undo-{$undoMsg}";
971 $this->editFormPageTop .= $wgOut->parse( "<div class=\"{$class}\">" .
972 wfMessage( 'undo-' . $undoMsg )->plain() . '</div>', true, /* interface */true );
975 if ( $content === false ) {
976 $content = $this->getOriginalContent();
981 wfProfileOut( __METHOD__ );
982 return $content;
986 * Get the content of the wanted revision, without section extraction.
988 * The result of this function can be used to compare user's input with
989 * section replaced in its context (using WikiPage::replaceSection())
990 * to the original text of the edit.
992 * This differs from Article::getContent() that when a missing revision is
993 * encountered the result will be null and not the
994 * 'missing-revision' message.
996 * @since 1.19
997 * @return Content|null
999 private function getOriginalContent() {
1000 if ( $this->section == 'new' ) {
1001 return $this->getCurrentContent();
1003 $revision = $this->mArticle->getRevisionFetched();
1004 if ( $revision === null ) {
1005 if ( !$this->contentModel ) {
1006 $this->contentModel = $this->getTitle()->getContentModel();
1008 $handler = ContentHandler::getForModelID( $this->contentModel );
1010 return $handler->makeEmptyContent();
1012 $content = $revision->getContent();
1013 return $content;
1017 * Get the current content of the page. This is basically similar to
1018 * WikiPage::getContent( Revision::RAW ) except that when the page doesn't exist an empty
1019 * content object is returned instead of null.
1021 * @since 1.21
1022 * @return Content
1024 protected function getCurrentContent() {
1025 $rev = $this->mArticle->getRevision();
1026 $content = $rev ? $rev->getContent( Revision::RAW ) : null;
1028 if ( $content === false || $content === null ) {
1029 if ( !$this->contentModel ) {
1030 $this->contentModel = $this->getTitle()->getContentModel();
1032 $handler = ContentHandler::getForModelID( $this->contentModel );
1034 return $handler->makeEmptyContent();
1035 } else {
1036 # nasty side-effect, but needed for consistency
1037 $this->contentModel = $rev->getContentModel();
1038 $this->contentFormat = $rev->getContentFormat();
1040 return $content;
1045 * Use this method before edit() to preload some text into the edit box
1047 * @param $text string
1048 * @deprecated since 1.21, use setPreloadedContent() instead.
1050 public function setPreloadedText( $text ) {
1051 ContentHandler::deprecated( __METHOD__, "1.21" );
1053 $content = $this->toEditContent( $text );
1055 $this->setPreloadedContent( $content );
1059 * Use this method before edit() to preload some content into the edit box
1061 * @param $content Content
1063 * @since 1.21
1065 public function setPreloadedContent( Content $content ) {
1066 $this->mPreloadContent = $content;
1070 * Get the contents to be preloaded into the box, either set by
1071 * an earlier setPreloadText() or by loading the given page.
1073 * @param string $preload representing the title to preload from.
1075 * @return String
1077 * @deprecated since 1.21, use getPreloadedContent() instead
1079 protected function getPreloadedText( $preload ) {
1080 ContentHandler::deprecated( __METHOD__, "1.21" );
1082 $content = $this->getPreloadedContent( $preload );
1083 $text = $this->toEditText( $content );
1085 return $text;
1089 * Get the contents to be preloaded into the box, either set by
1090 * an earlier setPreloadText() or by loading the given page.
1092 * @param string $preload representing the title to preload from.
1094 * @return Content
1096 * @since 1.21
1098 protected function getPreloadedContent( $preload ) {
1099 global $wgUser;
1101 if ( !empty( $this->mPreloadContent ) ) {
1102 return $this->mPreloadContent;
1105 $handler = ContentHandler::getForTitle( $this->getTitle() );
1107 if ( $preload === '' ) {
1108 return $handler->makeEmptyContent();
1111 $title = Title::newFromText( $preload );
1112 # Check for existence to avoid getting MediaWiki:Noarticletext
1113 if ( $title === null || !$title->exists() || !$title->userCan( 'read', $wgUser ) ) {
1114 //TODO: somehow show a warning to the user!
1115 return $handler->makeEmptyContent();
1118 $page = WikiPage::factory( $title );
1119 if ( $page->isRedirect() ) {
1120 $title = $page->getRedirectTarget();
1121 # Same as before
1122 if ( $title === null || !$title->exists() || !$title->userCan( 'read', $wgUser ) ) {
1123 //TODO: somehow show a warning to the user!
1124 return $handler->makeEmptyContent();
1126 $page = WikiPage::factory( $title );
1129 $parserOptions = ParserOptions::newFromUser( $wgUser );
1130 $content = $page->getContent( Revision::RAW );
1132 if ( !$content ) {
1133 //TODO: somehow show a warning to the user!
1134 return $handler->makeEmptyContent();
1137 if ( $content->getModel() !== $handler->getModelID() ) {
1138 $converted = $content->convert( $handler->getModelID() );
1140 if ( !$converted ) {
1141 //TODO: somehow show a warning to the user!
1142 wfDebug( "Attempt to preload incompatible content: "
1143 . "can't convert " . $content->getModel()
1144 . " to " . $handler->getModelID() );
1146 return $handler->makeEmptyContent();
1149 $content = $converted;
1152 return $content->preloadTransform( $title, $parserOptions );
1156 * Make sure the form isn't faking a user's credentials.
1158 * @param $request WebRequest
1159 * @return bool
1160 * @private
1162 function tokenOk( &$request ) {
1163 global $wgUser;
1164 $token = $request->getVal( 'wpEditToken' );
1165 $this->mTokenOk = $wgUser->matchEditToken( $token );
1166 $this->mTokenOkExceptSuffix = $wgUser->matchEditTokenNoSuffix( $token );
1167 return $this->mTokenOk;
1171 * Sets post-edit cookie indicating the user just saved a particular revision.
1173 * This uses a temporary cookie for each revision ID so separate saves will never
1174 * interfere with each other.
1176 * The cookie is deleted in the mediawiki.action.view.postEdit JS module after
1177 * the redirect. It must be clearable by JavaScript code, so it must not be
1178 * marked HttpOnly. The JavaScript code converts the cookie to a wgPostEdit config
1179 * variable.
1181 * Since WebResponse::setcookie does not allow forcing HttpOnly for a single
1182 * cookie, we have to use PHP's setcookie() directly.
1184 * We use a path of '/' since wgCookiePath is not exposed to JS
1186 * If the variable were set on the server, it would be cached, which is unwanted
1187 * since the post-edit state should only apply to the load right after the save.
1189 protected function setPostEditCookie() {
1190 global $wgCookiePrefix, $wgCookieDomain;
1191 $revisionId = $this->mArticle->getLatest();
1192 $postEditKey = self::POST_EDIT_COOKIE_KEY_PREFIX . $revisionId;
1194 setcookie( $wgCookiePrefix . $postEditKey, '1', time() + self::POST_EDIT_COOKIE_DURATION, '/', $wgCookieDomain );
1198 * Attempt submission
1199 * @throws UserBlockedError|ReadOnlyError|ThrottledError|PermissionsError
1200 * @return bool false if output is done, true if the rest of the form should be displayed
1202 function attemptSave() {
1203 global $wgUser, $wgOut;
1205 $resultDetails = false;
1206 # Allow bots to exempt some edits from bot flagging
1207 $bot = $wgUser->isAllowed( 'bot' ) && $this->bot;
1208 $status = $this->internalAttemptSave( $resultDetails, $bot );
1209 // FIXME: once the interface for internalAttemptSave() is made nicer, this should use the message in $status
1210 if ( $status->value == self::AS_SUCCESS_UPDATE || $status->value == self::AS_SUCCESS_NEW_ARTICLE ) {
1211 $this->didSave = true;
1212 if ( !$resultDetails['nullEdit'] ) {
1213 $this->setPostEditCookie();
1217 switch ( $status->value ) {
1218 case self::AS_HOOK_ERROR_EXPECTED:
1219 case self::AS_CONTENT_TOO_BIG:
1220 case self::AS_ARTICLE_WAS_DELETED:
1221 case self::AS_CONFLICT_DETECTED:
1222 case self::AS_SUMMARY_NEEDED:
1223 case self::AS_TEXTBOX_EMPTY:
1224 case self::AS_MAX_ARTICLE_SIZE_EXCEEDED:
1225 case self::AS_END:
1226 return true;
1228 case self::AS_HOOK_ERROR:
1229 return false;
1231 case self::AS_PARSE_ERROR:
1232 $wgOut->addWikiText( '<div class="error">' . $status->getWikiText() . '</div>' );
1233 return true;
1235 case self::AS_SUCCESS_NEW_ARTICLE:
1236 $query = $resultDetails['redirect'] ? 'redirect=no' : '';
1237 $anchor = isset( $resultDetails['sectionanchor'] ) ? $resultDetails['sectionanchor'] : '';
1238 $wgOut->redirect( $this->mTitle->getFullURL( $query ) . $anchor );
1239 return false;
1241 case self::AS_SUCCESS_UPDATE:
1242 $extraQuery = '';
1243 $sectionanchor = $resultDetails['sectionanchor'];
1245 // Give extensions a chance to modify URL query on update
1246 wfRunHooks( 'ArticleUpdateBeforeRedirect', array( $this->mArticle, &$sectionanchor, &$extraQuery ) );
1248 if ( $resultDetails['redirect'] ) {
1249 if ( $extraQuery == '' ) {
1250 $extraQuery = 'redirect=no';
1251 } else {
1252 $extraQuery = 'redirect=no&' . $extraQuery;
1255 $wgOut->redirect( $this->mTitle->getFullURL( $extraQuery ) . $sectionanchor );
1256 return false;
1258 case self::AS_BLANK_ARTICLE:
1259 $wgOut->redirect( $this->getContextTitle()->getFullURL() );
1260 return false;
1262 case self::AS_SPAM_ERROR:
1263 $this->spamPageWithContent( $resultDetails['spam'] );
1264 return false;
1266 case self::AS_BLOCKED_PAGE_FOR_USER:
1267 throw new UserBlockedError( $wgUser->getBlock() );
1269 case self::AS_IMAGE_REDIRECT_ANON:
1270 case self::AS_IMAGE_REDIRECT_LOGGED:
1271 throw new PermissionsError( 'upload' );
1273 case self::AS_READ_ONLY_PAGE_ANON:
1274 case self::AS_READ_ONLY_PAGE_LOGGED:
1275 throw new PermissionsError( 'edit' );
1277 case self::AS_READ_ONLY_PAGE:
1278 throw new ReadOnlyError;
1280 case self::AS_RATE_LIMITED:
1281 throw new ThrottledError();
1283 case self::AS_NO_CREATE_PERMISSION:
1284 $permission = $this->mTitle->isTalkPage() ? 'createtalk' : 'createpage';
1285 throw new PermissionsError( $permission );
1287 default:
1288 // We don't recognize $status->value. The only way that can happen
1289 // is if an extension hook aborted from inside ArticleSave.
1290 // Render the status object into $this->hookError
1291 // FIXME this sucks, we should just use the Status object throughout
1292 $this->hookError = '<div class="error">' . $status->getWikitext() .
1293 '</div>';
1294 return true;
1299 * Run hooks that can filter edits just before they get saved.
1301 * @param Content $content the Content to filter.
1302 * @param Status $status for reporting the outcome to the caller
1303 * @param User $user the user performing the edit
1305 * @return bool
1307 protected function runPostMergeFilters( Content $content, Status $status, User $user ) {
1308 // Run old style post-section-merge edit filter
1309 if ( !ContentHandler::runLegacyHooks( 'EditFilterMerged',
1310 array( $this, $content, &$this->hookError, $this->summary ) ) ) {
1312 # Error messages etc. could be handled within the hook...
1313 $status->fatal( 'hookaborted' );
1314 $status->value = self::AS_HOOK_ERROR;
1315 return false;
1316 } elseif ( $this->hookError != '' ) {
1317 # ...or the hook could be expecting us to produce an error
1318 $status->fatal( 'hookaborted' );
1319 $status->value = self::AS_HOOK_ERROR_EXPECTED;
1320 return false;
1323 // Run new style post-section-merge edit filter
1324 if ( !wfRunHooks( 'EditFilterMergedContent',
1325 array( $this->mArticle->getContext(), $content, $status, $this->summary,
1326 $user, $this->minoredit ) ) ) {
1328 # Error messages etc. could be handled within the hook...
1329 // XXX: $status->value may already be something informative...
1330 $this->hookError = $status->getWikiText();
1331 $status->fatal( 'hookaborted' );
1332 $status->value = self::AS_HOOK_ERROR;
1333 return false;
1334 } elseif ( !$status->isOK() ) {
1335 # ...or the hook could be expecting us to produce an error
1336 // FIXME this sucks, we should just use the Status object throughout
1337 $this->hookError = $status->getWikiText();
1338 $status->fatal( 'hookaborted' );
1339 $status->value = self::AS_HOOK_ERROR_EXPECTED;
1340 return false;
1343 return true;
1347 * Attempt submission (no UI)
1349 * @param array $result array to add statuses to, currently with the possible keys:
1350 * spam - string - Spam string from content if any spam is detected by matchSpamRegex
1351 * sectionanchor - string - Section anchor for a section save
1352 * nullEdit - boolean - Set if doEditContent is OK. True if null edit, false otherwise.
1353 * redirect - boolean - Set if doEditContent is OK. True if resulting revision is a redirect
1354 * @param bool $bot True if edit is being made under the bot right.
1356 * @return Status object, possibly with a message, but always with one of the AS_* constants in $status->value,
1358 * FIXME: This interface is TERRIBLE, but hard to get rid of due to various error display idiosyncrasies. There are
1359 * also lots of cases where error metadata is set in the object and retrieved later instead of being returned, e.g.
1360 * AS_CONTENT_TOO_BIG and AS_BLOCKED_PAGE_FOR_USER. All that stuff needs to be cleaned up some time.
1362 function internalAttemptSave( &$result, $bot = false ) {
1363 global $wgUser, $wgRequest, $wgParser, $wgMaxArticleSize;
1365 $status = Status::newGood();
1367 wfProfileIn( __METHOD__ );
1368 wfProfileIn( __METHOD__ . '-checks' );
1370 if ( !wfRunHooks( 'EditPage::attemptSave', array( $this ) ) ) {
1371 wfDebug( "Hook 'EditPage::attemptSave' aborted article saving\n" );
1372 $status->fatal( 'hookaborted' );
1373 $status->value = self::AS_HOOK_ERROR;
1374 wfProfileOut( __METHOD__ . '-checks' );
1375 wfProfileOut( __METHOD__ );
1376 return $status;
1379 try {
1380 # Construct Content object
1381 $textbox_content = $this->toEditContent( $this->textbox1 );
1382 } catch ( MWContentSerializationException $ex ) {
1383 $status->fatal( 'content-failed-to-parse', $this->contentModel, $this->contentFormat, $ex->getMessage() );
1384 $status->value = self::AS_PARSE_ERROR;
1385 wfProfileOut( __METHOD__ . '-checks' );
1386 wfProfileOut( __METHOD__ );
1387 return $status;
1390 # Check image redirect
1391 if ( $this->mTitle->getNamespace() == NS_FILE &&
1392 $textbox_content->isRedirect() &&
1393 !$wgUser->isAllowed( 'upload' ) ) {
1394 $code = $wgUser->isAnon() ? self::AS_IMAGE_REDIRECT_ANON : self::AS_IMAGE_REDIRECT_LOGGED;
1395 $status->setResult( false, $code );
1397 wfProfileOut( __METHOD__ . '-checks' );
1398 wfProfileOut( __METHOD__ );
1400 return $status;
1403 # Check for spam
1404 $match = self::matchSummarySpamRegex( $this->summary );
1405 if ( $match === false && $this->section == 'new' ) {
1406 if ( $this->sectiontitle !== '' ) {
1407 $match = self::matchSpamRegex( $this->sectiontitle );
1408 } else {
1409 $match = self::matchSpamRegex( $this->summary );
1412 if ( $match === false ) {
1413 $match = self::matchSpamRegex( $this->textbox1 );
1415 if ( $match !== false ) {
1416 $result['spam'] = $match;
1417 $ip = $wgRequest->getIP();
1418 $pdbk = $this->mTitle->getPrefixedDBkey();
1419 $match = str_replace( "\n", '', $match );
1420 wfDebugLog( 'SpamRegex', "$ip spam regex hit [[$pdbk]]: \"$match\"" );
1421 $status->fatal( 'spamprotectionmatch', $match );
1422 $status->value = self::AS_SPAM_ERROR;
1423 wfProfileOut( __METHOD__ . '-checks' );
1424 wfProfileOut( __METHOD__ );
1425 return $status;
1427 if ( !wfRunHooks( 'EditFilter', array( $this, $this->textbox1, $this->section, &$this->hookError, $this->summary ) ) ) {
1428 # Error messages etc. could be handled within the hook...
1429 $status->fatal( 'hookaborted' );
1430 $status->value = self::AS_HOOK_ERROR;
1431 wfProfileOut( __METHOD__ . '-checks' );
1432 wfProfileOut( __METHOD__ );
1433 return $status;
1434 } elseif ( $this->hookError != '' ) {
1435 # ...or the hook could be expecting us to produce an error
1436 $status->fatal( 'hookaborted' );
1437 $status->value = self::AS_HOOK_ERROR_EXPECTED;
1438 wfProfileOut( __METHOD__ . '-checks' );
1439 wfProfileOut( __METHOD__ );
1440 return $status;
1443 if ( $wgUser->isBlockedFrom( $this->mTitle, false ) ) {
1444 // Auto-block user's IP if the account was "hard" blocked
1445 $wgUser->spreadAnyEditBlock();
1446 # Check block state against master, thus 'false'.
1447 $status->setResult( false, self::AS_BLOCKED_PAGE_FOR_USER );
1448 wfProfileOut( __METHOD__ . '-checks' );
1449 wfProfileOut( __METHOD__ );
1450 return $status;
1453 $this->kblength = (int)( strlen( $this->textbox1 ) / 1024 );
1454 if ( $this->kblength > $wgMaxArticleSize ) {
1455 // Error will be displayed by showEditForm()
1456 $this->tooBig = true;
1457 $status->setResult( false, self::AS_CONTENT_TOO_BIG );
1458 wfProfileOut( __METHOD__ . '-checks' );
1459 wfProfileOut( __METHOD__ );
1460 return $status;
1463 if ( !$wgUser->isAllowed( 'edit' ) ) {
1464 if ( $wgUser->isAnon() ) {
1465 $status->setResult( false, self::AS_READ_ONLY_PAGE_ANON );
1466 wfProfileOut( __METHOD__ . '-checks' );
1467 wfProfileOut( __METHOD__ );
1468 return $status;
1469 } else {
1470 $status->fatal( 'readonlytext' );
1471 $status->value = self::AS_READ_ONLY_PAGE_LOGGED;
1472 wfProfileOut( __METHOD__ . '-checks' );
1473 wfProfileOut( __METHOD__ );
1474 return $status;
1478 if ( wfReadOnly() ) {
1479 $status->fatal( 'readonlytext' );
1480 $status->value = self::AS_READ_ONLY_PAGE;
1481 wfProfileOut( __METHOD__ . '-checks' );
1482 wfProfileOut( __METHOD__ );
1483 return $status;
1485 if ( $wgUser->pingLimiter() ) {
1486 $status->fatal( 'actionthrottledtext' );
1487 $status->value = self::AS_RATE_LIMITED;
1488 wfProfileOut( __METHOD__ . '-checks' );
1489 wfProfileOut( __METHOD__ );
1490 return $status;
1493 # If the article has been deleted while editing, don't save it without
1494 # confirmation
1495 if ( $this->wasDeletedSinceLastEdit() && !$this->recreate ) {
1496 $status->setResult( false, self::AS_ARTICLE_WAS_DELETED );
1497 wfProfileOut( __METHOD__ . '-checks' );
1498 wfProfileOut( __METHOD__ );
1499 return $status;
1502 wfProfileOut( __METHOD__ . '-checks' );
1504 # Load the page data from the master. If anything changes in the meantime,
1505 # we detect it by using page_latest like a token in a 1 try compare-and-swap.
1506 $this->mArticle->loadPageData( 'fromdbmaster' );
1507 $new = !$this->mArticle->exists();
1509 if ( $new ) {
1510 // Late check for create permission, just in case *PARANOIA*
1511 if ( !$this->mTitle->userCan( 'create', $wgUser ) ) {
1512 $status->fatal( 'nocreatetext' );
1513 $status->value = self::AS_NO_CREATE_PERMISSION;
1514 wfDebug( __METHOD__ . ": no create permission\n" );
1515 wfProfileOut( __METHOD__ );
1516 return $status;
1519 // Don't save a new page if it's blank or if it's a MediaWiki:
1520 // message with content equivalent to default (allow empty pages
1521 // in this case to disable messages, see bug 50124)
1522 $defaultMessageText = $this->mTitle->getDefaultMessageText();
1523 if( $this->mTitle->getNamespace() === NS_MEDIAWIKI && $defaultMessageText !== false ) {
1524 $defaultText = $defaultMessageText;
1525 } else {
1526 $defaultText = '';
1529 if ( $this->textbox1 === $defaultText ) {
1530 $status->setResult( false, self::AS_BLANK_ARTICLE );
1531 wfProfileOut( __METHOD__ );
1532 return $status;
1535 if ( !$this->runPostMergeFilters( $textbox_content, $status, $wgUser ) ) {
1536 wfProfileOut( __METHOD__ );
1537 return $status;
1540 $content = $textbox_content;
1542 $result['sectionanchor'] = '';
1543 if ( $this->section == 'new' ) {
1544 if ( $this->sectiontitle !== '' ) {
1545 // Insert the section title above the content.
1546 $content = $content->addSectionHeader( $this->sectiontitle );
1548 // Jump to the new section
1549 $result['sectionanchor'] = $wgParser->guessLegacySectionNameFromWikiText( $this->sectiontitle );
1551 // If no edit summary was specified, create one automatically from the section
1552 // title and have it link to the new section. Otherwise, respect the summary as
1553 // passed.
1554 if ( $this->summary === '' ) {
1555 $cleanSectionTitle = $wgParser->stripSectionName( $this->sectiontitle );
1556 $this->summary = wfMessage( 'newsectionsummary' )
1557 ->rawParams( $cleanSectionTitle )->inContentLanguage()->text();
1559 } elseif ( $this->summary !== '' ) {
1560 // Insert the section title above the content.
1561 $content = $content->addSectionHeader( $this->summary );
1563 // Jump to the new section
1564 $result['sectionanchor'] = $wgParser->guessLegacySectionNameFromWikiText( $this->summary );
1566 // Create a link to the new section from the edit summary.
1567 $cleanSummary = $wgParser->stripSectionName( $this->summary );
1568 $this->summary = wfMessage( 'newsectionsummary' )
1569 ->rawParams( $cleanSummary )->inContentLanguage()->text();
1573 $status->value = self::AS_SUCCESS_NEW_ARTICLE;
1575 } else { # not $new
1577 # Article exists. Check for edit conflict.
1579 $this->mArticle->clear(); # Force reload of dates, etc.
1580 $timestamp = $this->mArticle->getTimestamp();
1582 wfDebug( "timestamp: {$timestamp}, edittime: {$this->edittime}\n" );
1584 if ( $timestamp != $this->edittime ) {
1585 $this->isConflict = true;
1586 if ( $this->section == 'new' ) {
1587 if ( $this->mArticle->getUserText() == $wgUser->getName() &&
1588 $this->mArticle->getComment() == $this->summary ) {
1589 // Probably a duplicate submission of a new comment.
1590 // This can happen when squid resends a request after
1591 // a timeout but the first one actually went through.
1592 wfDebug( __METHOD__ . ": duplicate new section submission; trigger edit conflict!\n" );
1593 } else {
1594 // New comment; suppress conflict.
1595 $this->isConflict = false;
1596 wfDebug( __METHOD__ . ": conflict suppressed; new section\n" );
1598 } elseif ( $this->section == '' && Revision::userWasLastToEdit( DB_MASTER, $this->mTitle->getArticleID(),
1599 $wgUser->getId(), $this->edittime ) ) {
1600 # Suppress edit conflict with self, except for section edits where merging is required.
1601 wfDebug( __METHOD__ . ": Suppressing edit conflict, same user.\n" );
1602 $this->isConflict = false;
1606 // If sectiontitle is set, use it, otherwise use the summary as the section title (for
1607 // backwards compatibility with old forms/bots).
1608 if ( $this->sectiontitle !== '' ) {
1609 $sectionTitle = $this->sectiontitle;
1610 } else {
1611 $sectionTitle = $this->summary;
1614 $content = null;
1616 if ( $this->isConflict ) {
1617 wfDebug( __METHOD__ . ": conflict! getting section '{$this->section}' for time '{$this->edittime}'"
1618 . " (article time '{$timestamp}')\n" );
1620 $content = $this->mArticle->replaceSectionContent( $this->section, $textbox_content, $sectionTitle, $this->edittime );
1621 } else {
1622 wfDebug( __METHOD__ . ": getting section '{$this->section}'\n" );
1623 $content = $this->mArticle->replaceSectionContent( $this->section, $textbox_content, $sectionTitle );
1626 if ( is_null( $content ) ) {
1627 wfDebug( __METHOD__ . ": activating conflict; section replace failed.\n" );
1628 $this->isConflict = true;
1629 $content = $textbox_content; // do not try to merge here!
1630 } elseif ( $this->isConflict ) {
1631 # Attempt merge
1632 if ( $this->mergeChangesIntoContent( $content ) ) {
1633 // Successful merge! Maybe we should tell the user the good news?
1634 $this->isConflict = false;
1635 wfDebug( __METHOD__ . ": Suppressing edit conflict, successful merge.\n" );
1636 } else {
1637 $this->section = '';
1638 $this->textbox1 = ContentHandler::getContentText( $content );
1639 wfDebug( __METHOD__ . ": Keeping edit conflict, failed merge.\n" );
1643 if ( $this->isConflict ) {
1644 $status->setResult( false, self::AS_CONFLICT_DETECTED );
1645 wfProfileOut( __METHOD__ );
1646 return $status;
1649 if ( !$this->runPostMergeFilters( $content, $status, $wgUser ) ) {
1650 wfProfileOut( __METHOD__ );
1651 return $status;
1654 if ( $this->section == 'new' ) {
1655 // Handle the user preference to force summaries here
1656 if ( !$this->allowBlankSummary && trim( $this->summary ) == '' ) {
1657 $this->missingSummary = true;
1658 $status->fatal( 'missingsummary' ); // or 'missingcommentheader' if $section == 'new'. Blegh
1659 $status->value = self::AS_SUMMARY_NEEDED;
1660 wfProfileOut( __METHOD__ );
1661 return $status;
1664 // Do not allow the user to post an empty comment
1665 if ( $this->textbox1 == '' ) {
1666 $this->missingComment = true;
1667 $status->fatal( 'missingcommenttext' );
1668 $status->value = self::AS_TEXTBOX_EMPTY;
1669 wfProfileOut( __METHOD__ );
1670 return $status;
1672 } elseif ( !$this->allowBlankSummary
1673 && !$content->equals( $this->getOriginalContent() )
1674 && !$content->isRedirect()
1675 && md5( $this->summary ) == $this->autoSumm
1677 $this->missingSummary = true;
1678 $status->fatal( 'missingsummary' );
1679 $status->value = self::AS_SUMMARY_NEEDED;
1680 wfProfileOut( __METHOD__ );
1681 return $status;
1684 # All's well
1685 wfProfileIn( __METHOD__ . '-sectionanchor' );
1686 $sectionanchor = '';
1687 if ( $this->section == 'new' ) {
1688 if ( $this->sectiontitle !== '' ) {
1689 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $this->sectiontitle );
1690 // If no edit summary was specified, create one automatically from the section
1691 // title and have it link to the new section. Otherwise, respect the summary as
1692 // passed.
1693 if ( $this->summary === '' ) {
1694 $cleanSectionTitle = $wgParser->stripSectionName( $this->sectiontitle );
1695 $this->summary = wfMessage( 'newsectionsummary' )
1696 ->rawParams( $cleanSectionTitle )->inContentLanguage()->text();
1698 } elseif ( $this->summary !== '' ) {
1699 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $this->summary );
1700 # This is a new section, so create a link to the new section
1701 # in the revision summary.
1702 $cleanSummary = $wgParser->stripSectionName( $this->summary );
1703 $this->summary = wfMessage( 'newsectionsummary' )
1704 ->rawParams( $cleanSummary )->inContentLanguage()->text();
1706 } elseif ( $this->section != '' ) {
1707 # Try to get a section anchor from the section source, redirect to edited section if header found
1708 # XXX: might be better to integrate this into Article::replaceSection
1709 # for duplicate heading checking and maybe parsing
1710 $hasmatch = preg_match( "/^ *([=]{1,6})(.*?)(\\1) *\\n/i", $this->textbox1, $matches );
1711 # we can't deal with anchors, includes, html etc in the header for now,
1712 # headline would need to be parsed to improve this
1713 if ( $hasmatch && strlen( $matches[2] ) > 0 ) {
1714 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $matches[2] );
1717 $result['sectionanchor'] = $sectionanchor;
1718 wfProfileOut( __METHOD__ . '-sectionanchor' );
1720 // Save errors may fall down to the edit form, but we've now
1721 // merged the section into full text. Clear the section field
1722 // so that later submission of conflict forms won't try to
1723 // replace that into a duplicated mess.
1724 $this->textbox1 = $this->toEditText( $content );
1725 $this->section = '';
1727 $status->value = self::AS_SUCCESS_UPDATE;
1730 // Check for length errors again now that the section is merged in
1731 $this->kblength = (int)( strlen( $this->toEditText( $content ) ) / 1024 );
1732 if ( $this->kblength > $wgMaxArticleSize ) {
1733 $this->tooBig = true;
1734 $status->setResult( false, self::AS_MAX_ARTICLE_SIZE_EXCEEDED );
1735 wfProfileOut( __METHOD__ );
1736 return $status;
1739 $flags = EDIT_DEFER_UPDATES | EDIT_AUTOSUMMARY |
1740 ( $new ? EDIT_NEW : EDIT_UPDATE ) |
1741 ( ( $this->minoredit && !$this->isNew ) ? EDIT_MINOR : 0 ) |
1742 ( $bot ? EDIT_FORCE_BOT : 0 );
1744 $doEditStatus = $this->mArticle->doEditContent( $content, $this->summary, $flags,
1745 false, null, $this->contentFormat );
1747 if ( !$doEditStatus->isOK() ) {
1748 // Failure from doEdit()
1749 // Show the edit conflict page for certain recognized errors from doEdit(),
1750 // but don't show it for errors from extension hooks
1751 $errors = $doEditStatus->getErrorsArray();
1752 if ( in_array( $errors[0][0], array( 'edit-gone-missing', 'edit-conflict',
1753 'edit-already-exists' ) ) )
1755 $this->isConflict = true;
1756 // Destroys data doEdit() put in $status->value but who cares
1757 $doEditStatus->value = self::AS_END;
1759 wfProfileOut( __METHOD__ );
1760 return $doEditStatus;
1763 $result['nullEdit'] = $doEditStatus->hasMessage( 'edit-no-change' );
1764 $result['redirect'] = $content->isRedirect();
1765 $this->updateWatchlist();
1766 wfProfileOut( __METHOD__ );
1767 return $status;
1771 * Register the change of watch status
1773 protected function updateWatchlist() {
1774 global $wgUser;
1776 if ( $wgUser->isLoggedIn()
1777 && $this->watchthis != $wgUser->isWatched( $this->mTitle, WatchedItem::IGNORE_USER_RIGHTS )
1779 $fname = __METHOD__;
1780 $title = $this->mTitle;
1781 $watch = $this->watchthis;
1783 // Do this in its own transaction to reduce contention...
1784 $dbw = wfGetDB( DB_MASTER );
1785 $dbw->onTransactionIdle( function() use ( $dbw, $title, $watch, $wgUser, $fname ) {
1786 $dbw->begin( $fname );
1787 WatchAction::doWatchOrUnwatch( $watch, $title, $wgUser );
1788 $dbw->commit( $fname );
1789 } );
1794 * Attempts to merge text content with base and current revisions
1796 * @param $editText string
1798 * @return bool
1799 * @deprecated since 1.21, use mergeChangesIntoContent() instead
1801 function mergeChangesInto( &$editText ) {
1802 ContentHandler::deprecated( __METHOD__, "1.21" );
1804 $editContent = $this->toEditContent( $editText );
1806 $ok = $this->mergeChangesIntoContent( $editContent );
1808 if ( $ok ) {
1809 $editText = $this->toEditText( $editContent );
1810 return true;
1812 return false;
1816 * Attempts to do 3-way merge of edit content with a base revision
1817 * and current content, in case of edit conflict, in whichever way appropriate
1818 * for the content type.
1820 * @since 1.21
1822 * @param $editContent
1824 * @return bool
1826 private function mergeChangesIntoContent( &$editContent ) {
1827 wfProfileIn( __METHOD__ );
1829 $db = wfGetDB( DB_MASTER );
1831 // This is the revision the editor started from
1832 $baseRevision = $this->getBaseRevision();
1833 $baseContent = $baseRevision ? $baseRevision->getContent() : null;
1835 if ( is_null( $baseContent ) ) {
1836 wfProfileOut( __METHOD__ );
1837 return false;
1840 // The current state, we want to merge updates into it
1841 $currentRevision = Revision::loadFromTitle( $db, $this->mTitle );
1842 $currentContent = $currentRevision ? $currentRevision->getContent() : null;
1844 if ( is_null( $currentContent ) ) {
1845 wfProfileOut( __METHOD__ );
1846 return false;
1849 $handler = ContentHandler::getForModelID( $baseContent->getModel() );
1851 $result = $handler->merge3( $baseContent, $editContent, $currentContent );
1853 if ( $result ) {
1854 $editContent = $result;
1855 wfProfileOut( __METHOD__ );
1856 return true;
1859 wfProfileOut( __METHOD__ );
1860 return false;
1864 * @return Revision
1866 function getBaseRevision() {
1867 if ( !$this->mBaseRevision ) {
1868 $db = wfGetDB( DB_MASTER );
1869 $baseRevision = Revision::loadFromTimestamp(
1870 $db, $this->mTitle, $this->edittime );
1871 return $this->mBaseRevision = $baseRevision;
1872 } else {
1873 return $this->mBaseRevision;
1878 * Check given input text against $wgSpamRegex, and return the text of the first match.
1880 * @param $text string
1882 * @return string|bool matching string or false
1884 public static function matchSpamRegex( $text ) {
1885 global $wgSpamRegex;
1886 // For back compatibility, $wgSpamRegex may be a single string or an array of regexes.
1887 $regexes = (array)$wgSpamRegex;
1888 return self::matchSpamRegexInternal( $text, $regexes );
1892 * Check given input text against $wgSpamRegex, and return the text of the first match.
1894 * @param $text string
1896 * @return string|bool matching string or false
1898 public static function matchSummarySpamRegex( $text ) {
1899 global $wgSummarySpamRegex;
1900 $regexes = (array)$wgSummarySpamRegex;
1901 return self::matchSpamRegexInternal( $text, $regexes );
1905 * @param $text string
1906 * @param $regexes array
1907 * @return bool|string
1909 protected static function matchSpamRegexInternal( $text, $regexes ) {
1910 foreach ( $regexes as $regex ) {
1911 $matches = array();
1912 if ( preg_match( $regex, $text, $matches ) ) {
1913 return $matches[0];
1916 return false;
1919 function setHeaders() {
1920 global $wgOut, $wgUser;
1922 $wgOut->addModules( 'mediawiki.action.edit' );
1924 if ( $wgUser->getOption( 'uselivepreview', false ) ) {
1925 $wgOut->addModules( 'mediawiki.action.edit.preview' );
1928 if ( $wgUser->getOption( 'useeditwarning', false ) ) {
1929 $wgOut->addModules( 'mediawiki.action.edit.editWarning' );
1932 // Bug #19334: textarea jumps when editing articles in IE8
1933 $wgOut->addStyle( 'common/IE80Fixes.css', 'screen', 'IE 8' );
1935 $wgOut->setRobotPolicy( 'noindex,nofollow' );
1937 # Enabled article-related sidebar, toplinks, etc.
1938 $wgOut->setArticleRelated( true );
1940 $contextTitle = $this->getContextTitle();
1941 if ( $this->isConflict ) {
1942 $msg = 'editconflict';
1943 } elseif ( $contextTitle->exists() && $this->section != '' ) {
1944 $msg = $this->section == 'new' ? 'editingcomment' : 'editingsection';
1945 } else {
1946 $msg = $contextTitle->exists() || ( $contextTitle->getNamespace() == NS_MEDIAWIKI && $contextTitle->getDefaultMessageText() !== false ) ?
1947 'editing' : 'creating';
1949 # Use the title defined by DISPLAYTITLE magic word when present
1950 $displayTitle = isset( $this->mParserOutput ) ? $this->mParserOutput->getDisplayTitle() : false;
1951 if ( $displayTitle === false ) {
1952 $displayTitle = $contextTitle->getPrefixedText();
1954 $wgOut->setPageTitle( wfMessage( $msg, $displayTitle ) );
1958 * Show all applicable editing introductions
1960 protected function showIntro() {
1961 global $wgOut, $wgUser;
1962 if ( $this->suppressIntro ) {
1963 return;
1966 $namespace = $this->mTitle->getNamespace();
1968 if ( $namespace == NS_MEDIAWIKI ) {
1969 # Show a warning if editing an interface message
1970 $wgOut->wrapWikiMsg( "<div class='mw-editinginterface'>\n$1\n</div>", 'editinginterface' );
1971 } elseif ( $namespace == NS_FILE ) {
1972 # Show a hint to shared repo
1973 $file = wfFindFile( $this->mTitle );
1974 if ( $file && !$file->isLocal() ) {
1975 $descUrl = $file->getDescriptionUrl();
1976 # there must be a description url to show a hint to shared repo
1977 if ( $descUrl ) {
1978 if ( !$this->mTitle->exists() ) {
1979 $wgOut->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-create\">\n$1\n</div>", array(
1980 'sharedupload-desc-create', $file->getRepo()->getDisplayName(), $descUrl
1981 ) );
1982 } else {
1983 $wgOut->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-edit\">\n$1\n</div>", array(
1984 'sharedupload-desc-edit', $file->getRepo()->getDisplayName(), $descUrl
1985 ) );
1991 # Show a warning message when someone creates/edits a user (talk) page but the user does not exist
1992 # Show log extract when the user is currently blocked
1993 if ( $namespace == NS_USER || $namespace == NS_USER_TALK ) {
1994 $parts = explode( '/', $this->mTitle->getText(), 2 );
1995 $username = $parts[0];
1996 $user = User::newFromName( $username, false /* allow IP users*/ );
1997 $ip = User::isIP( $username );
1998 if ( !( $user && $user->isLoggedIn() ) && !$ip ) { # User does not exist
1999 $wgOut->wrapWikiMsg( "<div class=\"mw-userpage-userdoesnotexist error\">\n$1\n</div>",
2000 array( 'userpage-userdoesnotexist', wfEscapeWikiText( $username ) ) );
2001 } elseif ( $user->isBlocked() ) { # Show log extract if the user is currently blocked
2002 LogEventsList::showLogExtract(
2003 $wgOut,
2004 'block',
2005 $user->getUserPage(),
2007 array(
2008 'lim' => 1,
2009 'showIfEmpty' => false,
2010 'msgKey' => array(
2011 'blocked-notice-logextract',
2012 $user->getName() # Support GENDER in notice
2018 # Try to add a custom edit intro, or use the standard one if this is not possible.
2019 if ( !$this->showCustomIntro() && !$this->mTitle->exists() ) {
2020 if ( $wgUser->isLoggedIn() ) {
2021 $wgOut->wrapWikiMsg( "<div class=\"mw-newarticletext\">\n$1\n</div>", 'newarticletext' );
2022 } else {
2023 $wgOut->wrapWikiMsg( "<div class=\"mw-newarticletextanon\">\n$1\n</div>", 'newarticletextanon' );
2026 # Give a notice if the user is editing a deleted/moved page...
2027 if ( !$this->mTitle->exists() ) {
2028 LogEventsList::showLogExtract( $wgOut, array( 'delete', 'move' ), $this->mTitle,
2030 array(
2031 'lim' => 10,
2032 'conds' => array( "log_action != 'revision'" ),
2033 'showIfEmpty' => false,
2034 'msgKey' => array( 'recreate-moveddeleted-warn' )
2041 * Attempt to show a custom editing introduction, if supplied
2043 * @return bool
2045 protected function showCustomIntro() {
2046 if ( $this->editintro ) {
2047 $title = Title::newFromText( $this->editintro );
2048 if ( $title instanceof Title && $title->exists() && $title->userCan( 'read' ) ) {
2049 global $wgOut;
2050 // Added using template syntax, to take <noinclude>'s into account.
2051 $wgOut->addWikiTextTitleTidy( '{{:' . $title->getFullText() . '}}', $this->mTitle );
2052 return true;
2055 return false;
2059 * Gets an editable textual representation of $content.
2060 * The textual representation can be turned by into a Content object by the
2061 * toEditContent() method.
2063 * If $content is null or false or a string, $content is returned unchanged.
2065 * If the given Content object is not of a type that can be edited using the text base EditPage,
2066 * an exception will be raised. Set $this->allowNonTextContent to true to allow editing of non-textual
2067 * content.
2069 * @param Content|null|bool|string $content
2070 * @return String the editable text form of the content.
2072 * @throws MWException if $content is not an instance of TextContent and $this->allowNonTextContent is not true.
2074 protected function toEditText( $content ) {
2075 if ( $content === null || $content === false ) {
2076 return $content;
2079 if ( is_string( $content ) ) {
2080 return $content;
2083 if ( !$this->allowNonTextContent && !( $content instanceof TextContent ) ) {
2084 throw new MWException( "This content model can not be edited as text: "
2085 . ContentHandler::getLocalizedName( $content->getModel() ) );
2088 return $content->serialize( $this->contentFormat );
2092 * Turns the given text into a Content object by unserializing it.
2094 * If the resulting Content object is not of a type that can be edited using the text base EditPage,
2095 * an exception will be raised. Set $this->allowNonTextContent to true to allow editing of non-textual
2096 * content.
2098 * @param string|null|bool $text Text to unserialize
2099 * @return Content The content object created from $text. If $text was false or null, false resp. null will be
2100 * returned instead.
2102 * @throws MWException if unserializing the text results in a Content object that is not an instance of TextContent
2103 * and $this->allowNonTextContent is not true.
2105 protected function toEditContent( $text ) {
2106 if ( $text === false || $text === null ) {
2107 return $text;
2110 $content = ContentHandler::makeContent( $text, $this->getTitle(),
2111 $this->contentModel, $this->contentFormat );
2113 if ( !$this->allowNonTextContent && !( $content instanceof TextContent ) ) {
2114 throw new MWException( "This content model can not be edited as text: "
2115 . ContentHandler::getLocalizedName( $content->getModel() ) );
2118 return $content;
2122 * Send the edit form and related headers to $wgOut
2123 * @param $formCallback Callback|null that takes an OutputPage parameter; will be called
2124 * during form output near the top, for captchas and the like.
2126 function showEditForm( $formCallback = null ) {
2127 global $wgOut, $wgUser;
2129 wfProfileIn( __METHOD__ );
2131 # need to parse the preview early so that we know which templates are used,
2132 # otherwise users with "show preview after edit box" will get a blank list
2133 # we parse this near the beginning so that setHeaders can do the title
2134 # setting work instead of leaving it in getPreviewText
2135 $previewOutput = '';
2136 if ( $this->formtype == 'preview' ) {
2137 $previewOutput = $this->getPreviewText();
2140 wfRunHooks( 'EditPage::showEditForm:initial', array( &$this, &$wgOut ) );
2142 $this->setHeaders();
2144 if ( $this->showHeader() === false ) {
2145 wfProfileOut( __METHOD__ );
2146 return;
2149 $wgOut->addHTML( $this->editFormPageTop );
2151 if ( $wgUser->getOption( 'previewontop' ) ) {
2152 $this->displayPreviewArea( $previewOutput, true );
2155 $wgOut->addHTML( $this->editFormTextTop );
2157 $showToolbar = true;
2158 if ( $this->wasDeletedSinceLastEdit() ) {
2159 if ( $this->formtype == 'save' ) {
2160 // Hide the toolbar and edit area, user can click preview to get it back
2161 // Add an confirmation checkbox and explanation.
2162 $showToolbar = false;
2163 } else {
2164 $wgOut->wrapWikiMsg( "<div class='error mw-deleted-while-editing'>\n$1\n</div>",
2165 'deletedwhileediting' );
2169 // @todo add EditForm plugin interface and use it here!
2170 // search for textarea1 and textares2, and allow EditForm to override all uses.
2171 $wgOut->addHTML( Html::openElement( 'form', array( 'id' => self::EDITFORM_ID, 'name' => self::EDITFORM_ID,
2172 'method' => 'post', 'action' => $this->getActionURL( $this->getContextTitle() ),
2173 'enctype' => 'multipart/form-data' ) ) );
2175 if ( is_callable( $formCallback ) ) {
2176 call_user_func_array( $formCallback, array( &$wgOut ) );
2179 wfRunHooks( 'EditPage::showEditForm:fields', array( &$this, &$wgOut ) );
2181 // Put these up at the top to ensure they aren't lost on early form submission
2182 $this->showFormBeforeText();
2184 if ( $this->wasDeletedSinceLastEdit() && 'save' == $this->formtype ) {
2185 $username = $this->lastDelete->user_name;
2186 $comment = $this->lastDelete->log_comment;
2188 // It is better to not parse the comment at all than to have templates expanded in the middle
2189 // TODO: can the checkLabel be moved outside of the div so that wrapWikiMsg could be used?
2190 $key = $comment === ''
2191 ? 'confirmrecreate-noreason'
2192 : 'confirmrecreate';
2193 $wgOut->addHTML(
2194 '<div class="mw-confirm-recreate">' .
2195 wfMessage( $key, $username, "<nowiki>$comment</nowiki>" )->parse() .
2196 Xml::checkLabel( wfMessage( 'recreate' )->text(), 'wpRecreate', 'wpRecreate', false,
2197 array( 'title' => Linker::titleAttrib( 'recreate' ), 'tabindex' => 1, 'id' => 'wpRecreate' )
2199 '</div>'
2203 # When the summary is hidden, also hide them on preview/show changes
2204 if ( $this->nosummary ) {
2205 $wgOut->addHTML( Html::hidden( 'nosummary', true ) );
2208 # If a blank edit summary was previously provided, and the appropriate
2209 # user preference is active, pass a hidden tag as wpIgnoreBlankSummary. This will stop the
2210 # user being bounced back more than once in the event that a summary
2211 # is not required.
2212 #####
2213 # For a bit more sophisticated detection of blank summaries, hash the
2214 # automatic one and pass that in the hidden field wpAutoSummary.
2215 if ( $this->missingSummary || ( $this->section == 'new' && $this->nosummary ) ) {
2216 $wgOut->addHTML( Html::hidden( 'wpIgnoreBlankSummary', true ) );
2219 if ( $this->undidRev ) {
2220 $wgOut->addHTML( Html::hidden( 'wpUndidRevision', $this->undidRev ) );
2223 if ( $this->hasPresetSummary ) {
2224 // If a summary has been preset using &summary= we don't want to prompt for
2225 // a different summary. Only prompt for a summary if the summary is blanked.
2226 // (Bug 17416)
2227 $this->autoSumm = md5( '' );
2230 $autosumm = $this->autoSumm ? $this->autoSumm : md5( $this->summary );
2231 $wgOut->addHTML( Html::hidden( 'wpAutoSummary', $autosumm ) );
2233 $wgOut->addHTML( Html::hidden( 'oldid', $this->oldid ) );
2235 $wgOut->addHTML( Html::hidden( 'format', $this->contentFormat ) );
2236 $wgOut->addHTML( Html::hidden( 'model', $this->contentModel ) );
2238 if ( $this->section == 'new' ) {
2239 $this->showSummaryInput( true, $this->summary );
2240 $wgOut->addHTML( $this->getSummaryPreview( true, $this->summary ) );
2243 $wgOut->addHTML( $this->editFormTextBeforeContent );
2245 if ( !$this->isCssJsSubpage && $showToolbar && $wgUser->getOption( 'showtoolbar' ) ) {
2246 $wgOut->addHTML( EditPage::getEditToolbar() );
2249 if ( $this->isConflict ) {
2250 // In an edit conflict bypass the overridable content form method
2251 // and fallback to the raw wpTextbox1 since editconflicts can't be
2252 // resolved between page source edits and custom ui edits using the
2253 // custom edit ui.
2254 $this->textbox2 = $this->textbox1;
2256 $content = $this->getCurrentContent();
2257 $this->textbox1 = $this->toEditText( $content );
2259 $this->showTextbox1();
2260 } else {
2261 $this->showContentForm();
2264 $wgOut->addHTML( $this->editFormTextAfterContent );
2266 $this->showStandardInputs();
2268 $this->showFormAfterText();
2270 $this->showTosSummary();
2272 $this->showEditTools();
2274 $wgOut->addHTML( $this->editFormTextAfterTools . "\n" );
2276 $wgOut->addHTML( Html::rawElement( 'div', array( 'class' => 'templatesUsed' ),
2277 Linker::formatTemplates( $this->getTemplates(), $this->preview, $this->section != '' ) ) );
2279 $wgOut->addHTML( Html::rawElement( 'div', array( 'class' => 'hiddencats' ),
2280 Linker::formatHiddenCategories( $this->mArticle->getHiddenCategories() ) ) );
2282 $wgOut->addModules( 'mediawiki.action.edit.collapsibleFooter' );
2284 if ( $this->isConflict ) {
2285 try {
2286 $this->showConflict();
2287 } catch ( MWContentSerializationException $ex ) {
2288 // this can't really happen, but be nice if it does.
2289 $msg = wfMessage( 'content-failed-to-parse', $this->contentModel, $this->contentFormat, $ex->getMessage() );
2290 $wgOut->addWikiText( '<div class="error">' . $msg->text() . '</div>' );
2294 $wgOut->addHTML( $this->editFormTextBottom . "\n</form>\n" );
2296 if ( !$wgUser->getOption( 'previewontop' ) ) {
2297 $this->displayPreviewArea( $previewOutput, false );
2300 wfProfileOut( __METHOD__ );
2304 * Extract the section title from current section text, if any.
2306 * @param string $text
2307 * @return Mixed|string or false
2309 public static function extractSectionTitle( $text ) {
2310 preg_match( "/^(=+)(.+)\\1\\s*(\n|$)/i", $text, $matches );
2311 if ( !empty( $matches[2] ) ) {
2312 global $wgParser;
2313 return $wgParser->stripSectionName( trim( $matches[2] ) );
2314 } else {
2315 return false;
2319 protected function showHeader() {
2320 global $wgOut, $wgUser, $wgMaxArticleSize, $wgLang;
2322 if ( $this->mTitle->isTalkPage() ) {
2323 $wgOut->addWikiMsg( 'talkpagetext' );
2326 // Add edit notices
2327 $wgOut->addHTML( implode( "\n", $this->mTitle->getEditNotices( $this->oldid ) ) );
2329 if ( $this->isConflict ) {
2330 $wgOut->wrapWikiMsg( "<div class='mw-explainconflict'>\n$1\n</div>", 'explainconflict' );
2331 $this->edittime = $this->mArticle->getTimestamp();
2332 } else {
2333 if ( $this->section != '' && !$this->isSectionEditSupported() ) {
2334 // We use $this->section to much before this and getVal('wgSection') directly in other places
2335 // at this point we can't reset $this->section to '' to fallback to non-section editing.
2336 // Someone is welcome to try refactoring though
2337 $wgOut->showErrorPage( 'sectioneditnotsupported-title', 'sectioneditnotsupported-text' );
2338 return false;
2341 if ( $this->section != '' && $this->section != 'new' ) {
2342 if ( !$this->summary && !$this->preview && !$this->diff ) {
2343 $sectionTitle = self::extractSectionTitle( $this->textbox1 ); //FIXME: use Content object
2344 if ( $sectionTitle !== false ) {
2345 $this->summary = "/* $sectionTitle */ ";
2350 if ( $this->missingComment ) {
2351 $wgOut->wrapWikiMsg( "<div id='mw-missingcommenttext'>\n$1\n</div>", 'missingcommenttext' );
2354 if ( $this->missingSummary && $this->section != 'new' ) {
2355 $wgOut->wrapWikiMsg( "<div id='mw-missingsummary'>\n$1\n</div>", 'missingsummary' );
2358 if ( $this->missingSummary && $this->section == 'new' ) {
2359 $wgOut->wrapWikiMsg( "<div id='mw-missingcommentheader'>\n$1\n</div>", 'missingcommentheader' );
2362 if ( $this->hookError !== '' ) {
2363 $wgOut->addWikiText( $this->hookError );
2366 if ( !$this->checkUnicodeCompliantBrowser() ) {
2367 $wgOut->addWikiMsg( 'nonunicodebrowser' );
2370 if ( $this->section != 'new' ) {
2371 $revision = $this->mArticle->getRevisionFetched();
2372 if ( $revision ) {
2373 // Let sysop know that this will make private content public if saved
2375 if ( !$revision->userCan( Revision::DELETED_TEXT, $wgUser ) ) {
2376 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n", 'rev-deleted-text-permission' );
2377 } elseif ( $revision->isDeleted( Revision::DELETED_TEXT ) ) {
2378 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n", 'rev-deleted-text-view' );
2381 if ( !$revision->isCurrent() ) {
2382 $this->mArticle->setOldSubtitle( $revision->getId() );
2383 $wgOut->addWikiMsg( 'editingold' );
2385 } elseif ( $this->mTitle->exists() ) {
2386 // Something went wrong
2388 $wgOut->wrapWikiMsg( "<div class='errorbox'>\n$1\n</div>\n",
2389 array( 'missing-revision', $this->oldid ) );
2394 if ( wfReadOnly() ) {
2395 $wgOut->wrapWikiMsg( "<div id=\"mw-read-only-warning\">\n$1\n</div>", array( 'readonlywarning', wfReadOnlyReason() ) );
2396 } elseif ( $wgUser->isAnon() ) {
2397 if ( $this->formtype != 'preview' ) {
2398 $wgOut->wrapWikiMsg( "<div id=\"mw-anon-edit-warning\">\n$1</div>", 'anoneditwarning' );
2399 } else {
2400 $wgOut->wrapWikiMsg( "<div id=\"mw-anon-preview-warning\">\n$1</div>", 'anonpreviewwarning' );
2402 } else {
2403 if ( $this->isCssJsSubpage ) {
2404 # Check the skin exists
2405 if ( $this->isWrongCaseCssJsPage ) {
2406 $wgOut->wrapWikiMsg( "<div class='error' id='mw-userinvalidcssjstitle'>\n$1\n</div>", array( 'userinvalidcssjstitle', $this->mTitle->getSkinFromCssJsSubpage() ) );
2408 if ( $this->formtype !== 'preview' ) {
2409 if ( $this->isCssSubpage ) {
2410 $wgOut->wrapWikiMsg( "<div id='mw-usercssyoucanpreview'>\n$1\n</div>", array( 'usercssyoucanpreview' ) );
2413 if ( $this->isJsSubpage ) {
2414 $wgOut->wrapWikiMsg( "<div id='mw-userjsyoucanpreview'>\n$1\n</div>", array( 'userjsyoucanpreview' ) );
2420 if ( $this->mTitle->getNamespace() != NS_MEDIAWIKI && $this->mTitle->isProtected( 'edit' ) ) {
2421 # Is the title semi-protected?
2422 if ( $this->mTitle->isSemiProtected() ) {
2423 $noticeMsg = 'semiprotectedpagewarning';
2424 } else {
2425 # Then it must be protected based on static groups (regular)
2426 $noticeMsg = 'protectedpagewarning';
2428 LogEventsList::showLogExtract( $wgOut, 'protect', $this->mTitle, '',
2429 array( 'lim' => 1, 'msgKey' => array( $noticeMsg ) ) );
2431 if ( $this->mTitle->isCascadeProtected() ) {
2432 # Is this page under cascading protection from some source pages?
2433 list( $cascadeSources, /* $restrictions */ ) = $this->mTitle->getCascadeProtectionSources();
2434 $notice = "<div class='mw-cascadeprotectedwarning'>\n$1\n";
2435 $cascadeSourcesCount = count( $cascadeSources );
2436 if ( $cascadeSourcesCount > 0 ) {
2437 # Explain, and list the titles responsible
2438 foreach ( $cascadeSources as $page ) {
2439 $notice .= '* [[:' . $page->getPrefixedText() . "]]\n";
2442 $notice .= '</div>';
2443 $wgOut->wrapWikiMsg( $notice, array( 'cascadeprotectedwarning', $cascadeSourcesCount ) );
2445 if ( !$this->mTitle->exists() && $this->mTitle->getRestrictions( 'create' ) ) {
2446 LogEventsList::showLogExtract( $wgOut, 'protect', $this->mTitle, '',
2447 array( 'lim' => 1,
2448 'showIfEmpty' => false,
2449 'msgKey' => array( 'titleprotectedwarning' ),
2450 'wrap' => "<div class=\"mw-titleprotectedwarning\">\n$1</div>" ) );
2453 if ( $this->kblength === false ) {
2454 $this->kblength = (int)( strlen( $this->textbox1 ) / 1024 );
2457 if ( $this->tooBig || $this->kblength > $wgMaxArticleSize ) {
2458 $wgOut->wrapWikiMsg( "<div class='error' id='mw-edit-longpageerror'>\n$1\n</div>",
2459 array( 'longpageerror', $wgLang->formatNum( $this->kblength ), $wgLang->formatNum( $wgMaxArticleSize ) ) );
2460 } else {
2461 if ( !wfMessage( 'longpage-hint' )->isDisabled() ) {
2462 $wgOut->wrapWikiMsg( "<div id='mw-edit-longpage-hint'>\n$1\n</div>",
2463 array( 'longpage-hint', $wgLang->formatSize( strlen( $this->textbox1 ) ), strlen( $this->textbox1 ) )
2467 # Add header copyright warning
2468 $this->showHeaderCopyrightWarning();
2472 * Standard summary input and label (wgSummary), abstracted so EditPage
2473 * subclasses may reorganize the form.
2474 * Note that you do not need to worry about the label's for=, it will be
2475 * inferred by the id given to the input. You can remove them both by
2476 * passing array( 'id' => false ) to $userInputAttrs.
2478 * @param string $summary The value of the summary input
2479 * @param string $labelText The html to place inside the label
2480 * @param array $inputAttrs of attrs to use on the input
2481 * @param array $spanLabelAttrs of attrs to use on the span inside the label
2483 * @return array An array in the format array( $label, $input )
2485 function getSummaryInput( $summary = "", $labelText = null, $inputAttrs = null, $spanLabelAttrs = null ) {
2486 // Note: the maxlength is overridden in JS to 255 and to make it use UTF-8 bytes, not characters.
2487 $inputAttrs = ( is_array( $inputAttrs ) ? $inputAttrs : array() ) + array(
2488 'id' => 'wpSummary',
2489 'maxlength' => '200',
2490 'tabindex' => '1',
2491 'size' => 60,
2492 'spellcheck' => 'true',
2493 ) + Linker::tooltipAndAccesskeyAttribs( 'summary' );
2495 $spanLabelAttrs = ( is_array( $spanLabelAttrs ) ? $spanLabelAttrs : array() ) + array(
2496 'class' => $this->missingSummary ? 'mw-summarymissed' : 'mw-summary',
2497 'id' => "wpSummaryLabel"
2500 $label = null;
2501 if ( $labelText ) {
2502 $label = Xml::tags( 'label', $inputAttrs['id'] ? array( 'for' => $inputAttrs['id'] ) : null, $labelText );
2503 $label = Xml::tags( 'span', $spanLabelAttrs, $label );
2506 $input = Html::input( 'wpSummary', $summary, 'text', $inputAttrs );
2508 return array( $label, $input );
2512 * @param $isSubjectPreview Boolean: true if this is the section subject/title
2513 * up top, or false if this is the comment summary
2514 * down below the textarea
2515 * @param string $summary The text of the summary to display
2516 * @return String
2518 protected function showSummaryInput( $isSubjectPreview, $summary = "" ) {
2519 global $wgOut, $wgContLang;
2520 # Add a class if 'missingsummary' is triggered to allow styling of the summary line
2521 $summaryClass = $this->missingSummary ? 'mw-summarymissed' : 'mw-summary';
2522 if ( $isSubjectPreview ) {
2523 if ( $this->nosummary ) {
2524 return;
2526 } else {
2527 if ( !$this->mShowSummaryField ) {
2528 return;
2531 $summary = $wgContLang->recodeForEdit( $summary );
2532 $labelText = wfMessage( $isSubjectPreview ? 'subject' : 'summary' )->parse();
2533 list( $label, $input ) = $this->getSummaryInput( $summary, $labelText, array( 'class' => $summaryClass ), array() );
2534 $wgOut->addHTML( "{$label} {$input}" );
2538 * @param $isSubjectPreview Boolean: true if this is the section subject/title
2539 * up top, or false if this is the comment summary
2540 * down below the textarea
2541 * @param string $summary the text of the summary to display
2542 * @return String
2544 protected function getSummaryPreview( $isSubjectPreview, $summary = "" ) {
2545 // avoid spaces in preview, gets always trimmed on save
2546 $summary = trim( $summary );
2547 if ( !$summary || ( !$this->preview && !$this->diff ) ) {
2548 return "";
2551 global $wgParser;
2553 if ( $isSubjectPreview ) {
2554 $summary = wfMessage( 'newsectionsummary', $wgParser->stripSectionName( $summary ) )
2555 ->inContentLanguage()->text();
2558 $message = $isSubjectPreview ? 'subject-preview' : 'summary-preview';
2560 $summary = wfMessage( $message )->parse() . Linker::commentBlock( $summary, $this->mTitle, $isSubjectPreview );
2561 return Xml::tags( 'div', array( 'class' => 'mw-summary-preview' ), $summary );
2564 protected function showFormBeforeText() {
2565 global $wgOut;
2566 $section = htmlspecialchars( $this->section );
2567 $wgOut->addHTML( <<<HTML
2568 <input type='hidden' value="{$section}" name="wpSection" />
2569 <input type='hidden' value="{$this->starttime}" name="wpStarttime" />
2570 <input type='hidden' value="{$this->edittime}" name="wpEdittime" />
2571 <input type='hidden' value="{$this->scrolltop}" name="wpScrolltop" id="wpScrolltop" />
2573 HTML
2575 if ( !$this->checkUnicodeCompliantBrowser() ) {
2576 $wgOut->addHTML( Html::hidden( 'safemode', '1' ) );
2580 protected function showFormAfterText() {
2581 global $wgOut, $wgUser;
2583 * To make it harder for someone to slip a user a page
2584 * which submits an edit form to the wiki without their
2585 * knowledge, a random token is associated with the login
2586 * session. If it's not passed back with the submission,
2587 * we won't save the page, or render user JavaScript and
2588 * CSS previews.
2590 * For anon editors, who may not have a session, we just
2591 * include the constant suffix to prevent editing from
2592 * broken text-mangling proxies.
2594 $wgOut->addHTML( "\n" . Html::hidden( "wpEditToken", $wgUser->getEditToken() ) . "\n" );
2598 * Subpage overridable method for printing the form for page content editing
2599 * By default this simply outputs wpTextbox1
2600 * Subclasses can override this to provide a custom UI for editing;
2601 * be it a form, or simply wpTextbox1 with a modified content that will be
2602 * reverse modified when extracted from the post data.
2603 * Note that this is basically the inverse for importContentFormData
2605 protected function showContentForm() {
2606 $this->showTextbox1();
2610 * Method to output wpTextbox1
2611 * The $textoverride method can be used by subclasses overriding showContentForm
2612 * to pass back to this method.
2614 * @param array $customAttribs of html attributes to use in the textarea
2615 * @param string $textoverride optional text to override $this->textarea1 with
2617 protected function showTextbox1( $customAttribs = null, $textoverride = null ) {
2618 if ( $this->wasDeletedSinceLastEdit() && $this->formtype == 'save' ) {
2619 $attribs = array( 'style' => 'display:none;' );
2620 } else {
2621 $classes = array(); // Textarea CSS
2622 if ( $this->mTitle->getNamespace() != NS_MEDIAWIKI && $this->mTitle->isProtected( 'edit' ) ) {
2623 # Is the title semi-protected?
2624 if ( $this->mTitle->isSemiProtected() ) {
2625 $classes[] = 'mw-textarea-sprotected';
2626 } else {
2627 # Then it must be protected based on static groups (regular)
2628 $classes[] = 'mw-textarea-protected';
2630 # Is the title cascade-protected?
2631 if ( $this->mTitle->isCascadeProtected() ) {
2632 $classes[] = 'mw-textarea-cprotected';
2636 $attribs = array( 'tabindex' => 1 );
2638 if ( is_array( $customAttribs ) ) {
2639 $attribs += $customAttribs;
2642 if ( count( $classes ) ) {
2643 if ( isset( $attribs['class'] ) ) {
2644 $classes[] = $attribs['class'];
2646 $attribs['class'] = implode( ' ', $classes );
2650 $this->showTextbox( $textoverride !== null ? $textoverride : $this->textbox1, 'wpTextbox1', $attribs );
2653 protected function showTextbox2() {
2654 $this->showTextbox( $this->textbox2, 'wpTextbox2', array( 'tabindex' => 6, 'readonly' ) );
2657 protected function showTextbox( $text, $name, $customAttribs = array() ) {
2658 global $wgOut, $wgUser;
2660 $wikitext = $this->safeUnicodeOutput( $text );
2661 if ( strval( $wikitext ) !== '' ) {
2662 // Ensure there's a newline at the end, otherwise adding lines
2663 // is awkward.
2664 // But don't add a newline if the ext is empty, or Firefox in XHTML
2665 // mode will show an extra newline. A bit annoying.
2666 $wikitext .= "\n";
2669 $attribs = $customAttribs + array(
2670 'accesskey' => ',',
2671 'id' => $name,
2672 'cols' => $wgUser->getIntOption( 'cols' ),
2673 'rows' => $wgUser->getIntOption( 'rows' ),
2674 'style' => '' // avoid php notices when appending preferences (appending allows customAttribs['style'] to still work
2677 $pageLang = $this->mTitle->getPageLanguage();
2678 $attribs['lang'] = $pageLang->getCode();
2679 $attribs['dir'] = $pageLang->getDir();
2681 $wgOut->addHTML( Html::textarea( $name, $wikitext, $attribs ) );
2684 protected function displayPreviewArea( $previewOutput, $isOnTop = false ) {
2685 global $wgOut;
2686 $classes = array();
2687 if ( $isOnTop ) {
2688 $classes[] = 'ontop';
2691 $attribs = array( 'id' => 'wikiPreview', 'class' => implode( ' ', $classes ) );
2693 if ( $this->formtype != 'preview' ) {
2694 $attribs['style'] = 'display: none;';
2697 $wgOut->addHTML( Xml::openElement( 'div', $attribs ) );
2699 if ( $this->formtype == 'preview' ) {
2700 $this->showPreview( $previewOutput );
2703 $wgOut->addHTML( '</div>' );
2705 if ( $this->formtype == 'diff' ) {
2706 try {
2707 $this->showDiff();
2708 } catch ( MWContentSerializationException $ex ) {
2709 $msg = wfMessage( 'content-failed-to-parse', $this->contentModel, $this->contentFormat, $ex->getMessage() );
2710 $wgOut->addWikiText( '<div class="error">' . $msg->text() . '</div>' );
2716 * Append preview output to $wgOut.
2717 * Includes category rendering if this is a category page.
2719 * @param string $text the HTML to be output for the preview.
2721 protected function showPreview( $text ) {
2722 global $wgOut;
2723 if ( $this->mTitle->getNamespace() == NS_CATEGORY ) {
2724 $this->mArticle->openShowCategory();
2726 # This hook seems slightly odd here, but makes things more
2727 # consistent for extensions.
2728 wfRunHooks( 'OutputPageBeforeHTML', array( &$wgOut, &$text ) );
2729 $wgOut->addHTML( $text );
2730 if ( $this->mTitle->getNamespace() == NS_CATEGORY ) {
2731 $this->mArticle->closeShowCategory();
2736 * Get a diff between the current contents of the edit box and the
2737 * version of the page we're editing from.
2739 * If this is a section edit, we'll replace the section as for final
2740 * save and then make a comparison.
2742 function showDiff() {
2743 global $wgUser, $wgContLang, $wgOut;
2745 $oldtitlemsg = 'currentrev';
2746 # if message does not exist, show diff against the preloaded default
2747 if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI && !$this->mTitle->exists() ) {
2748 $oldtext = $this->mTitle->getDefaultMessageText();
2749 if ( $oldtext !== false ) {
2750 $oldtitlemsg = 'defaultmessagetext';
2751 $oldContent = $this->toEditContent( $oldtext );
2752 } else {
2753 $oldContent = null;
2755 } else {
2756 $oldContent = $this->getCurrentContent();
2759 $textboxContent = $this->toEditContent( $this->textbox1 );
2761 $newContent = $this->mArticle->replaceSectionContent(
2762 $this->section, $textboxContent,
2763 $this->summary, $this->edittime );
2765 if ( $newContent ) {
2766 ContentHandler::runLegacyHooks( 'EditPageGetDiffText', array( $this, &$newContent ) );
2767 wfRunHooks( 'EditPageGetDiffContent', array( $this, &$newContent ) );
2769 $popts = ParserOptions::newFromUserAndLang( $wgUser, $wgContLang );
2770 $newContent = $newContent->preSaveTransform( $this->mTitle, $wgUser, $popts );
2773 if ( ( $oldContent && !$oldContent->isEmpty() ) || ( $newContent && !$newContent->isEmpty() ) ) {
2774 $oldtitle = wfMessage( $oldtitlemsg )->parse();
2775 $newtitle = wfMessage( 'yourtext' )->parse();
2777 if ( !$oldContent ) {
2778 $oldContent = $newContent->getContentHandler()->makeEmptyContent();
2781 if ( !$newContent ) {
2782 $newContent = $oldContent->getContentHandler()->makeEmptyContent();
2785 $de = $oldContent->getContentHandler()->createDifferenceEngine( $this->mArticle->getContext() );
2786 $de->setContent( $oldContent, $newContent );
2788 $difftext = $de->getDiff( $oldtitle, $newtitle );
2789 $de->showDiffStyle();
2790 } else {
2791 $difftext = '';
2794 $wgOut->addHTML( '<div id="wikiDiff">' . $difftext . '</div>' );
2798 * Show the header copyright warning.
2800 protected function showHeaderCopyrightWarning() {
2801 $msg = 'editpage-head-copy-warn';
2802 if ( !wfMessage( $msg )->isDisabled() ) {
2803 global $wgOut;
2804 $wgOut->wrapWikiMsg( "<div class='editpage-head-copywarn'>\n$1\n</div>",
2805 'editpage-head-copy-warn' );
2810 * Give a chance for site and per-namespace customizations of
2811 * terms of service summary link that might exist separately
2812 * from the copyright notice.
2814 * This will display between the save button and the edit tools,
2815 * so should remain short!
2817 protected function showTosSummary() {
2818 $msg = 'editpage-tos-summary';
2819 wfRunHooks( 'EditPageTosSummary', array( $this->mTitle, &$msg ) );
2820 if ( !wfMessage( $msg )->isDisabled() ) {
2821 global $wgOut;
2822 $wgOut->addHTML( '<div class="mw-tos-summary">' );
2823 $wgOut->addWikiMsg( $msg );
2824 $wgOut->addHTML( '</div>' );
2828 protected function showEditTools() {
2829 global $wgOut;
2830 $wgOut->addHTML( '<div class="mw-editTools">' .
2831 wfMessage( 'edittools' )->inContentLanguage()->parse() .
2832 '</div>' );
2836 * Get the copyright warning
2838 * Renamed to getCopyrightWarning(), old name kept around for backwards compatibility
2840 protected function getCopywarn() {
2841 return self::getCopyrightWarning( $this->mTitle );
2844 public static function getCopyrightWarning( $title ) {
2845 global $wgRightsText;
2846 if ( $wgRightsText ) {
2847 $copywarnMsg = array( 'copyrightwarning',
2848 '[[' . wfMessage( 'copyrightpage' )->inContentLanguage()->text() . ']]',
2849 $wgRightsText );
2850 } else {
2851 $copywarnMsg = array( 'copyrightwarning2',
2852 '[[' . wfMessage( 'copyrightpage' )->inContentLanguage()->text() . ']]' );
2854 // Allow for site and per-namespace customization of contribution/copyright notice.
2855 wfRunHooks( 'EditPageCopyrightWarning', array( $title, &$copywarnMsg ) );
2857 return "<div id=\"editpage-copywarn\">\n" .
2858 call_user_func_array( 'wfMessage', $copywarnMsg )->plain() . "\n</div>";
2861 protected function showStandardInputs( &$tabindex = 2 ) {
2862 global $wgOut;
2863 $wgOut->addHTML( "<div class='editOptions'>\n" );
2865 if ( $this->section != 'new' ) {
2866 $this->showSummaryInput( false, $this->summary );
2867 $wgOut->addHTML( $this->getSummaryPreview( false, $this->summary ) );
2870 $checkboxes = $this->getCheckboxes( $tabindex,
2871 array( 'minor' => $this->minoredit, 'watch' => $this->watchthis ) );
2872 $wgOut->addHTML( "<div class='editCheckboxes'>" . implode( $checkboxes, "\n" ) . "</div>\n" );
2874 // Show copyright warning.
2875 $wgOut->addWikiText( $this->getCopywarn() );
2876 $wgOut->addHTML( $this->editFormTextAfterWarn );
2878 $wgOut->addHTML( "<div class='editButtons'>\n" );
2879 $wgOut->addHTML( implode( $this->getEditButtons( $tabindex ), "\n" ) . "\n" );
2881 $cancel = $this->getCancelLink();
2882 if ( $cancel !== '' ) {
2883 $cancel .= wfMessage( 'pipe-separator' )->text();
2885 $edithelpurl = Skin::makeInternalOrExternalUrl( wfMessage( 'edithelppage' )->inContentLanguage()->text() );
2886 $edithelp = '<a target="helpwindow" href="' . $edithelpurl . '">' .
2887 wfMessage( 'edithelp' )->escaped() . '</a> ' .
2888 wfMessage( 'newwindow' )->parse();
2889 $wgOut->addHTML( " <span class='cancelLink'>{$cancel}</span>\n" );
2890 $wgOut->addHTML( " <span class='editHelp'>{$edithelp}</span>\n" );
2891 $wgOut->addHTML( "</div><!-- editButtons -->\n" );
2892 wfRunHooks( 'EditPage::showStandardInputs:options', array( $this, $wgOut, &$tabindex ) );
2893 $wgOut->addHTML( "</div><!-- editOptions -->\n" );
2897 * Show an edit conflict. textbox1 is already shown in showEditForm().
2898 * If you want to use another entry point to this function, be careful.
2900 protected function showConflict() {
2901 global $wgOut;
2903 if ( wfRunHooks( 'EditPageBeforeConflictDiff', array( &$this, &$wgOut ) ) ) {
2904 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
2906 $content1 = $this->toEditContent( $this->textbox1 );
2907 $content2 = $this->toEditContent( $this->textbox2 );
2909 $handler = ContentHandler::getForModelID( $this->contentModel );
2910 $de = $handler->createDifferenceEngine( $this->mArticle->getContext() );
2911 $de->setContent( $content2, $content1 );
2912 $de->showDiff(
2913 wfMessage( 'yourtext' )->parse(),
2914 wfMessage( 'storedversion' )->text()
2917 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
2918 $this->showTextbox2();
2923 * @return string
2925 public function getCancelLink() {
2926 $cancelParams = array();
2927 if ( !$this->isConflict && $this->oldid > 0 ) {
2928 $cancelParams['oldid'] = $this->oldid;
2931 return Linker::linkKnown(
2932 $this->getContextTitle(),
2933 wfMessage( 'cancel' )->parse(),
2934 array( 'id' => 'mw-editform-cancel' ),
2935 $cancelParams
2940 * Returns the URL to use in the form's action attribute.
2941 * This is used by EditPage subclasses when simply customizing the action
2942 * variable in the constructor is not enough. This can be used when the
2943 * EditPage lives inside of a Special page rather than a custom page action.
2945 * @param $title Title object for which is being edited (where we go to for &action= links)
2946 * @return string
2948 protected function getActionURL( Title $title ) {
2949 return $title->getLocalURL( array( 'action' => $this->action ) );
2953 * Check if a page was deleted while the user was editing it, before submit.
2954 * Note that we rely on the logging table, which hasn't been always there,
2955 * but that doesn't matter, because this only applies to brand new
2956 * deletes.
2958 protected function wasDeletedSinceLastEdit() {
2959 if ( $this->deletedSinceEdit !== null ) {
2960 return $this->deletedSinceEdit;
2963 $this->deletedSinceEdit = false;
2965 if ( $this->mTitle->isDeletedQuick() ) {
2966 $this->lastDelete = $this->getLastDelete();
2967 if ( $this->lastDelete ) {
2968 $deleteTime = wfTimestamp( TS_MW, $this->lastDelete->log_timestamp );
2969 if ( $deleteTime > $this->starttime ) {
2970 $this->deletedSinceEdit = true;
2975 return $this->deletedSinceEdit;
2978 protected function getLastDelete() {
2979 $dbr = wfGetDB( DB_SLAVE );
2980 $data = $dbr->selectRow(
2981 array( 'logging', 'user' ),
2982 array(
2983 'log_type',
2984 'log_action',
2985 'log_timestamp',
2986 'log_user',
2987 'log_namespace',
2988 'log_title',
2989 'log_comment',
2990 'log_params',
2991 'log_deleted',
2992 'user_name'
2993 ), array(
2994 'log_namespace' => $this->mTitle->getNamespace(),
2995 'log_title' => $this->mTitle->getDBkey(),
2996 'log_type' => 'delete',
2997 'log_action' => 'delete',
2998 'user_id=log_user'
3000 __METHOD__,
3001 array( 'LIMIT' => 1, 'ORDER BY' => 'log_timestamp DESC' )
3003 // Quick paranoid permission checks...
3004 if ( is_object( $data ) ) {
3005 if ( $data->log_deleted & LogPage::DELETED_USER ) {
3006 $data->user_name = wfMessage( 'rev-deleted-user' )->escaped();
3009 if ( $data->log_deleted & LogPage::DELETED_COMMENT ) {
3010 $data->log_comment = wfMessage( 'rev-deleted-comment' )->escaped();
3013 return $data;
3017 * Get the rendered text for previewing.
3018 * @throws MWException
3019 * @return string
3021 function getPreviewText() {
3022 global $wgOut, $wgUser, $wgRawHtml, $wgLang;
3024 wfProfileIn( __METHOD__ );
3026 if ( $wgRawHtml && !$this->mTokenOk ) {
3027 // Could be an offsite preview attempt. This is very unsafe if
3028 // HTML is enabled, as it could be an attack.
3029 $parsedNote = '';
3030 if ( $this->textbox1 !== '' ) {
3031 // Do not put big scary notice, if previewing the empty
3032 // string, which happens when you initially edit
3033 // a category page, due to automatic preview-on-open.
3034 $parsedNote = $wgOut->parse( "<div class='previewnote'>" .
3035 wfMessage( 'session_fail_preview_html' )->text() . "</div>", true, /* interface */true );
3037 wfProfileOut( __METHOD__ );
3038 return $parsedNote;
3041 $note = '';
3043 try {
3044 $content = $this->toEditContent( $this->textbox1 );
3046 $previewHTML = '';
3047 if ( !wfRunHooks( 'AlternateEditPreview', array( $this, &$content, &$previewHTML, &$this->mParserOutput ) ) ) {
3048 wfProfileOut( __METHOD__ );
3049 return $previewHTML;
3052 if ( $this->mTriedSave && !$this->mTokenOk ) {
3053 if ( $this->mTokenOkExceptSuffix ) {
3054 $note = wfMessage( 'token_suffix_mismatch' )->plain();
3056 } else {
3057 $note = wfMessage( 'session_fail_preview' )->plain();
3059 } elseif ( $this->incompleteForm ) {
3060 $note = wfMessage( 'edit_form_incomplete' )->plain();
3061 } else {
3062 $note = wfMessage( 'previewnote' )->plain() .
3063 ' [[#' . self::EDITFORM_ID . '|' . $wgLang->getArrow() . ' ' . wfMessage( 'continue-editing' )->text() . ']]';
3066 $parserOptions = $this->mArticle->makeParserOptions( $this->mArticle->getContext() );
3067 $parserOptions->setEditSection( false );
3068 $parserOptions->setIsPreview( true );
3069 $parserOptions->setIsSectionPreview( !is_null( $this->section ) && $this->section !== '' );
3071 # don't parse non-wikitext pages, show message about preview
3072 if ( $this->mTitle->isCssJsSubpage() || $this->mTitle->isCssOrJsPage() ) {
3073 if ( $this->mTitle->isCssJsSubpage() ) {
3074 $level = 'user';
3075 } elseif ( $this->mTitle->isCssOrJsPage() ) {
3076 $level = 'site';
3077 } else {
3078 $level = false;
3081 if ( $content->getModel() == CONTENT_MODEL_CSS ) {
3082 $format = 'css';
3083 } elseif ( $content->getModel() == CONTENT_MODEL_JAVASCRIPT ) {
3084 $format = 'js';
3085 } else {
3086 $format = false;
3089 # Used messages to make sure grep find them:
3090 # Messages: usercsspreview, userjspreview, sitecsspreview, sitejspreview
3091 if ( $level && $format ) {
3092 $note = "<div id='mw-{$level}{$format}preview'>" . wfMessage( "{$level}{$format}preview" )->text() . "</div>";
3096 $rt = $content->getRedirectChain();
3097 if ( $rt ) {
3098 $previewHTML = $this->mArticle->viewRedirect( $rt, false );
3099 } else {
3101 # If we're adding a comment, we need to show the
3102 # summary as the headline
3103 if ( $this->section === "new" && $this->summary !== "" ) {
3104 $content = $content->addSectionHeader( $this->summary );
3107 $hook_args = array( $this, &$content );
3108 ContentHandler::runLegacyHooks( 'EditPageGetPreviewText', $hook_args );
3109 wfRunHooks( 'EditPageGetPreviewContent', $hook_args );
3111 $parserOptions->enableLimitReport();
3113 # For CSS/JS pages, we should have called the ShowRawCssJs hook here.
3114 # But it's now deprecated, so never mind
3116 $content = $content->preSaveTransform( $this->mTitle, $wgUser, $parserOptions );
3117 $parserOutput = $content->getParserOutput( $this->getArticle()->getTitle(), null, $parserOptions );
3119 $previewHTML = $parserOutput->getText();
3120 $this->mParserOutput = $parserOutput;
3121 $wgOut->addParserOutputNoText( $parserOutput );
3123 if ( count( $parserOutput->getWarnings() ) ) {
3124 $note .= "\n\n" . implode( "\n\n", $parserOutput->getWarnings() );
3127 } catch ( MWContentSerializationException $ex ) {
3128 $m = wfMessage( 'content-failed-to-parse', $this->contentModel, $this->contentFormat, $ex->getMessage() );
3129 $note .= "\n\n" . $m->parse();
3130 $previewHTML = '';
3133 if ( $this->isConflict ) {
3134 $conflict = '<h2 id="mw-previewconflict">' . wfMessage( 'previewconflict' )->escaped() . "</h2>\n";
3135 } else {
3136 $conflict = '<hr />';
3139 $previewhead = "<div class='previewnote'>\n" .
3140 '<h2 id="mw-previewheader">' . wfMessage( 'preview' )->escaped() . "</h2>" .
3141 $wgOut->parse( $note, true, /* interface */true ) . $conflict . "</div>\n";
3143 $pageLang = $this->mTitle->getPageLanguage();
3144 $attribs = array( 'lang' => $pageLang->getCode(), 'dir' => $pageLang->getDir(),
3145 'class' => 'mw-content-' . $pageLang->getDir() );
3146 $previewHTML = Html::rawElement( 'div', $attribs, $previewHTML );
3148 wfProfileOut( __METHOD__ );
3149 return $previewhead . $previewHTML . $this->previewTextAfterContent;
3153 * @return Array
3155 function getTemplates() {
3156 if ( $this->preview || $this->section != '' ) {
3157 $templates = array();
3158 if ( !isset( $this->mParserOutput ) ) {
3159 return $templates;
3161 foreach ( $this->mParserOutput->getTemplates() as $ns => $template ) {
3162 foreach ( array_keys( $template ) as $dbk ) {
3163 $templates[] = Title::makeTitle( $ns, $dbk );
3166 return $templates;
3167 } else {
3168 return $this->mTitle->getTemplateLinksFrom();
3173 * Shows a bulletin board style toolbar for common editing functions.
3174 * It can be disabled in the user preferences.
3175 * The necessary JavaScript code can be found in skins/common/edit.js.
3177 * @return string
3179 static function getEditToolbar() {
3180 global $wgStylePath, $wgContLang, $wgLang, $wgOut;
3181 global $wgUseTeX, $wgEnableUploads, $wgForeignFileRepos;
3183 $imagesAvailable = $wgEnableUploads || count( $wgForeignFileRepos );
3186 * $toolarray is an array of arrays each of which includes the
3187 * filename of the button image (without path), the opening
3188 * tag, the closing tag, optionally a sample text that is
3189 * inserted between the two when no selection is highlighted
3190 * and. The tip text is shown when the user moves the mouse
3191 * over the button.
3193 * Also here: accesskeys (key), which are not used yet until
3194 * someone can figure out a way to make them work in
3195 * IE. However, we should make sure these keys are not defined
3196 * on the edit page.
3198 $toolarray = array(
3199 array(
3200 'image' => $wgLang->getImageFile( 'button-bold' ),
3201 'id' => 'mw-editbutton-bold',
3202 'open' => '\'\'\'',
3203 'close' => '\'\'\'',
3204 'sample' => wfMessage( 'bold_sample' )->text(),
3205 'tip' => wfMessage( 'bold_tip' )->text(),
3206 'key' => 'B'
3208 array(
3209 'image' => $wgLang->getImageFile( 'button-italic' ),
3210 'id' => 'mw-editbutton-italic',
3211 'open' => '\'\'',
3212 'close' => '\'\'',
3213 'sample' => wfMessage( 'italic_sample' )->text(),
3214 'tip' => wfMessage( 'italic_tip' )->text(),
3215 'key' => 'I'
3217 array(
3218 'image' => $wgLang->getImageFile( 'button-link' ),
3219 'id' => 'mw-editbutton-link',
3220 'open' => '[[',
3221 'close' => ']]',
3222 'sample' => wfMessage( 'link_sample' )->text(),
3223 'tip' => wfMessage( 'link_tip' )->text(),
3224 'key' => 'L'
3226 array(
3227 'image' => $wgLang->getImageFile( 'button-extlink' ),
3228 'id' => 'mw-editbutton-extlink',
3229 'open' => '[',
3230 'close' => ']',
3231 'sample' => wfMessage( 'extlink_sample' )->text(),
3232 'tip' => wfMessage( 'extlink_tip' )->text(),
3233 'key' => 'X'
3235 array(
3236 'image' => $wgLang->getImageFile( 'button-headline' ),
3237 'id' => 'mw-editbutton-headline',
3238 'open' => "\n== ",
3239 'close' => " ==\n",
3240 'sample' => wfMessage( 'headline_sample' )->text(),
3241 'tip' => wfMessage( 'headline_tip' )->text(),
3242 'key' => 'H'
3244 $imagesAvailable ? array(
3245 'image' => $wgLang->getImageFile( 'button-image' ),
3246 'id' => 'mw-editbutton-image',
3247 'open' => '[[' . $wgContLang->getNsText( NS_FILE ) . ':',
3248 'close' => ']]',
3249 'sample' => wfMessage( 'image_sample' )->text(),
3250 'tip' => wfMessage( 'image_tip' )->text(),
3251 'key' => 'D',
3252 ) : false,
3253 $imagesAvailable ? array(
3254 'image' => $wgLang->getImageFile( 'button-media' ),
3255 'id' => 'mw-editbutton-media',
3256 'open' => '[[' . $wgContLang->getNsText( NS_MEDIA ) . ':',
3257 'close' => ']]',
3258 'sample' => wfMessage( 'media_sample' )->text(),
3259 'tip' => wfMessage( 'media_tip' )->text(),
3260 'key' => 'M'
3261 ) : false,
3262 $wgUseTeX ? array(
3263 'image' => $wgLang->getImageFile( 'button-math' ),
3264 'id' => 'mw-editbutton-math',
3265 'open' => "<math>",
3266 'close' => "</math>",
3267 'sample' => wfMessage( 'math_sample' )->text(),
3268 'tip' => wfMessage( 'math_tip' )->text(),
3269 'key' => 'C'
3270 ) : false,
3271 array(
3272 'image' => $wgLang->getImageFile( 'button-nowiki' ),
3273 'id' => 'mw-editbutton-nowiki',
3274 'open' => "<nowiki>",
3275 'close' => "</nowiki>",
3276 'sample' => wfMessage( 'nowiki_sample' )->text(),
3277 'tip' => wfMessage( 'nowiki_tip' )->text(),
3278 'key' => 'N'
3280 array(
3281 'image' => $wgLang->getImageFile( 'button-sig' ),
3282 'id' => 'mw-editbutton-signature',
3283 'open' => '--~~~~',
3284 'close' => '',
3285 'sample' => '',
3286 'tip' => wfMessage( 'sig_tip' )->text(),
3287 'key' => 'Y'
3289 array(
3290 'image' => $wgLang->getImageFile( 'button-hr' ),
3291 'id' => 'mw-editbutton-hr',
3292 'open' => "\n----\n",
3293 'close' => '',
3294 'sample' => '',
3295 'tip' => wfMessage( 'hr_tip' )->text(),
3296 'key' => 'R'
3300 $script = 'mw.loader.using("mediawiki.action.edit", function() {';
3301 foreach ( $toolarray as $tool ) {
3302 if ( !$tool ) {
3303 continue;
3306 $params = array(
3307 $image = $wgStylePath . '/common/images/' . $tool['image'],
3308 // Note that we use the tip both for the ALT tag and the TITLE tag of the image.
3309 // Older browsers show a "speedtip" type message only for ALT.
3310 // Ideally these should be different, realistically they
3311 // probably don't need to be.
3312 $tip = $tool['tip'],
3313 $open = $tool['open'],
3314 $close = $tool['close'],
3315 $sample = $tool['sample'],
3316 $cssId = $tool['id'],
3319 $script .= Xml::encodeJsCall( 'mw.toolbar.addButton', $params );
3322 // This used to be called on DOMReady from mediawiki.action.edit, which
3323 // ended up causing race conditions with the setup code above.
3324 $script .= "\n" .
3325 "// Create button bar\n" .
3326 "$(function() { mw.toolbar.init(); } );\n";
3328 $script .= '});';
3329 $wgOut->addScript( Html::inlineScript( ResourceLoader::makeLoaderConditionalScript( $script ) ) );
3331 $toolbar = '<div id="toolbar"></div>';
3333 wfRunHooks( 'EditPageBeforeEditToolbar', array( &$toolbar ) );
3335 return $toolbar;
3339 * Returns an array of html code of the following checkboxes:
3340 * minor and watch
3342 * @param int $tabindex Current tabindex
3343 * @param array $checked of checkbox => bool, where bool indicates the checked
3344 * status of the checkbox
3346 * @return array
3348 public function getCheckboxes( &$tabindex, $checked ) {
3349 global $wgUser;
3351 $checkboxes = array();
3353 // don't show the minor edit checkbox if it's a new page or section
3354 if ( !$this->isNew ) {
3355 $checkboxes['minor'] = '';
3356 $minorLabel = wfMessage( 'minoredit' )->parse();
3357 if ( $wgUser->isAllowed( 'minoredit' ) ) {
3358 $attribs = array(
3359 'tabindex' => ++$tabindex,
3360 'accesskey' => wfMessage( 'accesskey-minoredit' )->text(),
3361 'id' => 'wpMinoredit',
3363 $checkboxes['minor'] =
3364 Xml::check( 'wpMinoredit', $checked['minor'], $attribs ) .
3365 "&#160;<label for='wpMinoredit' id='mw-editpage-minoredit'" .
3366 Xml::expandAttributes( array( 'title' => Linker::titleAttrib( 'minoredit', 'withaccess' ) ) ) .
3367 ">{$minorLabel}</label>";
3371 $watchLabel = wfMessage( 'watchthis' )->parse();
3372 $checkboxes['watch'] = '';
3373 if ( $wgUser->isLoggedIn() ) {
3374 $attribs = array(
3375 'tabindex' => ++$tabindex,
3376 'accesskey' => wfMessage( 'accesskey-watch' )->text(),
3377 'id' => 'wpWatchthis',
3379 $checkboxes['watch'] =
3380 Xml::check( 'wpWatchthis', $checked['watch'], $attribs ) .
3381 "&#160;<label for='wpWatchthis' id='mw-editpage-watch'" .
3382 Xml::expandAttributes( array( 'title' => Linker::titleAttrib( 'watch', 'withaccess' ) ) ) .
3383 ">{$watchLabel}</label>";
3385 wfRunHooks( 'EditPageBeforeEditChecks', array( &$this, &$checkboxes, &$tabindex ) );
3386 return $checkboxes;
3390 * Returns an array of html code of the following buttons:
3391 * save, diff, preview and live
3393 * @param int $tabindex Current tabindex
3395 * @return array
3397 public function getEditButtons( &$tabindex ) {
3398 $buttons = array();
3400 $temp = array(
3401 'id' => 'wpSave',
3402 'name' => 'wpSave',
3403 'type' => 'submit',
3404 'tabindex' => ++$tabindex,
3405 'value' => wfMessage( 'savearticle' )->text(),
3406 'accesskey' => wfMessage( 'accesskey-save' )->text(),
3407 'title' => wfMessage( 'tooltip-save' )->text() . ' [' . wfMessage( 'accesskey-save' )->text() . ']',
3409 $buttons['save'] = Xml::element( 'input', $temp, '' );
3411 ++$tabindex; // use the same for preview and live preview
3412 $temp = array(
3413 'id' => 'wpPreview',
3414 'name' => 'wpPreview',
3415 'type' => 'submit',
3416 'tabindex' => $tabindex,
3417 'value' => wfMessage( 'showpreview' )->text(),
3418 'accesskey' => wfMessage( 'accesskey-preview' )->text(),
3419 'title' => wfMessage( 'tooltip-preview' )->text() . ' [' . wfMessage( 'accesskey-preview' )->text() . ']',
3421 $buttons['preview'] = Xml::element( 'input', $temp, '' );
3422 $buttons['live'] = '';
3424 $temp = array(
3425 'id' => 'wpDiff',
3426 'name' => 'wpDiff',
3427 'type' => 'submit',
3428 'tabindex' => ++$tabindex,
3429 'value' => wfMessage( 'showdiff' )->text(),
3430 'accesskey' => wfMessage( 'accesskey-diff' )->text(),
3431 'title' => wfMessage( 'tooltip-diff' )->text() . ' [' . wfMessage( 'accesskey-diff' )->text() . ']',
3433 $buttons['diff'] = Xml::element( 'input', $temp, '' );
3435 wfRunHooks( 'EditPageBeforeEditButtons', array( &$this, &$buttons, &$tabindex ) );
3436 return $buttons;
3440 * Output preview text only. This can be sucked into the edit page
3441 * via JavaScript, and saves the server time rendering the skin as
3442 * well as theoretically being more robust on the client (doesn't
3443 * disturb the edit box's undo history, won't eat your text on
3444 * failure, etc).
3446 * @todo This doesn't include category or interlanguage links.
3447 * Would need to enhance it a bit, "<s>maybe wrap them in XML
3448 * or something...</s>" that might also require more skin
3449 * initialization, so check whether that's a problem.
3451 function livePreview() {
3452 global $wgOut;
3453 $wgOut->disable();
3454 header( 'Content-type: text/xml; charset=utf-8' );
3455 header( 'Cache-control: no-cache' );
3457 $previewText = $this->getPreviewText();
3458 #$categories = $skin->getCategoryLinks();
3460 $s =
3461 '<?xml version="1.0" encoding="UTF-8" ?>' . "\n" .
3462 Xml::tags( 'livepreview', null,
3463 Xml::element( 'preview', null, $previewText )
3464 #. Xml::element( 'category', null, $categories )
3466 echo $s;
3470 * Call the stock "user is blocked" page
3472 * @deprecated in 1.19; throw an exception directly instead
3474 function blockedPage() {
3475 wfDeprecated( __METHOD__, '1.19' );
3476 global $wgUser;
3478 throw new UserBlockedError( $wgUser->getBlock() );
3482 * Produce the stock "please login to edit pages" page
3484 * @deprecated in 1.19; throw an exception directly instead
3486 function userNotLoggedInPage() {
3487 wfDeprecated( __METHOD__, '1.19' );
3488 throw new PermissionsError( 'edit' );
3492 * Show an error page saying to the user that he has insufficient permissions
3493 * to create a new page
3495 * @deprecated in 1.19; throw an exception directly instead
3497 function noCreatePermission() {
3498 wfDeprecated( __METHOD__, '1.19' );
3499 $permission = $this->mTitle->isTalkPage() ? 'createtalk' : 'createpage';
3500 throw new PermissionsError( $permission );
3504 * Creates a basic error page which informs the user that
3505 * they have attempted to edit a nonexistent section.
3507 function noSuchSectionPage() {
3508 global $wgOut;
3510 $wgOut->prepareErrorPage( wfMessage( 'nosuchsectiontitle' ) );
3512 $res = wfMessage( 'nosuchsectiontext', $this->section )->parseAsBlock();
3513 wfRunHooks( 'EditPageNoSuchSection', array( &$this, &$res ) );
3514 $wgOut->addHTML( $res );
3516 $wgOut->returnToMain( false, $this->mTitle );
3520 * Produce the stock "your edit contains spam" page
3522 * @param string|bool $match Text which triggered one or more filters
3523 * @deprecated since 1.17 Use method spamPageWithContent() instead
3525 static function spamPage( $match = false ) {
3526 wfDeprecated( __METHOD__, '1.17' );
3528 global $wgOut, $wgTitle;
3530 $wgOut->prepareErrorPage( wfMessage( 'spamprotectiontitle' ) );
3532 $wgOut->addHTML( '<div id="spamprotected">' );
3533 $wgOut->addWikiMsg( 'spamprotectiontext' );
3534 if ( $match ) {
3535 $wgOut->addWikiMsg( 'spamprotectionmatch', wfEscapeWikiText( $match ) );
3537 $wgOut->addHTML( '</div>' );
3539 $wgOut->returnToMain( false, $wgTitle );
3543 * Show "your edit contains spam" page with your diff and text
3545 * @param $match string|Array|bool Text (or array of texts) which triggered one or more filters
3547 public function spamPageWithContent( $match = false ) {
3548 global $wgOut, $wgLang;
3549 $this->textbox2 = $this->textbox1;
3551 if ( is_array( $match ) ) {
3552 $match = $wgLang->listToText( $match );
3554 $wgOut->prepareErrorPage( wfMessage( 'spamprotectiontitle' ) );
3556 $wgOut->addHTML( '<div id="spamprotected">' );
3557 $wgOut->addWikiMsg( 'spamprotectiontext' );
3558 if ( $match ) {
3559 $wgOut->addWikiMsg( 'spamprotectionmatch', wfEscapeWikiText( $match ) );
3561 $wgOut->addHTML( '</div>' );
3563 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
3564 $this->showDiff();
3566 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
3567 $this->showTextbox2();
3569 $wgOut->addReturnTo( $this->getContextTitle(), array( 'action' => 'edit' ) );
3573 * Format an anchor fragment as it would appear for a given section name
3574 * @param $text String
3575 * @return String
3576 * @private
3578 function sectionAnchor( $text ) {
3579 global $wgParser;
3580 return $wgParser->guessSectionNameFromWikiText( $text );
3584 * Check if the browser is on a blacklist of user-agents known to
3585 * mangle UTF-8 data on form submission. Returns true if Unicode
3586 * should make it through, false if it's known to be a problem.
3587 * @return bool
3588 * @private
3590 function checkUnicodeCompliantBrowser() {
3591 global $wgBrowserBlackList, $wgRequest;
3593 $currentbrowser = $wgRequest->getHeader( 'User-Agent' );
3594 if ( $currentbrowser === false ) {
3595 // No User-Agent header sent? Trust it by default...
3596 return true;
3599 foreach ( $wgBrowserBlackList as $browser ) {
3600 if ( preg_match( $browser, $currentbrowser ) ) {
3601 return false;
3604 return true;
3608 * Filter an input field through a Unicode de-armoring process if it
3609 * came from an old browser with known broken Unicode editing issues.
3611 * @param $request WebRequest
3612 * @param $field String
3613 * @return String
3614 * @private
3616 function safeUnicodeInput( $request, $field ) {
3617 $text = rtrim( $request->getText( $field ) );
3618 return $request->getBool( 'safemode' )
3619 ? $this->unmakesafe( $text )
3620 : $text;
3624 * @param $request WebRequest
3625 * @param $text string
3626 * @return string
3628 function safeUnicodeText( $request, $text ) {
3629 $text = rtrim( $text );
3630 return $request->getBool( 'safemode' )
3631 ? $this->unmakesafe( $text )
3632 : $text;
3636 * Filter an output field through a Unicode armoring process if it is
3637 * going to an old browser with known broken Unicode editing issues.
3639 * @param $text String
3640 * @return String
3641 * @private
3643 function safeUnicodeOutput( $text ) {
3644 global $wgContLang;
3645 $codedText = $wgContLang->recodeForEdit( $text );
3646 return $this->checkUnicodeCompliantBrowser()
3647 ? $codedText
3648 : $this->makesafe( $codedText );
3652 * A number of web browsers are known to corrupt non-ASCII characters
3653 * in a UTF-8 text editing environment. To protect against this,
3654 * detected browsers will be served an armored version of the text,
3655 * with non-ASCII chars converted to numeric HTML character references.
3657 * Preexisting such character references will have a 0 added to them
3658 * to ensure that round-trips do not alter the original data.
3660 * @param $invalue String
3661 * @return String
3662 * @private
3664 function makesafe( $invalue ) {
3665 // Armor existing references for reversibility.
3666 $invalue = strtr( $invalue, array( "&#x" => "&#x0" ) );
3668 $bytesleft = 0;
3669 $result = "";
3670 $working = 0;
3671 for ( $i = 0; $i < strlen( $invalue ); $i++ ) {
3672 $bytevalue = ord( $invalue[$i] );
3673 if ( $bytevalue <= 0x7F ) { // 0xxx xxxx
3674 $result .= chr( $bytevalue );
3675 $bytesleft = 0;
3676 } elseif ( $bytevalue <= 0xBF ) { // 10xx xxxx
3677 $working = $working << 6;
3678 $working += ( $bytevalue & 0x3F );
3679 $bytesleft--;
3680 if ( $bytesleft <= 0 ) {
3681 $result .= "&#x" . strtoupper( dechex( $working ) ) . ";";
3683 } elseif ( $bytevalue <= 0xDF ) { // 110x xxxx
3684 $working = $bytevalue & 0x1F;
3685 $bytesleft = 1;
3686 } elseif ( $bytevalue <= 0xEF ) { // 1110 xxxx
3687 $working = $bytevalue & 0x0F;
3688 $bytesleft = 2;
3689 } else { // 1111 0xxx
3690 $working = $bytevalue & 0x07;
3691 $bytesleft = 3;
3694 return $result;
3698 * Reverse the previously applied transliteration of non-ASCII characters
3699 * back to UTF-8. Used to protect data from corruption by broken web browsers
3700 * as listed in $wgBrowserBlackList.
3702 * @param $invalue String
3703 * @return String
3704 * @private
3706 function unmakesafe( $invalue ) {
3707 $result = "";
3708 for ( $i = 0; $i < strlen( $invalue ); $i++ ) {
3709 if ( ( substr( $invalue, $i, 3 ) == "&#x" ) && ( $invalue[$i + 3] != '0' ) ) {
3710 $i += 3;
3711 $hexstring = "";
3712 do {
3713 $hexstring .= $invalue[$i];
3714 $i++;
3715 } while ( ctype_xdigit( $invalue[$i] ) && ( $i < strlen( $invalue ) ) );
3717 // Do some sanity checks. These aren't needed for reversibility,
3718 // but should help keep the breakage down if the editor
3719 // breaks one of the entities whilst editing.
3720 if ( ( substr( $invalue, $i, 1 ) == ";" ) and ( strlen( $hexstring ) <= 6 ) ) {
3721 $codepoint = hexdec( $hexstring );
3722 $result .= codepointToUtf8( $codepoint );
3723 } else {
3724 $result .= "&#x" . $hexstring . substr( $invalue, $i, 1 );
3726 } else {
3727 $result .= substr( $invalue, $i, 1 );
3730 // reverse the transform that we made for reversibility reasons.
3731 return strtr( $result, array( "&#x0" => "&#x" ) );