(bug 41352) restore pre-ContentHandler version of mergeChangesInto()
[lhc/web/wiklou.git] / includes / EditPage.php
1 <?php
2 /**
3 * Page edition user interface.
4 *
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.
9 *
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.
14 *
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
19 *
20 * @file
21 */
22
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.
28 *
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.
34 *
35 * Surgeon General's Warning: prolonged exposure to this class is known to cause
36 * headaches, which may be fatal.
37 */
38 class EditPage {
39
40 /**
41 * Status: Article successfully updated
42 */
43 const AS_SUCCESS_UPDATE = 200;
44
45 /**
46 * Status: Article successfully created
47 */
48 const AS_SUCCESS_NEW_ARTICLE = 201;
49
50 /**
51 * Status: Article update aborted by a hook function
52 */
53 const AS_HOOK_ERROR = 210;
54
55 /**
56 * Status: A hook function returned an error
57 */
58 const AS_HOOK_ERROR_EXPECTED = 212;
59
60 /**
61 * Status: User is blocked from editting this page
62 */
63 const AS_BLOCKED_PAGE_FOR_USER = 215;
64
65 /**
66 * Status: Content too big (> $wgMaxArticleSize)
67 */
68 const AS_CONTENT_TOO_BIG = 216;
69
70 /**
71 * Status: User cannot edit? (not used)
72 */
73 const AS_USER_CANNOT_EDIT = 217;
74
75 /**
76 * Status: this anonymous user is not allowed to edit this page
77 */
78 const AS_READ_ONLY_PAGE_ANON = 218;
79
80 /**
81 * Status: this logged in user is not allowed to edit this page
82 */
83 const AS_READ_ONLY_PAGE_LOGGED = 219;
84
85 /**
86 * Status: wiki is in readonly mode (wfReadOnly() == true)
87 */
88 const AS_READ_ONLY_PAGE = 220;
89
90 /**
91 * Status: rate limiter for action 'edit' was tripped
92 */
93 const AS_RATE_LIMITED = 221;
94
95 /**
96 * Status: article was deleted while editting and param wpRecreate == false or form
97 * was not posted
98 */
99 const AS_ARTICLE_WAS_DELETED = 222;
100
101 /**
102 * Status: user tried to create this page, but is not allowed to do that
103 * ( Title->usercan('create') == false )
104 */
105 const AS_NO_CREATE_PERMISSION = 223;
106
107 /**
108 * Status: user tried to create a blank page
109 */
110 const AS_BLANK_ARTICLE = 224;
111
112 /**
113 * Status: (non-resolvable) edit conflict
114 */
115 const AS_CONFLICT_DETECTED = 225;
116
117 /**
118 * Status: no edit summary given and the user has forceeditsummary set and the user is not
119 * editting in his own userspace or talkspace and wpIgnoreBlankSummary == false
120 */
121 const AS_SUMMARY_NEEDED = 226;
122
123 /**
124 * Status: user tried to create a new section without content
125 */
126 const AS_TEXTBOX_EMPTY = 228;
127
128 /**
129 * Status: article is too big (> $wgMaxArticleSize), after merging in the new section
130 */
131 const AS_MAX_ARTICLE_SIZE_EXCEEDED = 229;
132
133 /**
134 * not used
135 */
136 const AS_OK = 230;
137
138 /**
139 * Status: WikiPage::doEdit() was unsuccessfull
140 */
141 const AS_END = 231;
142
143 /**
144 * Status: summary contained spam according to one of the regexes in $wgSummarySpamRegex
145 */
146 const AS_SPAM_ERROR = 232;
147
148 /**
149 * Status: anonymous user is not allowed to upload (User::isAllowed('upload') == false)
150 */
151 const AS_IMAGE_REDIRECT_ANON = 233;
152
153 /**
154 * Status: logged in user is not allowed to upload (User::isAllowed('upload') == false)
155 */
156 const AS_IMAGE_REDIRECT_LOGGED = 234;
157
158 /**
159 * Status: can't parse content
160 */
161 const AS_PARSE_ERROR = 240;
162
163 /**
164 * HTML id and name for the beginning of the edit form.
165 */
166 const EDITFORM_ID = 'editform';
167
168 /**
169 * @var Article
170 */
171 var $mArticle;
172
173 /**
174 * @var Title
175 */
176 var $mTitle;
177 private $mContextTitle = null;
178 var $action = 'submit';
179 var $isConflict = false;
180 var $isCssJsSubpage = false;
181 var $isCssSubpage = false;
182 var $isJsSubpage = false;
183 var $isWrongCaseCssJsPage = false;
184 var $isNew = false; // new page or new section
185 var $deletedSinceEdit;
186 var $formtype;
187 var $firsttime;
188 var $lastDelete;
189 var $mTokenOk = false;
190 var $mTokenOkExceptSuffix = false;
191 var $mTriedSave = false;
192 var $incompleteForm = false;
193 var $tooBig = false;
194 var $kblength = false;
195 var $missingComment = false;
196 var $missingSummary = false;
197 var $allowBlankSummary = false;
198 var $autoSumm = '';
199 var $hookError = '';
200 #var $mPreviewTemplates;
201
202 /**
203 * @var ParserOutput
204 */
205 var $mParserOutput;
206
207 /**
208 * Has a summary been preset using GET parameter &summary= ?
209 * @var Bool
210 */
211 var $hasPresetSummary = false;
212
213 var $mBaseRevision = false;
214 var $mShowSummaryField = true;
215
216 # Form values
217 var $save = false, $preview = false, $diff = false;
218 var $minoredit = false, $watchthis = false, $recreate = false;
219 var $textbox1 = '', $textbox2 = '', $summary = '', $nosummary = false;
220 var $edittime = '', $section = '', $sectiontitle = '', $starttime = '';
221 var $oldid = 0, $editintro = '', $scrolltop = null, $bot = true;
222 var $contentModel = null, $contentFormat = null;
223
224 # Placeholders for text injection by hooks (must be HTML)
225 # extensions should take care to _append_ to the present value
226 public $editFormPageTop = ''; // Before even the preview
227 public $editFormTextTop = '';
228 public $editFormTextBeforeContent = '';
229 public $editFormTextAfterWarn = '';
230 public $editFormTextAfterTools = '';
231 public $editFormTextBottom = '';
232 public $editFormTextAfterContent = '';
233 public $previewTextAfterContent = '';
234 public $mPreloadContent = null;
235
236 /* $didSave should be set to true whenever an article was succesfully altered. */
237 public $didSave = false;
238 public $undidRev = 0;
239
240 public $suppressIntro = false;
241
242 /**
243 * Set to true to allow editing of non-text content types.
244 *
245 * @var bool
246 */
247 public $allowNonTextContent = false;
248
249 /**
250 * @param $article Article
251 */
252 public function __construct( Article $article ) {
253 $this->mArticle = $article;
254 $this->mTitle = $article->getTitle();
255
256 $this->contentModel = $this->mTitle->getContentModel();
257
258 $handler = ContentHandler::getForModelID( $this->contentModel );
259 $this->contentFormat = $handler->getDefaultFormat();
260 }
261
262 /**
263 * @return Article
264 */
265 public function getArticle() {
266 return $this->mArticle;
267 }
268
269 /**
270 * @since 1.19
271 * @return Title
272 */
273 public function getTitle() {
274 return $this->mTitle;
275 }
276
277 /**
278 * Set the context Title object
279 *
280 * @param $title Title object or null
281 */
282 public function setContextTitle( $title ) {
283 $this->mContextTitle = $title;
284 }
285
286 /**
287 * Get the context title object.
288 * If not set, $wgTitle will be returned. This behavior might change in
289 * the future to return $this->mTitle instead.
290 *
291 * @return Title object
292 */
293 public function getContextTitle() {
294 if ( is_null( $this->mContextTitle ) ) {
295 global $wgTitle;
296 return $wgTitle;
297 } else {
298 return $this->mContextTitle;
299 }
300 }
301
302 function submit() {
303 $this->edit();
304 }
305
306 /**
307 * This is the function that gets called for "action=edit". It
308 * sets up various member variables, then passes execution to
309 * another function, usually showEditForm()
310 *
311 * The edit form is self-submitting, so that when things like
312 * preview and edit conflicts occur, we get the same form back
313 * with the extra stuff added. Only when the final submission
314 * is made and all is well do we actually save and redirect to
315 * the newly-edited page.
316 */
317 function edit() {
318 global $wgOut, $wgRequest, $wgUser;
319 // Allow extensions to modify/prevent this form or submission
320 if ( !wfRunHooks( 'AlternateEdit', array( $this ) ) ) {
321 return;
322 }
323
324 wfProfileIn( __METHOD__ );
325 wfDebug( __METHOD__ . ": enter\n" );
326
327 // If they used redlink=1 and the page exists, redirect to the main article
328 if ( $wgRequest->getBool( 'redlink' ) && $this->mTitle->exists() ) {
329 $wgOut->redirect( $this->mTitle->getFullURL() );
330 wfProfileOut( __METHOD__ );
331 return;
332 }
333
334 $this->importFormData( $wgRequest );
335 $this->firsttime = false;
336
337 if ( $this->live ) {
338 $this->livePreview();
339 wfProfileOut( __METHOD__ );
340 return;
341 }
342
343 if ( wfReadOnly() && $this->save ) {
344 // Force preview
345 $this->save = false;
346 $this->preview = true;
347 }
348
349 if ( $this->save ) {
350 $this->formtype = 'save';
351 } elseif ( $this->preview ) {
352 $this->formtype = 'preview';
353 } elseif ( $this->diff ) {
354 $this->formtype = 'diff';
355 } else { # First time through
356 $this->firsttime = true;
357 if ( $this->previewOnOpen() ) {
358 $this->formtype = 'preview';
359 } else {
360 $this->formtype = 'initial';
361 }
362 }
363
364 $permErrors = $this->getEditPermissionErrors();
365 if ( $permErrors ) {
366 wfDebug( __METHOD__ . ": User can't edit\n" );
367 // Auto-block user's IP if the account was "hard" blocked
368 $wgUser->spreadAnyEditBlock();
369
370 $this->displayPermissionsError( $permErrors );
371
372 wfProfileOut( __METHOD__ );
373 return;
374 }
375
376 wfProfileIn( __METHOD__ . "-business-end" );
377
378 $this->isConflict = false;
379 // css / js subpages of user pages get a special treatment
380 $this->isCssJsSubpage = $this->mTitle->isCssJsSubpage();
381 $this->isCssSubpage = $this->mTitle->isCssSubpage();
382 $this->isJsSubpage = $this->mTitle->isJsSubpage();
383 $this->isWrongCaseCssJsPage = $this->isWrongCaseCssJsPage();
384
385 # Show applicable editing introductions
386 if ( $this->formtype == 'initial' || $this->firsttime ) {
387 $this->showIntro();
388 }
389
390 # Attempt submission here. This will check for edit conflicts,
391 # and redundantly check for locked database, blocked IPs, etc.
392 # that edit() already checked just in case someone tries to sneak
393 # in the back door with a hand-edited submission URL.
394
395 if ( 'save' == $this->formtype ) {
396 if ( !$this->attemptSave() ) {
397 wfProfileOut( __METHOD__ . "-business-end" );
398 wfProfileOut( __METHOD__ );
399 return;
400 }
401 }
402
403 # First time through: get contents, set time for conflict
404 # checking, etc.
405 if ( 'initial' == $this->formtype || $this->firsttime ) {
406 if ( $this->initialiseForm() === false ) {
407 $this->noSuchSectionPage();
408 wfProfileOut( __METHOD__ . "-business-end" );
409 wfProfileOut( __METHOD__ );
410 return;
411 }
412 if ( !$this->mTitle->getArticleID() )
413 wfRunHooks( 'EditFormPreloadText', array( &$this->textbox1, &$this->mTitle ) );
414 else
415 wfRunHooks( 'EditFormInitialText', array( $this ) );
416 }
417
418 $this->showEditForm();
419 wfProfileOut( __METHOD__ . "-business-end" );
420 wfProfileOut( __METHOD__ );
421 }
422
423 /**
424 * @return array
425 */
426 protected function getEditPermissionErrors() {
427 global $wgUser;
428 $permErrors = $this->mTitle->getUserPermissionsErrors( 'edit', $wgUser );
429 # Can this title be created?
430 if ( !$this->mTitle->exists() ) {
431 $permErrors = array_merge( $permErrors,
432 wfArrayDiff2( $this->mTitle->getUserPermissionsErrors( 'create', $wgUser ), $permErrors ) );
433 }
434 # Ignore some permissions errors when a user is just previewing/viewing diffs
435 $remove = array();
436 foreach ( $permErrors as $error ) {
437 if ( ( $this->preview || $this->diff ) &&
438 ( $error[0] == 'blockedtext' || $error[0] == 'autoblockedtext' ) )
439 {
440 $remove[] = $error;
441 }
442 }
443 $permErrors = wfArrayDiff2( $permErrors, $remove );
444 return $permErrors;
445 }
446
447 /**
448 * Display a permissions error page, like OutputPage::showPermissionsErrorPage(),
449 * but with the following differences:
450 * - If redlink=1, the user will be redirected to the page
451 * - If there is content to display or the error occurs while either saving,
452 * previewing or showing the difference, it will be a
453 * "View source for ..." page displaying the source code after the error message.
454 *
455 * @since 1.19
456 * @param $permErrors Array of permissions errors, as returned by
457 * Title::getUserPermissionsErrors().
458 * @throws PermissionsError
459 */
460 protected function displayPermissionsError( array $permErrors ) {
461 global $wgRequest, $wgOut;
462
463 if ( $wgRequest->getBool( 'redlink' ) ) {
464 // The edit page was reached via a red link.
465 // Redirect to the article page and let them click the edit tab if
466 // they really want a permission error.
467 $wgOut->redirect( $this->mTitle->getFullUrl() );
468 return;
469 }
470
471 $content = $this->getContentObject();
472
473 # Use the normal message if there's nothing to display
474 if ( $this->firsttime && ( !$content || $content->isEmpty() ) ) {
475 $action = $this->mTitle->exists() ? 'edit' :
476 ( $this->mTitle->isTalkPage() ? 'createtalk' : 'createpage' );
477 throw new PermissionsError( $action, $permErrors );
478 }
479
480 $wgOut->setPageTitle( wfMessage( 'viewsource-title', $this->getContextTitle()->getPrefixedText() ) );
481 $wgOut->addBacklinkSubtitle( $this->getContextTitle() );
482 $wgOut->addWikiText( $wgOut->formatPermissionsErrorMessage( $permErrors, 'edit' ) );
483 $wgOut->addHTML( "<hr />\n" );
484
485 # If the user made changes, preserve them when showing the markup
486 # (This happens when a user is blocked during edit, for instance)
487 if ( !$this->firsttime ) {
488 $text = $this->textbox1;
489 $wgOut->addWikiMsg( 'viewyourtext' );
490 } else {
491 $text = $this->toEditText( $content );
492 $wgOut->addWikiMsg( 'viewsourcetext' );
493 }
494
495 $this->showTextbox( $text, 'wpTextbox1', array( 'readonly' ) );
496
497 $wgOut->addHTML( Html::rawElement( 'div', array( 'class' => 'templatesUsed' ),
498 Linker::formatTemplates( $this->getTemplates() ) ) );
499
500 if ( $this->mTitle->exists() ) {
501 $wgOut->returnToMain( null, $this->mTitle );
502 }
503 }
504
505 /**
506 * Show a read-only error
507 * Parameters are the same as OutputPage:readOnlyPage()
508 * Redirect to the article page if redlink=1
509 * @deprecated in 1.19; use displayPermissionsError() instead
510 */
511 function readOnlyPage( $source = null, $protected = false, $reasons = array(), $action = null ) {
512 wfDeprecated( __METHOD__, '1.19' );
513
514 global $wgRequest, $wgOut;
515 if ( $wgRequest->getBool( 'redlink' ) ) {
516 // The edit page was reached via a red link.
517 // Redirect to the article page and let them click the edit tab if
518 // they really want a permission error.
519 $wgOut->redirect( $this->mTitle->getFullUrl() );
520 } else {
521 $wgOut->readOnlyPage( $source, $protected, $reasons, $action );
522 }
523 }
524
525 /**
526 * Should we show a preview when the edit form is first shown?
527 *
528 * @return bool
529 */
530 protected function previewOnOpen() {
531 global $wgRequest, $wgUser, $wgPreviewOnOpenNamespaces;
532 if ( $wgRequest->getVal( 'preview' ) == 'yes' ) {
533 // Explicit override from request
534 return true;
535 } elseif ( $wgRequest->getVal( 'preview' ) == 'no' ) {
536 // Explicit override from request
537 return false;
538 } elseif ( $this->section == 'new' ) {
539 // Nothing *to* preview for new sections
540 return false;
541 } elseif ( ( $wgRequest->getVal( 'preload' ) !== null || $this->mTitle->exists() ) && $wgUser->getOption( 'previewonfirst' ) ) {
542 // Standard preference behaviour
543 return true;
544 } elseif ( !$this->mTitle->exists() &&
545 isset( $wgPreviewOnOpenNamespaces[$this->mTitle->getNamespace()] ) &&
546 $wgPreviewOnOpenNamespaces[$this->mTitle->getNamespace()] )
547 {
548 // Categories are special
549 return true;
550 } else {
551 return false;
552 }
553 }
554
555 /**
556 * Checks whether the user entered a skin name in uppercase,
557 * e.g. "User:Example/Monobook.css" instead of "monobook.css"
558 *
559 * @return bool
560 */
561 protected function isWrongCaseCssJsPage() {
562 if ( $this->mTitle->isCssJsSubpage() ) {
563 $name = $this->mTitle->getSkinFromCssJsSubpage();
564 $skins = array_merge(
565 array_keys( Skin::getSkinNames() ),
566 array( 'common' )
567 );
568 return !in_array( $name, $skins )
569 && in_array( strtolower( $name ), $skins );
570 } else {
571 return false;
572 }
573 }
574
575 /**
576 * Does this EditPage class support section editing?
577 * This is used by EditPage subclasses to indicate their ui cannot handle section edits
578 *
579 * @return bool
580 */
581 protected function isSectionEditSupported() {
582 return true;
583 }
584
585 /**
586 * This function collects the form data and uses it to populate various member variables.
587 * @param $request WebRequest
588 */
589 function importFormData( &$request ) {
590 global $wgContLang, $wgUser;
591
592 wfProfileIn( __METHOD__ );
593
594 # Section edit can come from either the form or a link
595 $this->section = $request->getVal( 'wpSection', $request->getVal( 'section' ) );
596 $this->isNew = !$this->mTitle->exists() || $this->section == 'new';
597
598 if ( $request->wasPosted() ) {
599 # These fields need to be checked for encoding.
600 # Also remove trailing whitespace, but don't remove _initial_
601 # whitespace from the text boxes. This may be significant formatting.
602 $this->textbox1 = $this->safeUnicodeInput( $request, 'wpTextbox1' );
603 if ( !$request->getCheck( 'wpTextbox2' ) ) {
604 // Skip this if wpTextbox2 has input, it indicates that we came
605 // from a conflict page with raw page text, not a custom form
606 // modified by subclasses
607 wfProfileIn( get_class( $this ) . "::importContentFormData" );
608 $textbox1 = $this->importContentFormData( $request );
609 if ( isset( $textbox1 ) )
610 $this->textbox1 = $textbox1;
611 wfProfileOut( get_class( $this ) . "::importContentFormData" );
612 }
613
614 # Truncate for whole multibyte characters
615 $this->summary = $wgContLang->truncate( $request->getText( 'wpSummary' ), 255 );
616
617 # If the summary consists of a heading, e.g. '==Foobar==', extract the title from the
618 # header syntax, e.g. 'Foobar'. This is mainly an issue when we are using wpSummary for
619 # section titles.
620 $this->summary = preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->summary );
621
622 # Treat sectiontitle the same way as summary.
623 # Note that wpSectionTitle is not yet a part of the actual edit form, as wpSummary is
624 # currently doing double duty as both edit summary and section title. Right now this
625 # is just to allow API edits to work around this limitation, but this should be
626 # incorporated into the actual edit form when EditPage is rewritten (Bugs 18654, 26312).
627 $this->sectiontitle = $wgContLang->truncate( $request->getText( 'wpSectionTitle' ), 255 );
628 $this->sectiontitle = preg_replace( '/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->sectiontitle );
629
630 $this->edittime = $request->getVal( 'wpEdittime' );
631 $this->starttime = $request->getVal( 'wpStarttime' );
632
633 $this->scrolltop = $request->getIntOrNull( 'wpScrolltop' );
634
635 if ( $this->textbox1 === '' && $request->getVal( 'wpTextbox1' ) === null ) {
636 // wpTextbox1 field is missing, possibly due to being "too big"
637 // according to some filter rules such as Suhosin's setting for
638 // suhosin.request.max_value_length (d'oh)
639 $this->incompleteForm = true;
640 } else {
641 // edittime should be one of our last fields; if it's missing,
642 // the submission probably broke somewhere in the middle.
643 $this->incompleteForm = is_null( $this->edittime );
644 }
645 if ( $this->incompleteForm ) {
646 # If the form is incomplete, force to preview.
647 wfDebug( __METHOD__ . ": Form data appears to be incomplete\n" );
648 wfDebug( "POST DATA: " . var_export( $_POST, true ) . "\n" );
649 $this->preview = true;
650 } else {
651 /* Fallback for live preview */
652 $this->preview = $request->getCheck( 'wpPreview' ) || $request->getCheck( 'wpLivePreview' );
653 $this->diff = $request->getCheck( 'wpDiff' );
654
655 // Remember whether a save was requested, so we can indicate
656 // if we forced preview due to session failure.
657 $this->mTriedSave = !$this->preview;
658
659 if ( $this->tokenOk( $request ) ) {
660 # Some browsers will not report any submit button
661 # if the user hits enter in the comment box.
662 # The unmarked state will be assumed to be a save,
663 # if the form seems otherwise complete.
664 wfDebug( __METHOD__ . ": Passed token check.\n" );
665 } elseif ( $this->diff ) {
666 # Failed token check, but only requested "Show Changes".
667 wfDebug( __METHOD__ . ": Failed token check; Show Changes requested.\n" );
668 } else {
669 # Page might be a hack attempt posted from
670 # an external site. Preview instead of saving.
671 wfDebug( __METHOD__ . ": Failed token check; forcing preview\n" );
672 $this->preview = true;
673 }
674 }
675 $this->save = !$this->preview && !$this->diff;
676 if ( !preg_match( '/^\d{14}$/', $this->edittime ) ) {
677 $this->edittime = null;
678 }
679
680 if ( !preg_match( '/^\d{14}$/', $this->starttime ) ) {
681 $this->starttime = null;
682 }
683
684 $this->recreate = $request->getCheck( 'wpRecreate' );
685
686 $this->minoredit = $request->getCheck( 'wpMinoredit' );
687 $this->watchthis = $request->getCheck( 'wpWatchthis' );
688
689 # Don't force edit summaries when a user is editing their own user or talk page
690 if ( ( $this->mTitle->mNamespace == NS_USER || $this->mTitle->mNamespace == NS_USER_TALK ) &&
691 $this->mTitle->getText() == $wgUser->getName() )
692 {
693 $this->allowBlankSummary = true;
694 } else {
695 $this->allowBlankSummary = $request->getBool( 'wpIgnoreBlankSummary' ) || !$wgUser->getOption( 'forceeditsummary' );
696 }
697
698 $this->autoSumm = $request->getText( 'wpAutoSummary' );
699 } else {
700 # Not a posted form? Start with nothing.
701 wfDebug( __METHOD__ . ": Not a posted form.\n" );
702 $this->textbox1 = '';
703 $this->summary = '';
704 $this->sectiontitle = '';
705 $this->edittime = '';
706 $this->starttime = wfTimestampNow();
707 $this->edit = false;
708 $this->preview = false;
709 $this->save = false;
710 $this->diff = false;
711 $this->minoredit = false;
712 $this->watchthis = $request->getBool( 'watchthis', false ); // Watch may be overriden by request parameters
713 $this->recreate = false;
714
715 // When creating a new section, we can preload a section title by passing it as the
716 // preloadtitle parameter in the URL (Bug 13100)
717 if ( $this->section == 'new' && $request->getVal( 'preloadtitle' ) ) {
718 $this->sectiontitle = $request->getVal( 'preloadtitle' );
719 // Once wpSummary isn't being use for setting section titles, we should delete this.
720 $this->summary = $request->getVal( 'preloadtitle' );
721 }
722 elseif ( $this->section != 'new' && $request->getVal( 'summary' ) ) {
723 $this->summary = $request->getText( 'summary' );
724 if ( $this->summary !== '' ) {
725 $this->hasPresetSummary = true;
726 }
727 }
728
729 if ( $request->getVal( 'minor' ) ) {
730 $this->minoredit = true;
731 }
732 }
733
734 $this->oldid = $request->getInt( 'oldid' );
735
736 $this->bot = $request->getBool( 'bot', true );
737 $this->nosummary = $request->getBool( 'nosummary' );
738
739 $content_handler = ContentHandler::getForTitle( $this->mTitle );
740 $this->contentModel = $request->getText( 'model', $content_handler->getModelID() ); #may be overridden by revision
741 $this->contentFormat = $request->getText( 'format', $content_handler->getDefaultFormat() ); #may be overridden by revision
742
743 #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
744 #TODO: check if the desired content model supports the given content format!
745
746 $this->live = $request->getCheck( 'live' );
747 $this->editintro = $request->getText( 'editintro',
748 // Custom edit intro for new sections
749 $this->section === 'new' ? 'MediaWiki:addsection-editintro' : '' );
750
751 // Allow extensions to modify form data
752 wfRunHooks( 'EditPage::importFormData', array( $this, $request ) );
753
754 wfProfileOut( __METHOD__ );
755 }
756
757 /**
758 * Subpage overridable method for extracting the page content data from the
759 * posted form to be placed in $this->textbox1, if using customized input
760 * this method should be overrided and return the page text that will be used
761 * for saving, preview parsing and so on...
762 *
763 * @param $request WebRequest
764 */
765 protected function importContentFormData( &$request ) {
766 return; // Don't do anything, EditPage already extracted wpTextbox1
767 }
768
769 /**
770 * Initialise form fields in the object
771 * Called on the first invocation, e.g. when a user clicks an edit link
772 * @return bool -- if the requested section is valid
773 */
774 function initialiseForm() {
775 global $wgUser;
776 $this->edittime = $this->mArticle->getTimestamp();
777
778 $content = $this->getContentObject( false ); #TODO: track content object?!
779 if ( $content === false ) {
780 return false;
781 }
782 $this->textbox1 = $this->toEditText( $content );
783
784 // activate checkboxes if user wants them to be always active
785 # Sort out the "watch" checkbox
786 if ( $wgUser->getOption( 'watchdefault' ) ) {
787 # Watch all edits
788 $this->watchthis = true;
789 } elseif ( $wgUser->getOption( 'watchcreations' ) && !$this->mTitle->exists() ) {
790 # Watch creations
791 $this->watchthis = true;
792 } elseif ( $wgUser->isWatched( $this->mTitle ) ) {
793 # Already watched
794 $this->watchthis = true;
795 }
796 if ( $wgUser->getOption( 'minordefault' ) && !$this->isNew ) {
797 $this->minoredit = true;
798 }
799 if ( $this->textbox1 === false ) {
800 return false;
801 }
802 wfProxyCheck();
803 return true;
804 }
805
806 /**
807 * Fetch initial editing page content.
808 *
809 * @param $def_text string|bool
810 * @return mixed string on success, $def_text for invalid sections
811 * @private
812 * @deprecated since 1.21, get WikiPage::getContent() instead.
813 */
814 function getContent( $def_text = false ) {
815 ContentHandler::deprecated( __METHOD__, '1.21' );
816
817 if ( $def_text !== null && $def_text !== false && $def_text !== '' ) {
818 $def_content = $this->toEditContent( $def_text );
819 } else {
820 $def_content = false;
821 }
822
823 $content = $this->getContentObject( $def_content );
824
825 // Note: EditPage should only be used with text based content anyway.
826 return $this->toEditText( $content );
827 }
828
829 /**
830 * @param Content|null $def_content The default value to return
831 *
832 * @return mixed Content on success, $def_content for invalid sections
833 *
834 * @since 1.21
835 */
836 protected function getContentObject( $def_content = null ) {
837 global $wgOut, $wgRequest;
838
839 wfProfileIn( __METHOD__ );
840
841 $content = false;
842
843 // For message page not locally set, use the i18n message.
844 // For other non-existent articles, use preload text if any.
845 if ( !$this->mTitle->exists() || $this->section == 'new' ) {
846 if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI && $this->section != 'new' ) {
847 # If this is a system message, get the default text.
848 $msg = $this->mTitle->getDefaultMessageText();
849
850 $content = $this->toEditContent( $msg );
851 }
852 if ( $content === false ) {
853 # If requested, preload some text.
854 $preload = $wgRequest->getVal( 'preload',
855 // Custom preload text for new sections
856 $this->section === 'new' ? 'MediaWiki:addsection-preload' : '' );
857
858 $content = $this->getPreloadedContent( $preload );
859 }
860 // For existing pages, get text based on "undo" or section parameters.
861 } else {
862 if ( $this->section != '' ) {
863 // Get section edit text (returns $def_text for invalid sections)
864 $orig = $this->getOriginalContent();
865 $content = $orig ? $orig->getSection( $this->section ) : null;
866
867 if ( !$content ) $content = $def_content;
868 } else {
869 $undoafter = $wgRequest->getInt( 'undoafter' );
870 $undo = $wgRequest->getInt( 'undo' );
871
872 if ( $undo > 0 && $undoafter > 0 ) {
873 if ( $undo < $undoafter ) {
874 # If they got undoafter and undo round the wrong way, switch them
875 list( $undo, $undoafter ) = array( $undoafter, $undo );
876 }
877
878 $undorev = Revision::newFromId( $undo );
879 $oldrev = Revision::newFromId( $undoafter );
880
881 # Sanity check, make sure it's the right page,
882 # the revisions exist and they were not deleted.
883 # Otherwise, $content will be left as-is.
884 if ( !is_null( $undorev ) && !is_null( $oldrev ) &&
885 $undorev->getPage() == $oldrev->getPage() &&
886 $undorev->getPage() == $this->mTitle->getArticleID() &&
887 !$undorev->isDeleted( Revision::DELETED_TEXT ) &&
888 !$oldrev->isDeleted( Revision::DELETED_TEXT ) ) {
889
890 $content = $this->mArticle->getUndoContent( $undorev, $oldrev );
891
892 if ( $content === false ) {
893 # Warn the user that something went wrong
894 $undoMsg = 'failure';
895 } else {
896 # Inform the user of our success and set an automatic edit summary
897 $undoMsg = 'success';
898
899 # If we just undid one rev, use an autosummary
900 $firstrev = $oldrev->getNext();
901 if ( $firstrev && $firstrev->getId() == $undo ) {
902 $undoSummary = wfMessage( 'undo-summary', $undo, $undorev->getUserText() )->inContentLanguage()->text();
903 if ( $this->summary === '' ) {
904 $this->summary = $undoSummary;
905 } else {
906 $this->summary = $undoSummary . wfMessage( 'colon-separator' )
907 ->inContentLanguage()->text() . $this->summary;
908 }
909 $this->undidRev = $undo;
910 }
911 $this->formtype = 'diff';
912 }
913 } else {
914 // Failed basic sanity checks.
915 // Older revisions may have been removed since the link
916 // was created, or we may simply have got bogus input.
917 $undoMsg = 'norev';
918 }
919
920 $class = ( $undoMsg == 'success' ? '' : 'error ' ) . "mw-undo-{$undoMsg}";
921 $this->editFormPageTop .= $wgOut->parse( "<div class=\"{$class}\">" .
922 wfMessage( 'undo-' . $undoMsg )->plain() . '</div>', true, /* interface */true );
923 }
924
925 if ( $content === false ) {
926 $content = $this->getOriginalContent();
927 }
928 }
929 }
930
931 wfProfileOut( __METHOD__ );
932 return $content;
933 }
934
935 /**
936 * Get the content of the wanted revision, without section extraction.
937 *
938 * The result of this function can be used to compare user's input with
939 * section replaced in its context (using WikiPage::replaceSection())
940 * to the original text of the edit.
941 *
942 * This difers from Article::getContent() that when a missing revision is
943 * encountered the result will be null and not the
944 * 'missing-revision' message.
945 *
946 * @since 1.19
947 * @return Content|null
948 */
949 private function getOriginalContent() {
950 if ( $this->section == 'new' ) {
951 return $this->getCurrentContent();
952 }
953 $revision = $this->mArticle->getRevisionFetched();
954 if ( $revision === null ) {
955 if ( !$this->contentModel ) $this->contentModel = $this->getTitle()->getContentModel();
956 $handler = ContentHandler::getForModelID( $this->contentModel );
957
958 return $handler->makeEmptyContent();
959 }
960 $content = $revision->getContent();
961 return $content;
962 }
963
964 /**
965 * Get the current content of the page. This is basically similar to
966 * WikiPage::getContent( Revision::RAW ) except that when the page doesn't exist an empty
967 * content object is returned instead of null.
968 *
969 * @since 1.21
970 * @return Content
971 */
972 protected function getCurrentContent() {
973 $rev = $this->mArticle->getRevision();
974 $content = $rev ? $rev->getContent( Revision::RAW ) : null;
975
976 if ( $content === false || $content === null ) {
977 if ( !$this->contentModel ) $this->contentModel = $this->getTitle()->getContentModel();
978 $handler = ContentHandler::getForModelID( $this->contentModel );
979
980 return $handler->makeEmptyContent();
981 } else {
982 # nasty side-effect, but needed for consistency
983 $this->contentModel = $rev->getContentModel();
984 $this->contentFormat = $rev->getContentFormat();
985
986 return $content;
987 }
988 }
989
990
991 /**
992 * Use this method before edit() to preload some text into the edit box
993 *
994 * @param $text string
995 * @deprecated since 1.21, use setPreloadedContent() instead.
996 */
997 public function setPreloadedText( $text ) {
998 ContentHandler::deprecated( __METHOD__, "1.21" );
999
1000 $content = $this->toEditContent( $text );
1001
1002 $this->setPreloadedContent( $content );
1003 }
1004
1005 /**
1006 * Use this method before edit() to preload some content into the edit box
1007 *
1008 * @param $content Content
1009 *
1010 * @since 1.21
1011 */
1012 public function setPreloadedContent( Content $content ) {
1013 $this->mPreloadContent = $content;
1014 }
1015
1016 /**
1017 * Get the contents to be preloaded into the box, either set by
1018 * an earlier setPreloadText() or by loading the given page.
1019 *
1020 * @param $preload String: representing the title to preload from.
1021 *
1022 * @return String
1023 *
1024 * @deprecated since 1.21, use getPreloadedContent() instead
1025 */
1026 protected function getPreloadedText( $preload ) {
1027 ContentHandler::deprecated( __METHOD__, "1.21" );
1028
1029 $content = $this->getPreloadedContent( $preload );
1030 $text = $this->toEditText( $content );
1031
1032 return $text;
1033 }
1034
1035 /**
1036 * Get the contents to be preloaded into the box, either set by
1037 * an earlier setPreloadText() or by loading the given page.
1038 *
1039 * @param $preload String: representing the title to preload from.
1040 *
1041 * @return Content
1042 *
1043 * @since 1.21
1044 */
1045 protected function getPreloadedContent( $preload ) {
1046 global $wgUser;
1047
1048 if ( !empty( $this->mPreloadContent ) ) {
1049 return $this->mPreloadContent;
1050 }
1051
1052 $handler = ContentHandler::getForTitle( $this->getTitle() );
1053
1054 if ( $preload === '' ) {
1055 return $handler->makeEmptyContent();
1056 }
1057
1058 $title = Title::newFromText( $preload );
1059 # Check for existence to avoid getting MediaWiki:Noarticletext
1060 if ( $title === null || !$title->exists() || !$title->userCan( 'read' ) ) {
1061 return $handler->makeEmptyContent();
1062 }
1063
1064 $page = WikiPage::factory( $title );
1065 if ( $page->isRedirect() ) {
1066 $title = $page->getRedirectTarget();
1067 # Same as before
1068 if ( $title === null || !$title->exists() || !$title->userCan( 'read' ) ) {
1069 return $handler->makeEmptyContent();
1070 }
1071 $page = WikiPage::factory( $title );
1072 }
1073
1074 $parserOptions = ParserOptions::newFromUser( $wgUser );
1075 $content = $page->getContent( Revision::RAW );
1076
1077 if ( !$content ) {
1078 return $handler->makeEmptyContent();
1079 }
1080
1081 return $content->preloadTransform( $title, $parserOptions );
1082 }
1083
1084 /**
1085 * Make sure the form isn't faking a user's credentials.
1086 *
1087 * @param $request WebRequest
1088 * @return bool
1089 * @private
1090 */
1091 function tokenOk( &$request ) {
1092 global $wgUser;
1093 $token = $request->getVal( 'wpEditToken' );
1094 $this->mTokenOk = $wgUser->matchEditToken( $token );
1095 $this->mTokenOkExceptSuffix = $wgUser->matchEditTokenNoSuffix( $token );
1096 return $this->mTokenOk;
1097 }
1098
1099 /**
1100 * Attempt submission
1101 * @throws UserBlockedError|ReadOnlyError|ThrottledError|PermissionsError
1102 * @return bool false if output is done, true if the rest of the form should be displayed
1103 */
1104 function attemptSave() {
1105 global $wgUser, $wgOut;
1106
1107 $resultDetails = false;
1108 # Allow bots to exempt some edits from bot flagging
1109 $bot = $wgUser->isAllowed( 'bot' ) && $this->bot;
1110 $status = $this->internalAttemptSave( $resultDetails, $bot );
1111 // FIXME: once the interface for internalAttemptSave() is made nicer, this should use the message in $status
1112 if ( $status->value == self::AS_SUCCESS_UPDATE || $status->value == self::AS_SUCCESS_NEW_ARTICLE ) {
1113 $this->didSave = true;
1114 }
1115
1116 switch ( $status->value ) {
1117 case self::AS_HOOK_ERROR_EXPECTED:
1118 case self::AS_CONTENT_TOO_BIG:
1119 case self::AS_ARTICLE_WAS_DELETED:
1120 case self::AS_CONFLICT_DETECTED:
1121 case self::AS_SUMMARY_NEEDED:
1122 case self::AS_TEXTBOX_EMPTY:
1123 case self::AS_MAX_ARTICLE_SIZE_EXCEEDED:
1124 case self::AS_END:
1125 return true;
1126
1127 case self::AS_HOOK_ERROR:
1128 return false;
1129
1130 case self::AS_PARSE_ERROR:
1131 $wgOut->addWikiText( '<div class="error">' . $status->getWikiText() . '</div>');
1132 return true;
1133
1134 case self::AS_SUCCESS_NEW_ARTICLE:
1135 $query = $resultDetails['redirect'] ? 'redirect=no' : '';
1136 $anchor = isset ( $resultDetails['sectionanchor'] ) ? $resultDetails['sectionanchor'] : '';
1137 $wgOut->redirect( $this->mTitle->getFullURL( $query ) . $anchor );
1138 return false;
1139
1140 case self::AS_SUCCESS_UPDATE:
1141 $extraQuery = '';
1142 $sectionanchor = $resultDetails['sectionanchor'];
1143
1144 // Give extensions a chance to modify URL query on update
1145 wfRunHooks( 'ArticleUpdateBeforeRedirect', array( $this->mArticle, &$sectionanchor, &$extraQuery ) );
1146
1147 if ( $resultDetails['redirect'] ) {
1148 if ( $extraQuery == '' ) {
1149 $extraQuery = 'redirect=no';
1150 } else {
1151 $extraQuery = 'redirect=no&' . $extraQuery;
1152 }
1153 }
1154 $wgOut->redirect( $this->mTitle->getFullURL( $extraQuery ) . $sectionanchor );
1155 return false;
1156
1157 case self::AS_BLANK_ARTICLE:
1158 $wgOut->redirect( $this->getContextTitle()->getFullURL() );
1159 return false;
1160
1161 case self::AS_SPAM_ERROR:
1162 $this->spamPageWithContent( $resultDetails['spam'] );
1163 return false;
1164
1165 case self::AS_BLOCKED_PAGE_FOR_USER:
1166 throw new UserBlockedError( $wgUser->getBlock() );
1167
1168 case self::AS_IMAGE_REDIRECT_ANON:
1169 case self::AS_IMAGE_REDIRECT_LOGGED:
1170 throw new PermissionsError( 'upload' );
1171
1172 case self::AS_READ_ONLY_PAGE_ANON:
1173 case self::AS_READ_ONLY_PAGE_LOGGED:
1174 throw new PermissionsError( 'edit' );
1175
1176 case self::AS_READ_ONLY_PAGE:
1177 throw new ReadOnlyError;
1178
1179 case self::AS_RATE_LIMITED:
1180 throw new ThrottledError();
1181
1182 case self::AS_NO_CREATE_PERMISSION:
1183 $permission = $this->mTitle->isTalkPage() ? 'createtalk' : 'createpage';
1184 throw new PermissionsError( $permission );
1185
1186 default:
1187 // We don't recognize $status->value. The only way that can happen
1188 // is if an extension hook aborted from inside ArticleSave.
1189 // Render the status object into $this->hookError
1190 // FIXME this sucks, we should just use the Status object throughout
1191 $this->hookError = '<div class="error">' . $status->getWikitext() .
1192 '</div>';
1193 return true;
1194 }
1195 }
1196
1197 /**
1198 * Attempt submission (no UI)
1199 *
1200 * @param $result
1201 * @param $bot bool
1202 *
1203 * @return Status object, possibly with a message, but always with one of the AS_* constants in $status->value,
1204 *
1205 * FIXME: This interface is TERRIBLE, but hard to get rid of due to various error display idiosyncrasies. There are
1206 * also lots of cases where error metadata is set in the object and retrieved later instead of being returned, e.g.
1207 * AS_CONTENT_TOO_BIG and AS_BLOCKED_PAGE_FOR_USER. All that stuff needs to be cleaned up some time.
1208 */
1209 function internalAttemptSave( &$result, $bot = false ) {
1210 global $wgUser, $wgRequest, $wgParser, $wgMaxArticleSize;
1211
1212 $status = Status::newGood();
1213
1214 wfProfileIn( __METHOD__ );
1215 wfProfileIn( __METHOD__ . '-checks' );
1216
1217 if ( !wfRunHooks( 'EditPage::attemptSave', array( $this ) ) ) {
1218 wfDebug( "Hook 'EditPage::attemptSave' aborted article saving\n" );
1219 $status->fatal( 'hookaborted' );
1220 $status->value = self::AS_HOOK_ERROR;
1221 wfProfileOut( __METHOD__ . '-checks' );
1222 wfProfileOut( __METHOD__ );
1223 return $status;
1224 }
1225
1226 try {
1227 # Construct Content object
1228 $textbox_content = $this->toEditContent( $this->textbox1 );
1229 } catch (MWContentSerializationException $ex) {
1230 $status->fatal( 'content-failed-to-parse', $this->contentModel, $this->contentFormat, $ex->getMessage() );
1231 $status->value = self::AS_PARSE_ERROR;
1232 wfProfileOut( __METHOD__ );
1233 return $status;
1234 }
1235
1236 # Check image redirect
1237 if ( $this->mTitle->getNamespace() == NS_FILE &&
1238 $textbox_content->isRedirect() &&
1239 !$wgUser->isAllowed( 'upload' ) ) {
1240 $code = $wgUser->isAnon() ? self::AS_IMAGE_REDIRECT_ANON : self::AS_IMAGE_REDIRECT_LOGGED;
1241 $status->setResult( false, $code );
1242
1243 wfProfileOut( __METHOD__ . '-checks' );
1244 wfProfileOut( __METHOD__ );
1245
1246 return $status;
1247 }
1248
1249 # Check for spam
1250 $match = self::matchSummarySpamRegex( $this->summary );
1251 if ( $match === false ) {
1252 $match = self::matchSpamRegex( $this->textbox1 );
1253 }
1254 if ( $match !== false ) {
1255 $result['spam'] = $match;
1256 $ip = $wgRequest->getIP();
1257 $pdbk = $this->mTitle->getPrefixedDBkey();
1258 $match = str_replace( "\n", '', $match );
1259 wfDebugLog( 'SpamRegex', "$ip spam regex hit [[$pdbk]]: \"$match\"" );
1260 $status->fatal( 'spamprotectionmatch', $match );
1261 $status->value = self::AS_SPAM_ERROR;
1262 wfProfileOut( __METHOD__ . '-checks' );
1263 wfProfileOut( __METHOD__ );
1264 return $status;
1265 }
1266 if ( !wfRunHooks( 'EditFilter', array( $this, $this->textbox1, $this->section, &$this->hookError, $this->summary ) ) ) {
1267 # Error messages etc. could be handled within the hook...
1268 $status->fatal( 'hookaborted' );
1269 $status->value = self::AS_HOOK_ERROR;
1270 wfProfileOut( __METHOD__ . '-checks' );
1271 wfProfileOut( __METHOD__ );
1272 return $status;
1273 } elseif ( $this->hookError != '' ) {
1274 # ...or the hook could be expecting us to produce an error
1275 $status->fatal( 'hookaborted' );
1276 $status->value = self::AS_HOOK_ERROR_EXPECTED;
1277 wfProfileOut( __METHOD__ . '-checks' );
1278 wfProfileOut( __METHOD__ );
1279 return $status;
1280 }
1281
1282 if ( $wgUser->isBlockedFrom( $this->mTitle, false ) ) {
1283 // Auto-block user's IP if the account was "hard" blocked
1284 $wgUser->spreadAnyEditBlock();
1285 # Check block state against master, thus 'false'.
1286 $status->setResult( false, self::AS_BLOCKED_PAGE_FOR_USER );
1287 wfProfileOut( __METHOD__ . '-checks' );
1288 wfProfileOut( __METHOD__ );
1289 return $status;
1290 }
1291
1292 $this->kblength = (int)( strlen( $this->textbox1 ) / 1024 );
1293 if ( $this->kblength > $wgMaxArticleSize ) {
1294 // Error will be displayed by showEditForm()
1295 $this->tooBig = true;
1296 $status->setResult( false, self::AS_CONTENT_TOO_BIG );
1297 wfProfileOut( __METHOD__ . '-checks' );
1298 wfProfileOut( __METHOD__ );
1299 return $status;
1300 }
1301
1302 if ( !$wgUser->isAllowed( 'edit' ) ) {
1303 if ( $wgUser->isAnon() ) {
1304 $status->setResult( false, self::AS_READ_ONLY_PAGE_ANON );
1305 wfProfileOut( __METHOD__ . '-checks' );
1306 wfProfileOut( __METHOD__ );
1307 return $status;
1308 } else {
1309 $status->fatal( 'readonlytext' );
1310 $status->value = self::AS_READ_ONLY_PAGE_LOGGED;
1311 wfProfileOut( __METHOD__ . '-checks' );
1312 wfProfileOut( __METHOD__ );
1313 return $status;
1314 }
1315 }
1316
1317 if ( wfReadOnly() ) {
1318 $status->fatal( 'readonlytext' );
1319 $status->value = self::AS_READ_ONLY_PAGE;
1320 wfProfileOut( __METHOD__ . '-checks' );
1321 wfProfileOut( __METHOD__ );
1322 return $status;
1323 }
1324 if ( $wgUser->pingLimiter() ) {
1325 $status->fatal( 'actionthrottledtext' );
1326 $status->value = self::AS_RATE_LIMITED;
1327 wfProfileOut( __METHOD__ . '-checks' );
1328 wfProfileOut( __METHOD__ );
1329 return $status;
1330 }
1331
1332 # If the article has been deleted while editing, don't save it without
1333 # confirmation
1334 if ( $this->wasDeletedSinceLastEdit() && !$this->recreate ) {
1335 $status->setResult( false, self::AS_ARTICLE_WAS_DELETED );
1336 wfProfileOut( __METHOD__ . '-checks' );
1337 wfProfileOut( __METHOD__ );
1338 return $status;
1339 }
1340
1341 wfProfileOut( __METHOD__ . '-checks' );
1342
1343 # Load the page data from the master. If anything changes in the meantime,
1344 # we detect it by using page_latest like a token in a 1 try compare-and-swap.
1345 $this->mArticle->loadPageData( 'fromdbmaster' );
1346 $new = !$this->mArticle->exists();
1347
1348 if ( $new ) {
1349 // Late check for create permission, just in case *PARANOIA*
1350 if ( !$this->mTitle->userCan( 'create' ) ) {
1351 $status->fatal( 'nocreatetext' );
1352 $status->value = self::AS_NO_CREATE_PERMISSION;
1353 wfDebug( __METHOD__ . ": no create permission\n" );
1354 wfProfileOut( __METHOD__ );
1355 return $status;
1356 }
1357
1358 # Don't save a new article if it's blank.
1359 if ( $this->textbox1 == '' ) {
1360 $status->setResult( false, self::AS_BLANK_ARTICLE );
1361 wfProfileOut( __METHOD__ );
1362 return $status;
1363 }
1364
1365 // Run post-section-merge edit filter
1366 if ( !wfRunHooks( 'EditFilterMerged', array( $this, $this->textbox1, &$this->hookError, $this->summary ) ) ) {
1367 # Error messages etc. could be handled within the hook...
1368 $status->fatal( 'hookaborted' );
1369 $status->value = self::AS_HOOK_ERROR;
1370 wfProfileOut( __METHOD__ );
1371 return $status;
1372 } elseif ( $this->hookError != '' ) {
1373 # ...or the hook could be expecting us to produce an error
1374 $status->fatal( 'hookaborted' );
1375 $status->value = self::AS_HOOK_ERROR_EXPECTED;
1376 wfProfileOut( __METHOD__ );
1377 return $status;
1378 }
1379
1380 $content = $textbox_content;
1381
1382 $result['sectionanchor'] = '';
1383 if ( $this->section == 'new' ) {
1384 if ( $this->sectiontitle !== '' ) {
1385 // Insert the section title above the content.
1386 $content = $content->addSectionHeader( $this->sectiontitle );
1387
1388 // Jump to the new section
1389 $result['sectionanchor'] = $wgParser->guessLegacySectionNameFromWikiText( $this->sectiontitle );
1390
1391 // If no edit summary was specified, create one automatically from the section
1392 // title and have it link to the new section. Otherwise, respect the summary as
1393 // passed.
1394 if ( $this->summary === '' ) {
1395 $cleanSectionTitle = $wgParser->stripSectionName( $this->sectiontitle );
1396 $this->summary = wfMessage( 'newsectionsummary', $cleanSectionTitle )
1397 ->inContentLanguage()->text() ;
1398 }
1399 } elseif ( $this->summary !== '' ) {
1400 // Insert the section title above the content.
1401 $content = $content->addSectionHeader( $this->summary );
1402
1403 // Jump to the new section
1404 $result['sectionanchor'] = $wgParser->guessLegacySectionNameFromWikiText( $this->summary );
1405
1406 // Create a link to the new section from the edit summary.
1407 $cleanSummary = $wgParser->stripSectionName( $this->summary );
1408 $this->summary = wfMessage( 'newsectionsummary', $cleanSummary )
1409 ->inContentLanguage()->text();
1410 }
1411 }
1412
1413 $status->value = self::AS_SUCCESS_NEW_ARTICLE;
1414
1415 } else { # not $new
1416
1417 # Article exists. Check for edit conflict.
1418
1419 $this->mArticle->clear(); # Force reload of dates, etc.
1420 $timestamp = $this->mArticle->getTimestamp();
1421
1422 wfDebug( "timestamp: {$timestamp}, edittime: {$this->edittime}\n" );
1423
1424 if ( $timestamp != $this->edittime ) {
1425 $this->isConflict = true;
1426 if ( $this->section == 'new' ) {
1427 if ( $this->mArticle->getUserText() == $wgUser->getName() &&
1428 $this->mArticle->getComment() == $this->summary ) {
1429 // Probably a duplicate submission of a new comment.
1430 // This can happen when squid resends a request after
1431 // a timeout but the first one actually went through.
1432 wfDebug( __METHOD__ . ": duplicate new section submission; trigger edit conflict!\n" );
1433 } else {
1434 // New comment; suppress conflict.
1435 $this->isConflict = false;
1436 wfDebug( __METHOD__ . ": conflict suppressed; new section\n" );
1437 }
1438 } elseif ( $this->section == '' && Revision::userWasLastToEdit( DB_MASTER, $this->mTitle->getArticleID(),
1439 $wgUser->getId(), $this->edittime ) ) {
1440 # Suppress edit conflict with self, except for section edits where merging is required.
1441 wfDebug( __METHOD__ . ": Suppressing edit conflict, same user.\n" );
1442 $this->isConflict = false;
1443 }
1444 }
1445
1446 // If sectiontitle is set, use it, otherwise use the summary as the section title (for
1447 // backwards compatibility with old forms/bots).
1448 if ( $this->sectiontitle !== '' ) {
1449 $sectionTitle = $this->sectiontitle;
1450 } else {
1451 $sectionTitle = $this->summary;
1452 }
1453
1454 $content = null;
1455
1456 if ( $this->isConflict ) {
1457 wfDebug( __METHOD__ . ": conflict! getting section '{$this->section}' for time '{$this->edittime}'"
1458 . " (article time '{$timestamp}')\n" );
1459
1460 $content = $this->mArticle->replaceSectionContent( $this->section, $textbox_content, $sectionTitle, $this->edittime );
1461 } else {
1462 wfDebug( __METHOD__ . ": getting section '{$this->section}'\n" );
1463 $content = $this->mArticle->replaceSectionContent( $this->section, $textbox_content, $sectionTitle );
1464 }
1465
1466 if ( is_null( $content ) ) {
1467 wfDebug( __METHOD__ . ": activating conflict; section replace failed.\n" );
1468 $this->isConflict = true;
1469 $content = $textbox_content; // do not try to merge here!
1470 } elseif ( $this->isConflict ) {
1471 # Attempt merge
1472 if ( $this->mergeChangesInto( $content ) ) {
1473 // Successful merge! Maybe we should tell the user the good news?
1474 $this->isConflict = false;
1475 $content = $this->toEditContent( $content );
1476 wfDebug( __METHOD__ . ": Suppressing edit conflict, successful merge.\n" );
1477 } else {
1478 $this->section = '';
1479 $this->textbox1 = ContentHandler::getContentText( $content );
1480 wfDebug( __METHOD__ . ": Keeping edit conflict, failed merge.\n" );
1481 }
1482 }
1483
1484 if ( $this->isConflict ) {
1485 $status->setResult( false, self::AS_CONFLICT_DETECTED );
1486 wfProfileOut( __METHOD__ );
1487 return $status;
1488 }
1489
1490 // Run post-section-merge edit filter
1491 $hook_args = array( $this, $content, &$this->hookError, $this->summary );
1492
1493 if ( !ContentHandler::runLegacyHooks( 'EditFilterMerged', $hook_args )
1494 || !wfRunHooks( 'EditFilterMergedContent', $hook_args ) ) {
1495 # Error messages etc. could be handled within the hook...
1496 $status->fatal( 'hookaborted' );
1497 $status->value = self::AS_HOOK_ERROR;
1498 wfProfileOut( __METHOD__ );
1499 return $status;
1500 } elseif ( $this->hookError != '' ) {
1501 # ...or the hook could be expecting us to produce an error
1502 $status->fatal( 'hookaborted' );
1503 $status->value = self::AS_HOOK_ERROR_EXPECTED;
1504 wfProfileOut( __METHOD__ );
1505 return $status;
1506 }
1507
1508 # Handle the user preference to force summaries here, but not for null edits
1509 if ( $this->section != 'new' && !$this->allowBlankSummary
1510 && !$content->equals( $this->getOriginalContent() )
1511 && !$content->isRedirect() ) # check if it's not a redirect
1512 {
1513 if ( md5( $this->summary ) == $this->autoSumm ) {
1514 $this->missingSummary = true;
1515 $status->fatal( 'missingsummary' );
1516 $status->value = self::AS_SUMMARY_NEEDED;
1517 wfProfileOut( __METHOD__ );
1518 return $status;
1519 }
1520 }
1521
1522 # And a similar thing for new sections
1523 if ( $this->section == 'new' && !$this->allowBlankSummary ) {
1524 if ( trim( $this->summary ) == '' ) {
1525 $this->missingSummary = true;
1526 $status->fatal( 'missingsummary' ); // or 'missingcommentheader' if $section == 'new'. Blegh
1527 $status->value = self::AS_SUMMARY_NEEDED;
1528 wfProfileOut( __METHOD__ );
1529 return $status;
1530 }
1531 }
1532
1533 # All's well
1534 wfProfileIn( __METHOD__ . '-sectionanchor' );
1535 $sectionanchor = '';
1536 if ( $this->section == 'new' ) {
1537 if ( $this->textbox1 == '' ) {
1538 $this->missingComment = true;
1539 $status->fatal( 'missingcommenttext' );
1540 $status->value = self::AS_TEXTBOX_EMPTY;
1541 wfProfileOut( __METHOD__ . '-sectionanchor' );
1542 wfProfileOut( __METHOD__ );
1543 return $status;
1544 }
1545 if ( $this->sectiontitle !== '' ) {
1546 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $this->sectiontitle );
1547 // If no edit summary was specified, create one automatically from the section
1548 // title and have it link to the new section. Otherwise, respect the summary as
1549 // passed.
1550 if ( $this->summary === '' ) {
1551 $cleanSectionTitle = $wgParser->stripSectionName( $this->sectiontitle );
1552 $this->summary = wfMessage( 'newsectionsummary', $cleanSectionTitle )
1553 ->inContentLanguage()->text();
1554 }
1555 } elseif ( $this->summary !== '' ) {
1556 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $this->summary );
1557 # This is a new section, so create a link to the new section
1558 # in the revision summary.
1559 $cleanSummary = $wgParser->stripSectionName( $this->summary );
1560 $this->summary = wfMessage( 'newsectionsummary', $cleanSummary )
1561 ->inContentLanguage()->text();
1562 }
1563 } elseif ( $this->section != '' ) {
1564 # Try to get a section anchor from the section source, redirect to edited section if header found
1565 # XXX: might be better to integrate this into Article::replaceSection
1566 # for duplicate heading checking and maybe parsing
1567 $hasmatch = preg_match( "/^ *([=]{1,6})(.*?)(\\1) *\\n/i", $this->textbox1, $matches );
1568 # we can't deal with anchors, includes, html etc in the header for now,
1569 # headline would need to be parsed to improve this
1570 if ( $hasmatch && strlen( $matches[2] ) > 0 ) {
1571 $sectionanchor = $wgParser->guessLegacySectionNameFromWikiText( $matches[2] );
1572 }
1573 }
1574 $result['sectionanchor'] = $sectionanchor;
1575 wfProfileOut( __METHOD__ . '-sectionanchor' );
1576
1577 // Save errors may fall down to the edit form, but we've now
1578 // merged the section into full text. Clear the section field
1579 // so that later submission of conflict forms won't try to
1580 // replace that into a duplicated mess.
1581 $this->textbox1 = $this->toEditText( $content );
1582 $this->section = '';
1583
1584 $status->value = self::AS_SUCCESS_UPDATE;
1585 }
1586
1587 // Check for length errors again now that the section is merged in
1588 $this->kblength = (int)( strlen( $this->toEditText( $content ) ) / 1024 );
1589 if ( $this->kblength > $wgMaxArticleSize ) {
1590 $this->tooBig = true;
1591 $status->setResult( false, self::AS_MAX_ARTICLE_SIZE_EXCEEDED );
1592 wfProfileOut( __METHOD__ );
1593 return $status;
1594 }
1595
1596 $flags = EDIT_DEFER_UPDATES | EDIT_AUTOSUMMARY |
1597 ( $new ? EDIT_NEW : EDIT_UPDATE ) |
1598 ( ( $this->minoredit && !$this->isNew ) ? EDIT_MINOR : 0 ) |
1599 ( $bot ? EDIT_FORCE_BOT : 0 );
1600
1601 $doEditStatus = $this->mArticle->doEditContent( $content, $this->summary, $flags,
1602 false, null, $this->contentFormat );
1603
1604 if ( $doEditStatus->isOK() ) {
1605 $result['redirect'] = $content->isRedirect();
1606 $this->updateWatchlist();
1607 wfProfileOut( __METHOD__ );
1608 return $status;
1609 } else {
1610 // Failure from doEdit()
1611 // Show the edit conflict page for certain recognized errors from doEdit(),
1612 // but don't show it for errors from extension hooks
1613 $errors = $doEditStatus->getErrorsArray();
1614 if ( in_array( $errors[0][0], array( 'edit-gone-missing', 'edit-conflict',
1615 'edit-already-exists' ) ) )
1616 {
1617 $this->isConflict = true;
1618 // Destroys data doEdit() put in $status->value but who cares
1619 $doEditStatus->value = self::AS_END;
1620 }
1621 wfProfileOut( __METHOD__ );
1622 return $doEditStatus;
1623 }
1624 }
1625
1626 /**
1627 * Register the change of watch status
1628 */
1629 protected function updateWatchlist() {
1630 global $wgUser;
1631
1632 if ( $wgUser->isLoggedIn() && $this->watchthis != $wgUser->isWatched( $this->mTitle ) ) {
1633 $fname = __METHOD__;
1634 $title = $this->mTitle;
1635 $watch = $this->watchthis;
1636
1637 // Do this in its own transaction to reduce contention...
1638 $dbw = wfGetDB( DB_MASTER );
1639 $dbw->onTransactionIdle( function() use ( $dbw, $title, $watch, $wgUser, $fname ) {
1640 $dbw->begin( $fname );
1641 if ( $watch ) {
1642 WatchAction::doWatch( $title, $wgUser );
1643 } else {
1644 WatchAction::doUnwatch( $title, $wgUser );
1645 }
1646 $dbw->commit( $fname );
1647 } );
1648 }
1649 }
1650
1651 /**
1652 * @private
1653 * @todo document
1654 *
1655 * @param $editText string
1656 *
1657 * @return bool
1658 * @deprecated since 1.21, use mergeChangesIntoContent() instead
1659 */
1660 function mergeChangesInto( &$editText ){
1661 ContentHandler::deprecated( __METHOD__, "1.21" );
1662
1663 wfProfileIn( __METHOD__ );
1664
1665 $db = wfGetDB( DB_MASTER );
1666
1667 // This is the revision the editor started from
1668 $baseRevision = $this->getBaseRevision();
1669 if ( is_null( $baseRevision ) ) {
1670 wfProfileOut( __METHOD__ );
1671 return false;
1672 }
1673 $baseText = $baseRevision->getText();
1674
1675 // The current state, we want to merge updates into it
1676 $currentRevision = Revision::loadFromTitle( $db, $this->mTitle );
1677 if ( is_null( $currentRevision ) ) {
1678 wfProfileOut( __METHOD__ );
1679 return false;
1680 }
1681 $currentText = $currentRevision->getText();
1682
1683 $result = '';
1684 $editText = $this->toEditText( $editText );
1685
1686 if ( wfMerge( $baseText, $editText, $currentText, $result ) ) {
1687 $editText = $result;
1688 wfProfileOut( __METHOD__ );
1689 return true;
1690 } else {
1691 wfProfileOut( __METHOD__ );
1692 return false;
1693 }
1694 }
1695
1696 /**
1697 * @private
1698 * @todo document
1699 *
1700 * @param $editContent
1701 * @return bool
1702 * @since since 1.WD
1703 */
1704 private function mergeChangesIntoContent( &$editContent ){
1705 wfProfileIn( __METHOD__ );
1706
1707 $db = wfGetDB( DB_MASTER );
1708
1709 // This is the revision the editor started from
1710 $baseRevision = $this->getBaseRevision();
1711 $baseContent = $baseRevision ? $baseRevision->getContent() : null;
1712
1713 if ( is_null( $baseContent ) ) {
1714 wfProfileOut( __METHOD__ );
1715 return false;
1716 }
1717
1718 // The current state, we want to merge updates into it
1719 $currentRevision = Revision::loadFromTitle( $db, $this->mTitle );
1720 $currentContent = $currentRevision ? $currentRevision->getContent() : null;
1721
1722 if ( is_null( $currentContent ) ) {
1723 wfProfileOut( __METHOD__ );
1724 return false;
1725 }
1726
1727 $handler = ContentHandler::getForModelID( $baseContent->getModel() );
1728
1729 $result = $handler->merge3( $baseContent, $editContent, $currentContent );
1730
1731 if ( $result ) {
1732 $editContent = $result;
1733 wfProfileOut( __METHOD__ );
1734 return true;
1735 } else {
1736 wfProfileOut( __METHOD__ );
1737 return false;
1738 }
1739 }
1740
1741 /**
1742 * @return Revision
1743 */
1744 function getBaseRevision() {
1745 if ( !$this->mBaseRevision ) {
1746 $db = wfGetDB( DB_MASTER );
1747 $baseRevision = Revision::loadFromTimestamp(
1748 $db, $this->mTitle, $this->edittime );
1749 return $this->mBaseRevision = $baseRevision;
1750 } else {
1751 return $this->mBaseRevision;
1752 }
1753 }
1754
1755 /**
1756 * Check given input text against $wgSpamRegex, and return the text of the first match.
1757 *
1758 * @param $text string
1759 *
1760 * @return string|bool matching string or false
1761 */
1762 public static function matchSpamRegex( $text ) {
1763 global $wgSpamRegex;
1764 // For back compatibility, $wgSpamRegex may be a single string or an array of regexes.
1765 $regexes = (array)$wgSpamRegex;
1766 return self::matchSpamRegexInternal( $text, $regexes );
1767 }
1768
1769 /**
1770 * Check given input text against $wgSpamRegex, and return the text of the first match.
1771 *
1772 * @param $text string
1773 *
1774 * @return string|bool matching string or false
1775 */
1776 public static function matchSummarySpamRegex( $text ) {
1777 global $wgSummarySpamRegex;
1778 $regexes = (array)$wgSummarySpamRegex;
1779 return self::matchSpamRegexInternal( $text, $regexes );
1780 }
1781
1782 /**
1783 * @param $text string
1784 * @param $regexes array
1785 * @return bool|string
1786 */
1787 protected static function matchSpamRegexInternal( $text, $regexes ) {
1788 foreach ( $regexes as $regex ) {
1789 $matches = array();
1790 if ( preg_match( $regex, $text, $matches ) ) {
1791 return $matches[0];
1792 }
1793 }
1794 return false;
1795 }
1796
1797 function setHeaders() {
1798 global $wgOut, $wgUser;
1799
1800 $wgOut->addModules( 'mediawiki.action.edit' );
1801
1802 if ( $wgUser->getOption( 'uselivepreview', false ) ) {
1803 $wgOut->addModules( 'mediawiki.action.edit.preview' );
1804 }
1805 // Bug #19334: textarea jumps when editing articles in IE8
1806 $wgOut->addStyle( 'common/IE80Fixes.css', 'screen', 'IE 8' );
1807
1808 $wgOut->setRobotPolicy( 'noindex,nofollow' );
1809
1810 # Enabled article-related sidebar, toplinks, etc.
1811 $wgOut->setArticleRelated( true );
1812
1813 $contextTitle = $this->getContextTitle();
1814 if ( $this->isConflict ) {
1815 $msg = 'editconflict';
1816 } elseif ( $contextTitle->exists() && $this->section != '' ) {
1817 $msg = $this->section == 'new' ? 'editingcomment' : 'editingsection';
1818 } else {
1819 $msg = $contextTitle->exists() || ( $contextTitle->getNamespace() == NS_MEDIAWIKI && $contextTitle->getDefaultMessageText() !== false ) ?
1820 'editing' : 'creating';
1821 }
1822 # Use the title defined by DISPLAYTITLE magic word when present
1823 $displayTitle = isset( $this->mParserOutput ) ? $this->mParserOutput->getDisplayTitle() : false;
1824 if ( $displayTitle === false ) {
1825 $displayTitle = $contextTitle->getPrefixedText();
1826 }
1827 $wgOut->setPageTitle( wfMessage( $msg, $displayTitle ) );
1828 }
1829
1830 /**
1831 * Show all applicable editing introductions
1832 */
1833 protected function showIntro() {
1834 global $wgOut, $wgUser;
1835 if ( $this->suppressIntro ) {
1836 return;
1837 }
1838
1839 $namespace = $this->mTitle->getNamespace();
1840
1841 if ( $namespace == NS_MEDIAWIKI ) {
1842 # Show a warning if editing an interface message
1843 $wgOut->wrapWikiMsg( "<div class='mw-editinginterface'>\n$1\n</div>", 'editinginterface' );
1844 } else if( $namespace == NS_FILE ) {
1845 # Show a hint to shared repo
1846 $file = wfFindFile( $this->mTitle );
1847 if( $file && !$file->isLocal() ) {
1848 $descUrl = $file->getDescriptionUrl();
1849 # there must be a description url to show a hint to shared repo
1850 if( $descUrl ) {
1851 if( !$this->mTitle->exists() ) {
1852 $wgOut->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-create\">\n$1\n</div>", array (
1853 'sharedupload-desc-create', $file->getRepo()->getDisplayName(), $descUrl
1854 ) );
1855 } else {
1856 $wgOut->wrapWikiMsg( "<div class=\"mw-sharedupload-desc-edit\">\n$1\n</div>", array(
1857 'sharedupload-desc-edit', $file->getRepo()->getDisplayName(), $descUrl
1858 ) );
1859 }
1860 }
1861 }
1862 }
1863
1864 # Show a warning message when someone creates/edits a user (talk) page but the user does not exist
1865 # Show log extract when the user is currently blocked
1866 if ( $namespace == NS_USER || $namespace == NS_USER_TALK ) {
1867 $parts = explode( '/', $this->mTitle->getText(), 2 );
1868 $username = $parts[0];
1869 $user = User::newFromName( $username, false /* allow IP users*/ );
1870 $ip = User::isIP( $username );
1871 if ( !( $user && $user->isLoggedIn() ) && !$ip ) { # User does not exist
1872 $wgOut->wrapWikiMsg( "<div class=\"mw-userpage-userdoesnotexist error\">\n$1\n</div>",
1873 array( 'userpage-userdoesnotexist', wfEscapeWikiText( $username ) ) );
1874 } elseif ( $user->isBlocked() ) { # Show log extract if the user is currently blocked
1875 LogEventsList::showLogExtract(
1876 $wgOut,
1877 'block',
1878 $user->getUserPage(),
1879 '',
1880 array(
1881 'lim' => 1,
1882 'showIfEmpty' => false,
1883 'msgKey' => array(
1884 'blocked-notice-logextract',
1885 $user->getName() # Support GENDER in notice
1886 )
1887 )
1888 );
1889 }
1890 }
1891 # Try to add a custom edit intro, or use the standard one if this is not possible.
1892 if ( !$this->showCustomIntro() && !$this->mTitle->exists() ) {
1893 if ( $wgUser->isLoggedIn() ) {
1894 $wgOut->wrapWikiMsg( "<div class=\"mw-newarticletext\">\n$1\n</div>", 'newarticletext' );
1895 } else {
1896 $wgOut->wrapWikiMsg( "<div class=\"mw-newarticletextanon\">\n$1\n</div>", 'newarticletextanon' );
1897 }
1898 }
1899 # Give a notice if the user is editing a deleted/moved page...
1900 if ( !$this->mTitle->exists() ) {
1901 LogEventsList::showLogExtract( $wgOut, array( 'delete', 'move' ), $this->mTitle,
1902 '',
1903 array(
1904 'lim' => 10,
1905 'conds' => array( "log_action != 'revision'" ),
1906 'showIfEmpty' => false,
1907 'msgKey' => array( 'recreate-moveddeleted-warn' )
1908 )
1909 );
1910 }
1911 }
1912
1913 /**
1914 * Attempt to show a custom editing introduction, if supplied
1915 *
1916 * @return bool
1917 */
1918 protected function showCustomIntro() {
1919 if ( $this->editintro ) {
1920 $title = Title::newFromText( $this->editintro );
1921 if ( $title instanceof Title && $title->exists() && $title->userCan( 'read' ) ) {
1922 global $wgOut;
1923 // Added using template syntax, to take <noinclude>'s into account.
1924 $wgOut->addWikiTextTitleTidy( '{{:' . $title->getFullText() . '}}', $this->mTitle );
1925 return true;
1926 }
1927 }
1928 return false;
1929 }
1930
1931 /**
1932 * Gets an editable textual representation of $content.
1933 * The textual representation can be turned by into a Content object by the
1934 * toEditContent() method.
1935 *
1936 * If $content is null or false or a string, $content is returned unchanged.
1937 *
1938 * If the given Content object is not of a type that can be edited using the text base EditPage,
1939 * an exception will be raised. Set $this->allowNonTextContent to true to allow editing of non-textual
1940 * content.
1941 *
1942 * @param Content|null|false|string $content
1943 * @return String the editable text form of the content.
1944 *
1945 * @throws MWException if $content is not an instance of TextContent and $this->allowNonTextContent is not true.
1946 */
1947 protected function toEditText( $content ) {
1948 if ( $content === null || $content === false ) {
1949 return $content;
1950 }
1951
1952 if ( is_string( $content ) ) {
1953 return $content;
1954 }
1955
1956 if ( !$this->allowNonTextContent && !( $content instanceof TextContent ) ) {
1957 throw new MWException( "This content model can not be edited as text: "
1958 . ContentHandler::getLocalizedName( $content->getModel() ) );
1959 }
1960
1961 return $content->serialize( $this->contentFormat );
1962 }
1963
1964 /**
1965 * Turns the given text into a Content object by unserializing it.
1966 *
1967 * If the resulting Content object is not of a type that can be edited using the text base EditPage,
1968 * an exception will be raised. Set $this->allowNonTextContent to true to allow editing of non-textual
1969 * content.
1970 *
1971 * @param String|null|bool $text Text to unserialize
1972 * @return Content The content object created from $text. If $text was false or null, false resp. null will be
1973 * returned instead.
1974 *
1975 * @throws MWException if unserializing the text results in a Content object that is not an instance of TextContent
1976 * and $this->allowNonTextContent is not true.
1977 */
1978 protected function toEditContent( $text ) {
1979 if ( $text === false || $text === null ) {
1980 return $text;
1981 }
1982
1983 $content = ContentHandler::makeContent( $text, $this->getTitle(),
1984 $this->contentModel, $this->contentFormat );
1985
1986 if ( !$this->allowNonTextContent && !( $content instanceof TextContent ) ) {
1987 throw new MWException( "This content model can not be edited as text: "
1988 . ContentHandler::getLocalizedName( $content->getModel() ) );
1989 }
1990
1991 return $content;
1992 }
1993
1994 /**
1995 * Send the edit form and related headers to $wgOut
1996 * @param $formCallback Callback|null that takes an OutputPage parameter; will be called
1997 * during form output near the top, for captchas and the like.
1998 */
1999 function showEditForm( $formCallback = null ) {
2000 global $wgOut, $wgUser;
2001
2002 wfProfileIn( __METHOD__ );
2003
2004 # need to parse the preview early so that we know which templates are used,
2005 # otherwise users with "show preview after edit box" will get a blank list
2006 # we parse this near the beginning so that setHeaders can do the title
2007 # setting work instead of leaving it in getPreviewText
2008 $previewOutput = '';
2009 if ( $this->formtype == 'preview' ) {
2010 $previewOutput = $this->getPreviewText();
2011 }
2012
2013 wfRunHooks( 'EditPage::showEditForm:initial', array( &$this, &$wgOut ) );
2014
2015 $this->setHeaders();
2016
2017 if ( $this->showHeader() === false ) {
2018 wfProfileOut( __METHOD__ );
2019 return;
2020 }
2021
2022 $wgOut->addHTML( $this->editFormPageTop );
2023
2024 if ( $wgUser->getOption( 'previewontop' ) ) {
2025 $this->displayPreviewArea( $previewOutput, true );
2026 }
2027
2028 $wgOut->addHTML( $this->editFormTextTop );
2029
2030 $showToolbar = true;
2031 if ( $this->wasDeletedSinceLastEdit() ) {
2032 if ( $this->formtype == 'save' ) {
2033 // Hide the toolbar and edit area, user can click preview to get it back
2034 // Add an confirmation checkbox and explanation.
2035 $showToolbar = false;
2036 } else {
2037 $wgOut->wrapWikiMsg( "<div class='error mw-deleted-while-editing'>\n$1\n</div>",
2038 'deletedwhileediting' );
2039 }
2040 }
2041
2042 //@todo: add EditForm plugin interface and use it here!
2043 // search for textarea1 and textares2, and allow EditForm to override all uses.
2044 $wgOut->addHTML( Html::openElement( 'form', array( 'id' => self::EDITFORM_ID, 'name' => self::EDITFORM_ID,
2045 'method' => 'post', 'action' => $this->getActionURL( $this->getContextTitle() ),
2046 'enctype' => 'multipart/form-data' ) ) );
2047
2048 if ( is_callable( $formCallback ) ) {
2049 call_user_func_array( $formCallback, array( &$wgOut ) );
2050 }
2051
2052 wfRunHooks( 'EditPage::showEditForm:fields', array( &$this, &$wgOut ) );
2053
2054 // Put these up at the top to ensure they aren't lost on early form submission
2055 $this->showFormBeforeText();
2056
2057 if ( $this->wasDeletedSinceLastEdit() && 'save' == $this->formtype ) {
2058 $username = $this->lastDelete->user_name;
2059 $comment = $this->lastDelete->log_comment;
2060
2061 // It is better to not parse the comment at all than to have templates expanded in the middle
2062 // TODO: can the checkLabel be moved outside of the div so that wrapWikiMsg could be used?
2063 $key = $comment === ''
2064 ? 'confirmrecreate-noreason'
2065 : 'confirmrecreate';
2066 $wgOut->addHTML(
2067 '<div class="mw-confirm-recreate">' .
2068 wfMessage( $key, $username, "<nowiki>$comment</nowiki>" )->parse() .
2069 Xml::checkLabel( wfMessage( 'recreate' )->text(), 'wpRecreate', 'wpRecreate', false,
2070 array( 'title' => Linker::titleAttrib( 'recreate' ), 'tabindex' => 1, 'id' => 'wpRecreate' )
2071 ) .
2072 '</div>'
2073 );
2074 }
2075
2076 # When the summary is hidden, also hide them on preview/show changes
2077 if( $this->nosummary ) {
2078 $wgOut->addHTML( Html::hidden( 'nosummary', true ) );
2079 }
2080
2081 # If a blank edit summary was previously provided, and the appropriate
2082 # user preference is active, pass a hidden tag as wpIgnoreBlankSummary. This will stop the
2083 # user being bounced back more than once in the event that a summary
2084 # is not required.
2085 #####
2086 # For a bit more sophisticated detection of blank summaries, hash the
2087 # automatic one and pass that in the hidden field wpAutoSummary.
2088 if ( $this->missingSummary || ( $this->section == 'new' && $this->nosummary ) ) {
2089 $wgOut->addHTML( Html::hidden( 'wpIgnoreBlankSummary', true ) );
2090 }
2091
2092 if ( $this->undidRev ) {
2093 $wgOut->addHTML( Html::hidden( 'wpUndidRevision', $this->undidRev ) );
2094 }
2095
2096 if ( $this->hasPresetSummary ) {
2097 // If a summary has been preset using &summary= we dont want to prompt for
2098 // a different summary. Only prompt for a summary if the summary is blanked.
2099 // (Bug 17416)
2100 $this->autoSumm = md5( '' );
2101 }
2102
2103 $autosumm = $this->autoSumm ? $this->autoSumm : md5( $this->summary );
2104 $wgOut->addHTML( Html::hidden( 'wpAutoSummary', $autosumm ) );
2105
2106 $wgOut->addHTML( Html::hidden( 'oldid', $this->oldid ) );
2107
2108 $wgOut->addHTML( Html::hidden( 'format', $this->contentFormat ) );
2109 $wgOut->addHTML( Html::hidden( 'model', $this->contentModel ) );
2110
2111 if ( $this->section == 'new' ) {
2112 $this->showSummaryInput( true, $this->summary );
2113 $wgOut->addHTML( $this->getSummaryPreview( true, $this->summary ) );
2114 }
2115
2116 $wgOut->addHTML( $this->editFormTextBeforeContent );
2117
2118 if ( !$this->isCssJsSubpage && $showToolbar && $wgUser->getOption( 'showtoolbar' ) ) {
2119 $wgOut->addHTML( EditPage::getEditToolbar() );
2120 }
2121
2122 if ( $this->isConflict ) {
2123 // In an edit conflict bypass the overrideable content form method
2124 // and fallback to the raw wpTextbox1 since editconflicts can't be
2125 // resolved between page source edits and custom ui edits using the
2126 // custom edit ui.
2127 $this->textbox2 = $this->textbox1;
2128
2129 $content = $this->getCurrentContent();
2130 $this->textbox1 = $this->toEditText( $content );
2131
2132 $this->showTextbox1();
2133 } else {
2134 $this->showContentForm();
2135 }
2136
2137 $wgOut->addHTML( $this->editFormTextAfterContent );
2138
2139 $this->showStandardInputs();
2140
2141 $this->showFormAfterText();
2142
2143 $this->showTosSummary();
2144
2145 $this->showEditTools();
2146
2147 $wgOut->addHTML( $this->editFormTextAfterTools . "\n" );
2148
2149 $wgOut->addHTML( Html::rawElement( 'div', array( 'class' => 'templatesUsed' ),
2150 Linker::formatTemplates( $this->getTemplates(), $this->preview, $this->section != '' ) ) );
2151
2152 $wgOut->addHTML( Html::rawElement( 'div', array( 'class' => 'hiddencats' ),
2153 Linker::formatHiddenCategories( $this->mArticle->getHiddenCategories() ) ) );
2154
2155 if ( $this->isConflict ) {
2156 try {
2157 $this->showConflict();
2158 } catch ( MWContentSerializationException $ex ) {
2159 // this can't really happen, but be nice if it does.
2160 $msg = wfMessage( 'content-failed-to-parse', $this->contentModel, $this->contentFormat, $ex->getMessage() );
2161 $wgOut->addWikiText( '<div class="error">' . $msg->text() . '</div>');
2162 }
2163 }
2164
2165 $wgOut->addHTML( $this->editFormTextBottom . "\n</form>\n" );
2166
2167 if ( !$wgUser->getOption( 'previewontop' ) ) {
2168 $this->displayPreviewArea( $previewOutput, false );
2169 }
2170
2171 wfProfileOut( __METHOD__ );
2172 }
2173
2174 /**
2175 * Extract the section title from current section text, if any.
2176 *
2177 * @param string $text
2178 * @return Mixed|string or false
2179 */
2180 public static function extractSectionTitle( $text ) {
2181 preg_match( "/^(=+)(.+)\\1\\s*(\n|$)/i", $text, $matches );
2182 if ( !empty( $matches[2] ) ) {
2183 global $wgParser;
2184 return $wgParser->stripSectionName( trim( $matches[2] ) );
2185 } else {
2186 return false;
2187 }
2188 }
2189
2190 protected function showHeader() {
2191 global $wgOut, $wgUser, $wgMaxArticleSize, $wgLang;
2192
2193 if ( $this->mTitle->isTalkPage() ) {
2194 $wgOut->addWikiMsg( 'talkpagetext' );
2195 }
2196
2197 # Optional notices on a per-namespace and per-page basis
2198 $editnotice_ns = 'editnotice-' . $this->mTitle->getNamespace();
2199 $editnotice_ns_message = wfMessage( $editnotice_ns );
2200 if ( $editnotice_ns_message->exists() ) {
2201 $wgOut->addWikiText( $editnotice_ns_message->plain() );
2202 }
2203 if ( MWNamespace::hasSubpages( $this->mTitle->getNamespace() ) ) {
2204 $parts = explode( '/', $this->mTitle->getDBkey() );
2205 $editnotice_base = $editnotice_ns;
2206 while ( count( $parts ) > 0 ) {
2207 $editnotice_base .= '-' . array_shift( $parts );
2208 $editnotice_base_msg = wfMessage( $editnotice_base );
2209 if ( $editnotice_base_msg->exists() ) {
2210 $wgOut->addWikiText( $editnotice_base_msg->plain() );
2211 }
2212 }
2213 } else {
2214 # Even if there are no subpages in namespace, we still don't want / in MW ns.
2215 $editnoticeText = $editnotice_ns . '-' . str_replace( '/', '-', $this->mTitle->getDBkey() );
2216 $editnoticeMsg = wfMessage( $editnoticeText );
2217 if ( $editnoticeMsg->exists() ) {
2218 $wgOut->addWikiText( $editnoticeMsg->plain() );
2219 }
2220 }
2221
2222 if ( $this->isConflict ) {
2223 $wgOut->wrapWikiMsg( "<div class='mw-explainconflict'>\n$1\n</div>", 'explainconflict' );
2224 $this->edittime = $this->mArticle->getTimestamp();
2225 } else {
2226 if ( $this->section != '' && !$this->isSectionEditSupported() ) {
2227 // We use $this->section to much before this and getVal('wgSection') directly in other places
2228 // at this point we can't reset $this->section to '' to fallback to non-section editing.
2229 // Someone is welcome to try refactoring though
2230 $wgOut->showErrorPage( 'sectioneditnotsupported-title', 'sectioneditnotsupported-text' );
2231 return false;
2232 }
2233
2234 if ( $this->section != '' && $this->section != 'new' ) {
2235 if ( !$this->summary && !$this->preview && !$this->diff ) {
2236 $sectionTitle = self::extractSectionTitle( $this->textbox1 ); //FIXME: use Content object
2237 if ( $sectionTitle !== false ) {
2238 $this->summary = "/* $sectionTitle */ ";
2239 }
2240 }
2241 }
2242
2243 if ( $this->missingComment ) {
2244 $wgOut->wrapWikiMsg( "<div id='mw-missingcommenttext'>\n$1\n</div>", 'missingcommenttext' );
2245 }
2246
2247 if ( $this->missingSummary && $this->section != 'new' ) {
2248 $wgOut->wrapWikiMsg( "<div id='mw-missingsummary'>\n$1\n</div>", 'missingsummary' );
2249 }
2250
2251 if ( $this->missingSummary && $this->section == 'new' ) {
2252 $wgOut->wrapWikiMsg( "<div id='mw-missingcommentheader'>\n$1\n</div>", 'missingcommentheader' );
2253 }
2254
2255 if ( $this->hookError !== '' ) {
2256 $wgOut->addWikiText( $this->hookError );
2257 }
2258
2259 if ( !$this->checkUnicodeCompliantBrowser() ) {
2260 $wgOut->addWikiMsg( 'nonunicodebrowser' );
2261 }
2262
2263 if ( $this->section != 'new' ) {
2264 $revision = $this->mArticle->getRevisionFetched();
2265 if ( $revision ) {
2266 // Let sysop know that this will make private content public if saved
2267
2268 if ( !$revision->userCan( Revision::DELETED_TEXT ) ) {
2269 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n", 'rev-deleted-text-permission' );
2270 } elseif ( $revision->isDeleted( Revision::DELETED_TEXT ) ) {
2271 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n", 'rev-deleted-text-view' );
2272 }
2273
2274 if ( !$revision->isCurrent() ) {
2275 $this->mArticle->setOldSubtitle( $revision->getId() );
2276 $wgOut->addWikiMsg( 'editingold' );
2277 }
2278 } elseif ( $this->mTitle->exists() ) {
2279 // Something went wrong
2280
2281 $wgOut->wrapWikiMsg( "<div class='errorbox'>\n$1\n</div>\n",
2282 array( 'missing-revision', $this->oldid ) );
2283 }
2284 }
2285 }
2286
2287 if ( wfReadOnly() ) {
2288 $wgOut->wrapWikiMsg( "<div id=\"mw-read-only-warning\">\n$1\n</div>", array( 'readonlywarning', wfReadOnlyReason() ) );
2289 } elseif ( $wgUser->isAnon() ) {
2290 if ( $this->formtype != 'preview' ) {
2291 $wgOut->wrapWikiMsg( "<div id=\"mw-anon-edit-warning\">\n$1</div>", 'anoneditwarning' );
2292 } else {
2293 $wgOut->wrapWikiMsg( "<div id=\"mw-anon-preview-warning\">\n$1</div>", 'anonpreviewwarning' );
2294 }
2295 } else {
2296 if ( $this->isCssJsSubpage ) {
2297 # Check the skin exists
2298 if ( $this->isWrongCaseCssJsPage ) {
2299 $wgOut->wrapWikiMsg( "<div class='error' id='mw-userinvalidcssjstitle'>\n$1\n</div>", array( 'userinvalidcssjstitle', $this->mTitle->getSkinFromCssJsSubpage() ) );
2300 }
2301 if ( $this->formtype !== 'preview' ) {
2302 if ( $this->isCssSubpage )
2303 $wgOut->wrapWikiMsg( "<div id='mw-usercssyoucanpreview'>\n$1\n</div>", array( 'usercssyoucanpreview' ) );
2304 if ( $this->isJsSubpage )
2305 $wgOut->wrapWikiMsg( "<div id='mw-userjsyoucanpreview'>\n$1\n</div>", array( 'userjsyoucanpreview' ) );
2306 }
2307 }
2308 }
2309
2310 if ( $this->mTitle->getNamespace() != NS_MEDIAWIKI && $this->mTitle->isProtected( 'edit' ) ) {
2311 # Is the title semi-protected?
2312 if ( $this->mTitle->isSemiProtected() ) {
2313 $noticeMsg = 'semiprotectedpagewarning';
2314 } else {
2315 # Then it must be protected based on static groups (regular)
2316 $noticeMsg = 'protectedpagewarning';
2317 }
2318 LogEventsList::showLogExtract( $wgOut, 'protect', $this->mTitle, '',
2319 array( 'lim' => 1, 'msgKey' => array( $noticeMsg ) ) );
2320 }
2321 if ( $this->mTitle->isCascadeProtected() ) {
2322 # Is this page under cascading protection from some source pages?
2323 list( $cascadeSources, /* $restrictions */ ) = $this->mTitle->getCascadeProtectionSources();
2324 $notice = "<div class='mw-cascadeprotectedwarning'>\n$1\n";
2325 $cascadeSourcesCount = count( $cascadeSources );
2326 if ( $cascadeSourcesCount > 0 ) {
2327 # Explain, and list the titles responsible
2328 foreach ( $cascadeSources as $page ) {
2329 $notice .= '* [[:' . $page->getPrefixedText() . "]]\n";
2330 }
2331 }
2332 $notice .= '</div>';
2333 $wgOut->wrapWikiMsg( $notice, array( 'cascadeprotectedwarning', $cascadeSourcesCount ) );
2334 }
2335 if ( !$this->mTitle->exists() && $this->mTitle->getRestrictions( 'create' ) ) {
2336 LogEventsList::showLogExtract( $wgOut, 'protect', $this->mTitle, '',
2337 array( 'lim' => 1,
2338 'showIfEmpty' => false,
2339 'msgKey' => array( 'titleprotectedwarning' ),
2340 'wrap' => "<div class=\"mw-titleprotectedwarning\">\n$1</div>" ) );
2341 }
2342
2343 if ( $this->kblength === false ) {
2344 $this->kblength = (int)( strlen( $this->textbox1 ) / 1024 );
2345 }
2346
2347 if ( $this->tooBig || $this->kblength > $wgMaxArticleSize ) {
2348 $wgOut->wrapWikiMsg( "<div class='error' id='mw-edit-longpageerror'>\n$1\n</div>",
2349 array( 'longpageerror', $wgLang->formatNum( $this->kblength ), $wgLang->formatNum( $wgMaxArticleSize ) ) );
2350 } else {
2351 if ( !wfMessage( 'longpage-hint' )->isDisabled() ) {
2352 $wgOut->wrapWikiMsg( "<div id='mw-edit-longpage-hint'>\n$1\n</div>",
2353 array( 'longpage-hint', $wgLang->formatSize( strlen( $this->textbox1 ) ), strlen( $this->textbox1 ) )
2354 );
2355 }
2356 }
2357 # Add header copyright warning
2358 $this->showHeaderCopyrightWarning();
2359 }
2360
2361
2362 /**
2363 * Standard summary input and label (wgSummary), abstracted so EditPage
2364 * subclasses may reorganize the form.
2365 * Note that you do not need to worry about the label's for=, it will be
2366 * inferred by the id given to the input. You can remove them both by
2367 * passing array( 'id' => false ) to $userInputAttrs.
2368 *
2369 * @param $summary string The value of the summary input
2370 * @param $labelText string The html to place inside the label
2371 * @param $inputAttrs array of attrs to use on the input
2372 * @param $spanLabelAttrs array of attrs to use on the span inside the label
2373 *
2374 * @return array An array in the format array( $label, $input )
2375 */
2376 function getSummaryInput( $summary = "", $labelText = null, $inputAttrs = null, $spanLabelAttrs = null ) {
2377 // Note: the maxlength is overriden in JS to 255 and to make it use UTF-8 bytes, not characters.
2378 $inputAttrs = ( is_array( $inputAttrs ) ? $inputAttrs : array() ) + array(
2379 'id' => 'wpSummary',
2380 'maxlength' => '200',
2381 'tabindex' => '1',
2382 'size' => 60,
2383 'spellcheck' => 'true',
2384 ) + Linker::tooltipAndAccesskeyAttribs( 'summary' );
2385
2386 $spanLabelAttrs = ( is_array( $spanLabelAttrs ) ? $spanLabelAttrs : array() ) + array(
2387 'class' => $this->missingSummary ? 'mw-summarymissed' : 'mw-summary',
2388 'id' => "wpSummaryLabel"
2389 );
2390
2391 $label = null;
2392 if ( $labelText ) {
2393 $label = Xml::tags( 'label', $inputAttrs['id'] ? array( 'for' => $inputAttrs['id'] ) : null, $labelText );
2394 $label = Xml::tags( 'span', $spanLabelAttrs, $label );
2395 }
2396
2397 $input = Html::input( 'wpSummary', $summary, 'text', $inputAttrs );
2398
2399 return array( $label, $input );
2400 }
2401
2402 /**
2403 * @param $isSubjectPreview Boolean: true if this is the section subject/title
2404 * up top, or false if this is the comment summary
2405 * down below the textarea
2406 * @param $summary String: The text of the summary to display
2407 * @return String
2408 */
2409 protected function showSummaryInput( $isSubjectPreview, $summary = "" ) {
2410 global $wgOut, $wgContLang;
2411 # Add a class if 'missingsummary' is triggered to allow styling of the summary line
2412 $summaryClass = $this->missingSummary ? 'mw-summarymissed' : 'mw-summary';
2413 if ( $isSubjectPreview ) {
2414 if ( $this->nosummary ) {
2415 return;
2416 }
2417 } else {
2418 if ( !$this->mShowSummaryField ) {
2419 return;
2420 }
2421 }
2422 $summary = $wgContLang->recodeForEdit( $summary );
2423 $labelText = wfMessage( $isSubjectPreview ? 'subject' : 'summary' )->parse();
2424 list( $label, $input ) = $this->getSummaryInput( $summary, $labelText, array( 'class' => $summaryClass ), array() );
2425 $wgOut->addHTML( "{$label} {$input}" );
2426 }
2427
2428 /**
2429 * @param $isSubjectPreview Boolean: true if this is the section subject/title
2430 * up top, or false if this is the comment summary
2431 * down below the textarea
2432 * @param $summary String: the text of the summary to display
2433 * @return String
2434 */
2435 protected function getSummaryPreview( $isSubjectPreview, $summary = "" ) {
2436 if ( !$summary || ( !$this->preview && !$this->diff ) )
2437 return "";
2438
2439 global $wgParser;
2440
2441 if ( $isSubjectPreview )
2442 $summary = wfMessage( 'newsectionsummary', $wgParser->stripSectionName( $summary ) )
2443 ->inContentLanguage()->text();
2444
2445 $message = $isSubjectPreview ? 'subject-preview' : 'summary-preview';
2446
2447 $summary = wfMessage( $message )->parse() . Linker::commentBlock( $summary, $this->mTitle, $isSubjectPreview );
2448 return Xml::tags( 'div', array( 'class' => 'mw-summary-preview' ), $summary );
2449 }
2450
2451 protected function showFormBeforeText() {
2452 global $wgOut;
2453 $section = htmlspecialchars( $this->section );
2454 $wgOut->addHTML( <<<HTML
2455 <input type='hidden' value="{$section}" name="wpSection" />
2456 <input type='hidden' value="{$this->starttime}" name="wpStarttime" />
2457 <input type='hidden' value="{$this->edittime}" name="wpEdittime" />
2458 <input type='hidden' value="{$this->scrolltop}" name="wpScrolltop" id="wpScrolltop" />
2459
2460 HTML
2461 );
2462 if ( !$this->checkUnicodeCompliantBrowser() )
2463 $wgOut->addHTML( Html::hidden( 'safemode', '1' ) );
2464 }
2465
2466 protected function showFormAfterText() {
2467 global $wgOut, $wgUser;
2468 /**
2469 * To make it harder for someone to slip a user a page
2470 * which submits an edit form to the wiki without their
2471 * knowledge, a random token is associated with the login
2472 * session. If it's not passed back with the submission,
2473 * we won't save the page, or render user JavaScript and
2474 * CSS previews.
2475 *
2476 * For anon editors, who may not have a session, we just
2477 * include the constant suffix to prevent editing from
2478 * broken text-mangling proxies.
2479 */
2480 $wgOut->addHTML( "\n" . Html::hidden( "wpEditToken", $wgUser->getEditToken() ) . "\n" );
2481 }
2482
2483 /**
2484 * Subpage overridable method for printing the form for page content editing
2485 * By default this simply outputs wpTextbox1
2486 * Subclasses can override this to provide a custom UI for editing;
2487 * be it a form, or simply wpTextbox1 with a modified content that will be
2488 * reverse modified when extracted from the post data.
2489 * Note that this is basically the inverse for importContentFormData
2490 */
2491 protected function showContentForm() {
2492 $this->showTextbox1();
2493 }
2494
2495 /**
2496 * Method to output wpTextbox1
2497 * The $textoverride method can be used by subclasses overriding showContentForm
2498 * to pass back to this method.
2499 *
2500 * @param $customAttribs array of html attributes to use in the textarea
2501 * @param $textoverride String: optional text to override $this->textarea1 with
2502 */
2503 protected function showTextbox1( $customAttribs = null, $textoverride = null ) {
2504 if ( $this->wasDeletedSinceLastEdit() && $this->formtype == 'save' ) {
2505 $attribs = array( 'style' => 'display:none;' );
2506 } else {
2507 $classes = array(); // Textarea CSS
2508 if ( $this->mTitle->getNamespace() != NS_MEDIAWIKI && $this->mTitle->isProtected( 'edit' ) ) {
2509 # Is the title semi-protected?
2510 if ( $this->mTitle->isSemiProtected() ) {
2511 $classes[] = 'mw-textarea-sprotected';
2512 } else {
2513 # Then it must be protected based on static groups (regular)
2514 $classes[] = 'mw-textarea-protected';
2515 }
2516 # Is the title cascade-protected?
2517 if ( $this->mTitle->isCascadeProtected() ) {
2518 $classes[] = 'mw-textarea-cprotected';
2519 }
2520 }
2521
2522 $attribs = array( 'tabindex' => 1 );
2523
2524 if ( is_array( $customAttribs ) ) {
2525 $attribs += $customAttribs;
2526 }
2527
2528 if ( count( $classes ) ) {
2529 if ( isset( $attribs['class'] ) ) {
2530 $classes[] = $attribs['class'];
2531 }
2532 $attribs['class'] = implode( ' ', $classes );
2533 }
2534 }
2535
2536 $this->showTextbox( $textoverride !== null ? $textoverride : $this->textbox1, 'wpTextbox1', $attribs );
2537 }
2538
2539 protected function showTextbox2() {
2540 $this->showTextbox( $this->textbox2, 'wpTextbox2', array( 'tabindex' => 6, 'readonly' ) );
2541 }
2542
2543 protected function showTextbox( $text, $name, $customAttribs = array() ) {
2544 global $wgOut, $wgUser;
2545
2546 $wikitext = $this->safeUnicodeOutput( $text );
2547 if ( strval( $wikitext ) !== '' ) {
2548 // Ensure there's a newline at the end, otherwise adding lines
2549 // is awkward.
2550 // But don't add a newline if the ext is empty, or Firefox in XHTML
2551 // mode will show an extra newline. A bit annoying.
2552 $wikitext .= "\n";
2553 }
2554
2555 $attribs = $customAttribs + array(
2556 'accesskey' => ',',
2557 'id' => $name,
2558 'cols' => $wgUser->getIntOption( 'cols' ),
2559 'rows' => $wgUser->getIntOption( 'rows' ),
2560 'style' => '' // avoid php notices when appending preferences (appending allows customAttribs['style'] to still work
2561 );
2562
2563 $pageLang = $this->mTitle->getPageLanguage();
2564 $attribs['lang'] = $pageLang->getCode();
2565 $attribs['dir'] = $pageLang->getDir();
2566
2567 $wgOut->addHTML( Html::textarea( $name, $wikitext, $attribs ) );
2568 }
2569
2570 protected function displayPreviewArea( $previewOutput, $isOnTop = false ) {
2571 global $wgOut;
2572 $classes = array();
2573 if ( $isOnTop ) {
2574 $classes[] = 'ontop';
2575 }
2576
2577 $attribs = array( 'id' => 'wikiPreview', 'class' => implode( ' ', $classes ) );
2578
2579 if ( $this->formtype != 'preview' )
2580 $attribs['style'] = 'display: none;';
2581
2582 $wgOut->addHTML( Xml::openElement( 'div', $attribs ) );
2583
2584 if ( $this->formtype == 'preview' ) {
2585 $this->showPreview( $previewOutput );
2586 }
2587
2588 $wgOut->addHTML( '</div>' );
2589
2590 if ( $this->formtype == 'diff' ) {
2591 try {
2592 $this->showDiff();
2593 } catch ( MWContentSerializationException $ex ) {
2594 $msg = wfMessage( 'content-failed-to-parse', $this->contentModel, $this->contentFormat, $ex->getMessage() );
2595 $wgOut->addWikiText( '<div class="error">' . $msg->text() . '</div>');
2596 }
2597 }
2598 }
2599
2600 /**
2601 * Append preview output to $wgOut.
2602 * Includes category rendering if this is a category page.
2603 *
2604 * @param $text String: the HTML to be output for the preview.
2605 */
2606 protected function showPreview( $text ) {
2607 global $wgOut;
2608 if ( $this->mTitle->getNamespace() == NS_CATEGORY ) {
2609 $this->mArticle->openShowCategory();
2610 }
2611 # This hook seems slightly odd here, but makes things more
2612 # consistent for extensions.
2613 wfRunHooks( 'OutputPageBeforeHTML', array( &$wgOut, &$text ) );
2614 $wgOut->addHTML( $text );
2615 if ( $this->mTitle->getNamespace() == NS_CATEGORY ) {
2616 $this->mArticle->closeShowCategory();
2617 }
2618 }
2619
2620 /**
2621 * Get a diff between the current contents of the edit box and the
2622 * version of the page we're editing from.
2623 *
2624 * If this is a section edit, we'll replace the section as for final
2625 * save and then make a comparison.
2626 */
2627 function showDiff() {
2628 global $wgUser, $wgContLang, $wgOut;
2629
2630 $oldtitlemsg = 'currentrev';
2631 # if message does not exist, show diff against the preloaded default
2632 if( $this->mTitle->getNamespace() == NS_MEDIAWIKI && !$this->mTitle->exists() ) {
2633 $oldtext = $this->mTitle->getDefaultMessageText();
2634 if( $oldtext !== false ) {
2635 $oldtitlemsg = 'defaultmessagetext';
2636 $oldContent = $this->toEditContent( $oldtext );
2637 } else {
2638 $oldContent = null;
2639 }
2640 } else {
2641 $oldContent = $this->getOriginalContent();
2642 }
2643
2644 $textboxContent = $this->toEditContent( $this->textbox1 );
2645
2646 $newContent = $this->mArticle->replaceSectionContent(
2647 $this->section, $textboxContent,
2648 $this->summary, $this->edittime );
2649
2650 if ( $newContent ) {
2651 ContentHandler::runLegacyHooks( 'EditPageGetDiffText', array( $this, &$newContent ) );
2652 wfRunHooks( 'EditPageGetDiffContent', array( $this, &$newContent ) );
2653
2654 $popts = ParserOptions::newFromUserAndLang( $wgUser, $wgContLang );
2655 $newContent = $newContent->preSaveTransform( $this->mTitle, $wgUser, $popts );
2656 }
2657
2658 if ( ( $oldContent && !$oldContent->isEmpty() ) || ( $newContent && !$newContent->isEmpty() ) ) {
2659 $oldtitle = wfMessage( $oldtitlemsg )->parse();
2660 $newtitle = wfMessage( 'yourtext' )->parse();
2661
2662 if ( !$oldContent ) {
2663 $oldContent = $newContent->getContentHandler()->makeEmptyContent();
2664 }
2665
2666 if ( !$newContent ) {
2667 $newContent = $oldContent->getContentHandler()->makeEmptyContent();
2668 }
2669
2670 $de = $oldContent->getContentHandler()->createDifferenceEngine( $this->mArticle->getContext() );
2671 $de->setContent( $oldContent, $newContent );
2672
2673 $difftext = $de->getDiff( $oldtitle, $newtitle );
2674 $de->showDiffStyle();
2675 } else {
2676 $difftext = '';
2677 }
2678
2679 $wgOut->addHTML( '<div id="wikiDiff">' . $difftext . '</div>' );
2680 }
2681
2682 /**
2683 * Show the header copyright warning.
2684 */
2685 protected function showHeaderCopyrightWarning() {
2686 $msg = 'editpage-head-copy-warn';
2687 if ( !wfMessage( $msg )->isDisabled() ) {
2688 global $wgOut;
2689 $wgOut->wrapWikiMsg( "<div class='editpage-head-copywarn'>\n$1\n</div>",
2690 'editpage-head-copy-warn' );
2691 }
2692 }
2693
2694 /**
2695 * Give a chance for site and per-namespace customizations of
2696 * terms of service summary link that might exist separately
2697 * from the copyright notice.
2698 *
2699 * This will display between the save button and the edit tools,
2700 * so should remain short!
2701 */
2702 protected function showTosSummary() {
2703 $msg = 'editpage-tos-summary';
2704 wfRunHooks( 'EditPageTosSummary', array( $this->mTitle, &$msg ) );
2705 if ( !wfMessage( $msg )->isDisabled() ) {
2706 global $wgOut;
2707 $wgOut->addHTML( '<div class="mw-tos-summary">' );
2708 $wgOut->addWikiMsg( $msg );
2709 $wgOut->addHTML( '</div>' );
2710 }
2711 }
2712
2713 protected function showEditTools() {
2714 global $wgOut;
2715 $wgOut->addHTML( '<div class="mw-editTools">' .
2716 wfMessage( 'edittools' )->inContentLanguage()->parse() .
2717 '</div>' );
2718 }
2719
2720 /**
2721 * Get the copyright warning
2722 *
2723 * Renamed to getCopyrightWarning(), old name kept around for backwards compatibility
2724 */
2725 protected function getCopywarn() {
2726 return self::getCopyrightWarning( $this->mTitle );
2727 }
2728
2729 public static function getCopyrightWarning( $title ) {
2730 global $wgRightsText;
2731 if ( $wgRightsText ) {
2732 $copywarnMsg = array( 'copyrightwarning',
2733 '[[' . wfMessage( 'copyrightpage' )->inContentLanguage()->text() . ']]',
2734 $wgRightsText );
2735 } else {
2736 $copywarnMsg = array( 'copyrightwarning2',
2737 '[[' . wfMessage( 'copyrightpage' )->inContentLanguage()->text() . ']]' );
2738 }
2739 // Allow for site and per-namespace customization of contribution/copyright notice.
2740 wfRunHooks( 'EditPageCopyrightWarning', array( $title, &$copywarnMsg ) );
2741
2742 return "<div id=\"editpage-copywarn\">\n" .
2743 call_user_func_array( 'wfMessage', $copywarnMsg )->plain() . "\n</div>";
2744 }
2745
2746 protected function showStandardInputs( &$tabindex = 2 ) {
2747 global $wgOut;
2748 $wgOut->addHTML( "<div class='editOptions'>\n" );
2749
2750 if ( $this->section != 'new' ) {
2751 $this->showSummaryInput( false, $this->summary );
2752 $wgOut->addHTML( $this->getSummaryPreview( false, $this->summary ) );
2753 }
2754
2755 $checkboxes = $this->getCheckboxes( $tabindex,
2756 array( 'minor' => $this->minoredit, 'watch' => $this->watchthis ) );
2757 $wgOut->addHTML( "<div class='editCheckboxes'>" . implode( $checkboxes, "\n" ) . "</div>\n" );
2758
2759 // Show copyright warning.
2760 $wgOut->addWikiText( $this->getCopywarn() );
2761 $wgOut->addHTML( $this->editFormTextAfterWarn );
2762
2763 $wgOut->addHTML( "<div class='editButtons'>\n" );
2764 $wgOut->addHTML( implode( $this->getEditButtons( $tabindex ), "\n" ) . "\n" );
2765
2766 $cancel = $this->getCancelLink();
2767 if ( $cancel !== '' ) {
2768 $cancel .= wfMessage( 'pipe-separator' )->text();
2769 }
2770 $edithelpurl = Skin::makeInternalOrExternalUrl( wfMessage( 'edithelppage' )->inContentLanguage()->text() );
2771 $edithelp = '<a target="helpwindow" href="' . $edithelpurl . '">' .
2772 wfMessage( 'edithelp' )->escaped() . '</a> ' .
2773 wfMessage( 'newwindow' )->parse();
2774 $wgOut->addHTML( " <span class='cancelLink'>{$cancel}</span>\n" );
2775 $wgOut->addHTML( " <span class='editHelp'>{$edithelp}</span>\n" );
2776 $wgOut->addHTML( "</div><!-- editButtons -->\n</div><!-- editOptions -->\n" );
2777 }
2778
2779 /**
2780 * Show an edit conflict. textbox1 is already shown in showEditForm().
2781 * If you want to use another entry point to this function, be careful.
2782 */
2783 protected function showConflict() {
2784 global $wgOut;
2785
2786 if ( wfRunHooks( 'EditPageBeforeConflictDiff', array( &$this, &$wgOut ) ) ) {
2787 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
2788
2789 $content1 = $this->toEditContent( $this->textbox1 );
2790 $content2 = $this->toEditContent( $this->textbox2 );
2791
2792 $handler = ContentHandler::getForModelID( $this->contentModel );
2793 $de = $handler->createDifferenceEngine( $this->mArticle->getContext() );
2794 $de->setContent( $content2, $content1 );
2795 $de->showDiff(
2796 wfMessage( 'yourtext' )->parse(),
2797 wfMessage( 'storedversion' )->text()
2798 );
2799
2800 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
2801 $this->showTextbox2();
2802 }
2803 }
2804
2805 /**
2806 * @return string
2807 */
2808 public function getCancelLink() {
2809 $cancelParams = array();
2810 if ( !$this->isConflict && $this->oldid > 0 ) {
2811 $cancelParams['oldid'] = $this->oldid;
2812 }
2813
2814 return Linker::linkKnown(
2815 $this->getContextTitle(),
2816 wfMessage( 'cancel' )->parse(),
2817 array( 'id' => 'mw-editform-cancel' ),
2818 $cancelParams
2819 );
2820 }
2821
2822 /**
2823 * Returns the URL to use in the form's action attribute.
2824 * This is used by EditPage subclasses when simply customizing the action
2825 * variable in the constructor is not enough. This can be used when the
2826 * EditPage lives inside of a Special page rather than a custom page action.
2827 *
2828 * @param $title Title object for which is being edited (where we go to for &action= links)
2829 * @return string
2830 */
2831 protected function getActionURL( Title $title ) {
2832 return $title->getLocalURL( array( 'action' => $this->action ) );
2833 }
2834
2835 /**
2836 * Check if a page was deleted while the user was editing it, before submit.
2837 * Note that we rely on the logging table, which hasn't been always there,
2838 * but that doesn't matter, because this only applies to brand new
2839 * deletes.
2840 */
2841 protected function wasDeletedSinceLastEdit() {
2842 if ( $this->deletedSinceEdit !== null ) {
2843 return $this->deletedSinceEdit;
2844 }
2845
2846 $this->deletedSinceEdit = false;
2847
2848 if ( $this->mTitle->isDeletedQuick() ) {
2849 $this->lastDelete = $this->getLastDelete();
2850 if ( $this->lastDelete ) {
2851 $deleteTime = wfTimestamp( TS_MW, $this->lastDelete->log_timestamp );
2852 if ( $deleteTime > $this->starttime ) {
2853 $this->deletedSinceEdit = true;
2854 }
2855 }
2856 }
2857
2858 return $this->deletedSinceEdit;
2859 }
2860
2861 protected function getLastDelete() {
2862 $dbr = wfGetDB( DB_SLAVE );
2863 $data = $dbr->selectRow(
2864 array( 'logging', 'user' ),
2865 array( 'log_type',
2866 'log_action',
2867 'log_timestamp',
2868 'log_user',
2869 'log_namespace',
2870 'log_title',
2871 'log_comment',
2872 'log_params',
2873 'log_deleted',
2874 'user_name' ),
2875 array( 'log_namespace' => $this->mTitle->getNamespace(),
2876 'log_title' => $this->mTitle->getDBkey(),
2877 'log_type' => 'delete',
2878 'log_action' => 'delete',
2879 'user_id=log_user' ),
2880 __METHOD__,
2881 array( 'LIMIT' => 1, 'ORDER BY' => 'log_timestamp DESC' )
2882 );
2883 // Quick paranoid permission checks...
2884 if ( is_object( $data ) ) {
2885 if ( $data->log_deleted & LogPage::DELETED_USER )
2886 $data->user_name = wfMessage( 'rev-deleted-user' )->escaped();
2887 if ( $data->log_deleted & LogPage::DELETED_COMMENT )
2888 $data->log_comment = wfMessage( 'rev-deleted-comment' )->escaped();
2889 }
2890 return $data;
2891 }
2892
2893 /**
2894 * Get the rendered text for previewing.
2895 * @throws MWException
2896 * @return string
2897 */
2898 function getPreviewText() {
2899 global $wgOut, $wgUser, $wgRawHtml, $wgLang;
2900
2901 wfProfileIn( __METHOD__ );
2902
2903 if ( $wgRawHtml && !$this->mTokenOk ) {
2904 // Could be an offsite preview attempt. This is very unsafe if
2905 // HTML is enabled, as it could be an attack.
2906 $parsedNote = '';
2907 if ( $this->textbox1 !== '' ) {
2908 // Do not put big scary notice, if previewing the empty
2909 // string, which happens when you initially edit
2910 // a category page, due to automatic preview-on-open.
2911 $parsedNote = $wgOut->parse( "<div class='previewnote'>" .
2912 wfMessage( 'session_fail_preview_html' )->text() . "</div>", true, /* interface */true );
2913 }
2914 wfProfileOut( __METHOD__ );
2915 return $parsedNote;
2916 }
2917
2918 $note = '';
2919
2920 try {
2921 $content = $this->toEditContent( $this->textbox1 );
2922
2923 if ( $this->mTriedSave && !$this->mTokenOk ) {
2924 if ( $this->mTokenOkExceptSuffix ) {
2925 $note = wfMessage( 'token_suffix_mismatch' )->plain() ;
2926
2927 } else {
2928 $note = wfMessage( 'session_fail_preview' )->plain() ;
2929 }
2930 } elseif ( $this->incompleteForm ) {
2931 $note = wfMessage( 'edit_form_incomplete' )->plain() ;
2932 } else {
2933 $note = wfMessage( 'previewnote' )->plain() .
2934 ' [[#' . self::EDITFORM_ID . '|' . $wgLang->getArrow() . ' ' . wfMessage( 'continue-editing' )->text() . ']]';
2935 }
2936
2937 $parserOptions = $this->mArticle->makeParserOptions( $this->mArticle->getContext() );
2938 $parserOptions->setEditSection( false );
2939 $parserOptions->setIsPreview( true );
2940 $parserOptions->setIsSectionPreview( !is_null($this->section) && $this->section !== '' );
2941
2942 # don't parse non-wikitext pages, show message about preview
2943 if ( $this->mTitle->isCssJsSubpage() || $this->mTitle->isCssOrJsPage() ) {
2944 if( $this->mTitle->isCssJsSubpage() ) {
2945 $level = 'user';
2946 } elseif( $this->mTitle->isCssOrJsPage() ) {
2947 $level = 'site';
2948 } else {
2949 $level = false;
2950 }
2951
2952 if ( $content->getModel() == CONTENT_MODEL_CSS ) {
2953 $format = 'css';
2954 } elseif ( $content->getModel() == CONTENT_MODEL_JAVASCRIPT ) {
2955 $format = 'js';
2956 } else {
2957 $format = false;
2958 }
2959
2960 # Used messages to make sure grep find them:
2961 # Messages: usercsspreview, userjspreview, sitecsspreview, sitejspreview
2962 if( $level && $format ) {
2963 $note = "<div id='mw-{$level}{$format}preview'>" . wfMessage( "{$level}{$format}preview" )->text() . "</div>";
2964 }
2965 }
2966
2967 $rt = $content->getRedirectChain();
2968 if ( $rt ) {
2969 $previewHTML = $this->mArticle->viewRedirect( $rt, false );
2970 } else {
2971
2972 # If we're adding a comment, we need to show the
2973 # summary as the headline
2974 if ( $this->section === "new" && $this->summary !== "" ) {
2975 $content = $content->addSectionHeader( $this->summary );
2976 }
2977
2978 $hook_args = array( $this, &$content );
2979 ContentHandler::runLegacyHooks( 'EditPageGetPreviewText', $hook_args );
2980 wfRunHooks( 'EditPageGetPreviewContent', $hook_args );
2981
2982 $parserOptions->enableLimitReport();
2983
2984 # For CSS/JS pages, we should have called the ShowRawCssJs hook here.
2985 # But it's now deprecated, so never mind
2986
2987 $content = $content->preSaveTransform( $this->mTitle, $wgUser, $parserOptions );
2988 $parserOutput = $content->getParserOutput( $this->getArticle()->getTitle(), null, $parserOptions );
2989
2990 $previewHTML = $parserOutput->getText();
2991 $this->mParserOutput = $parserOutput;
2992 $wgOut->addParserOutputNoText( $parserOutput );
2993
2994 if ( count( $parserOutput->getWarnings() ) ) {
2995 $note .= "\n\n" . implode( "\n\n", $parserOutput->getWarnings() );
2996 }
2997 }
2998 } catch ( MWContentSerializationException $ex ) {
2999 $m = wfMessage('content-failed-to-parse', $this->contentModel, $this->contentFormat, $ex->getMessage() );
3000 $note .= "\n\n" . $m->parse();
3001 $previewHTML = '';
3002 }
3003
3004 if ( $this->isConflict ) {
3005 $conflict = '<h2 id="mw-previewconflict">' . wfMessage( 'previewconflict' )->escaped() . "</h2>\n";
3006 } else {
3007 $conflict = '<hr />';
3008 }
3009
3010 $previewhead = "<div class='previewnote'>\n" .
3011 '<h2 id="mw-previewheader">' . wfMessage( 'preview' )->escaped() . "</h2>" .
3012 $wgOut->parse( $note, true, /* interface */true ) . $conflict . "</div>\n";
3013
3014 $pageLang = $this->mTitle->getPageLanguage();
3015 $attribs = array( 'lang' => $pageLang->getCode(), 'dir' => $pageLang->getDir(),
3016 'class' => 'mw-content-' . $pageLang->getDir() );
3017 $previewHTML = Html::rawElement( 'div', $attribs, $previewHTML );
3018
3019 wfProfileOut( __METHOD__ );
3020 return $previewhead . $previewHTML . $this->previewTextAfterContent;
3021 }
3022
3023 /**
3024 * @return Array
3025 */
3026 function getTemplates() {
3027 if ( $this->preview || $this->section != '' ) {
3028 $templates = array();
3029 if ( !isset( $this->mParserOutput ) ) {
3030 return $templates;
3031 }
3032 foreach ( $this->mParserOutput->getTemplates() as $ns => $template ) {
3033 foreach ( array_keys( $template ) as $dbk ) {
3034 $templates[] = Title::makeTitle( $ns, $dbk );
3035 }
3036 }
3037 return $templates;
3038 } else {
3039 return $this->mTitle->getTemplateLinksFrom();
3040 }
3041 }
3042
3043 /**
3044 * Shows a bulletin board style toolbar for common editing functions.
3045 * It can be disabled in the user preferences.
3046 * The necessary JavaScript code can be found in skins/common/edit.js.
3047 *
3048 * @return string
3049 */
3050 static function getEditToolbar() {
3051 global $wgStylePath, $wgContLang, $wgLang, $wgOut;
3052 global $wgUseTeX, $wgEnableUploads, $wgForeignFileRepos;
3053
3054 $imagesAvailable = $wgEnableUploads || count( $wgForeignFileRepos );
3055
3056 /**
3057 * $toolarray is an array of arrays each of which includes the
3058 * filename of the button image (without path), the opening
3059 * tag, the closing tag, optionally a sample text that is
3060 * inserted between the two when no selection is highlighted
3061 * and. The tip text is shown when the user moves the mouse
3062 * over the button.
3063 *
3064 * Also here: accesskeys (key), which are not used yet until
3065 * someone can figure out a way to make them work in
3066 * IE. However, we should make sure these keys are not defined
3067 * on the edit page.
3068 */
3069 $toolarray = array(
3070 array(
3071 'image' => $wgLang->getImageFile( 'button-bold' ),
3072 'id' => 'mw-editbutton-bold',
3073 'open' => '\'\'\'',
3074 'close' => '\'\'\'',
3075 'sample' => wfMessage( 'bold_sample' )->text(),
3076 'tip' => wfMessage( 'bold_tip' )->text(),
3077 'key' => 'B'
3078 ),
3079 array(
3080 'image' => $wgLang->getImageFile( 'button-italic' ),
3081 'id' => 'mw-editbutton-italic',
3082 'open' => '\'\'',
3083 'close' => '\'\'',
3084 'sample' => wfMessage( 'italic_sample' )->text(),
3085 'tip' => wfMessage( 'italic_tip' )->text(),
3086 'key' => 'I'
3087 ),
3088 array(
3089 'image' => $wgLang->getImageFile( 'button-link' ),
3090 'id' => 'mw-editbutton-link',
3091 'open' => '[[',
3092 'close' => ']]',
3093 'sample' => wfMessage( 'link_sample' )->text(),
3094 'tip' => wfMessage( 'link_tip' )->text(),
3095 'key' => 'L'
3096 ),
3097 array(
3098 'image' => $wgLang->getImageFile( 'button-extlink' ),
3099 'id' => 'mw-editbutton-extlink',
3100 'open' => '[',
3101 'close' => ']',
3102 'sample' => wfMessage( 'extlink_sample' )->text(),
3103 'tip' => wfMessage( 'extlink_tip' )->text(),
3104 'key' => 'X'
3105 ),
3106 array(
3107 'image' => $wgLang->getImageFile( 'button-headline' ),
3108 'id' => 'mw-editbutton-headline',
3109 'open' => "\n== ",
3110 'close' => " ==\n",
3111 'sample' => wfMessage( 'headline_sample' )->text(),
3112 'tip' => wfMessage( 'headline_tip' )->text(),
3113 'key' => 'H'
3114 ),
3115 $imagesAvailable ? array(
3116 'image' => $wgLang->getImageFile( 'button-image' ),
3117 'id' => 'mw-editbutton-image',
3118 'open' => '[[' . $wgContLang->getNsText( NS_FILE ) . ':',
3119 'close' => ']]',
3120 'sample' => wfMessage( 'image_sample' )->text(),
3121 'tip' => wfMessage( 'image_tip' )->text(),
3122 'key' => 'D',
3123 ) : false,
3124 $imagesAvailable ? array(
3125 'image' => $wgLang->getImageFile( 'button-media' ),
3126 'id' => 'mw-editbutton-media',
3127 'open' => '[[' . $wgContLang->getNsText( NS_MEDIA ) . ':',
3128 'close' => ']]',
3129 'sample' => wfMessage( 'media_sample' )->text(),
3130 'tip' => wfMessage( 'media_tip' )->text(),
3131 'key' => 'M'
3132 ) : false,
3133 $wgUseTeX ? array(
3134 'image' => $wgLang->getImageFile( 'button-math' ),
3135 'id' => 'mw-editbutton-math',
3136 'open' => "<math>",
3137 'close' => "</math>",
3138 'sample' => wfMessage( 'math_sample' )->text(),
3139 'tip' => wfMessage( 'math_tip' )->text(),
3140 'key' => 'C'
3141 ) : false,
3142 array(
3143 'image' => $wgLang->getImageFile( 'button-nowiki' ),
3144 'id' => 'mw-editbutton-nowiki',
3145 'open' => "<nowiki>",
3146 'close' => "</nowiki>",
3147 'sample' => wfMessage( 'nowiki_sample' )->text(),
3148 'tip' => wfMessage( 'nowiki_tip' )->text(),
3149 'key' => 'N'
3150 ),
3151 array(
3152 'image' => $wgLang->getImageFile( 'button-sig' ),
3153 'id' => 'mw-editbutton-signature',
3154 'open' => '--~~~~',
3155 'close' => '',
3156 'sample' => '',
3157 'tip' => wfMessage( 'sig_tip' )->text(),
3158 'key' => 'Y'
3159 ),
3160 array(
3161 'image' => $wgLang->getImageFile( 'button-hr' ),
3162 'id' => 'mw-editbutton-hr',
3163 'open' => "\n----\n",
3164 'close' => '',
3165 'sample' => '',
3166 'tip' => wfMessage( 'hr_tip' )->text(),
3167 'key' => 'R'
3168 )
3169 );
3170
3171 $script = 'mw.loader.using("mediawiki.action.edit", function() {';
3172 foreach ( $toolarray as $tool ) {
3173 if ( !$tool ) {
3174 continue;
3175 }
3176
3177 $params = array(
3178 $image = $wgStylePath . '/common/images/' . $tool['image'],
3179 // Note that we use the tip both for the ALT tag and the TITLE tag of the image.
3180 // Older browsers show a "speedtip" type message only for ALT.
3181 // Ideally these should be different, realistically they
3182 // probably don't need to be.
3183 $tip = $tool['tip'],
3184 $open = $tool['open'],
3185 $close = $tool['close'],
3186 $sample = $tool['sample'],
3187 $cssId = $tool['id'],
3188 );
3189
3190 $script .= Xml::encodeJsCall( 'mw.toolbar.addButton', $params );
3191 }
3192
3193 // This used to be called on DOMReady from mediawiki.action.edit, which
3194 // ended up causing race conditions with the setup code above.
3195 $script .= "\n" .
3196 "// Create button bar\n" .
3197 "$(function() { mw.toolbar.init(); } );\n";
3198
3199 $script .= '});';
3200 $wgOut->addScript( Html::inlineScript( ResourceLoader::makeLoaderConditionalScript( $script ) ) );
3201
3202 $toolbar = '<div id="toolbar"></div>';
3203
3204 wfRunHooks( 'EditPageBeforeEditToolbar', array( &$toolbar ) );
3205
3206 return $toolbar;
3207 }
3208
3209 /**
3210 * Returns an array of html code of the following checkboxes:
3211 * minor and watch
3212 *
3213 * @param $tabindex int Current tabindex
3214 * @param $checked Array of checkbox => bool, where bool indicates the checked
3215 * status of the checkbox
3216 *
3217 * @return array
3218 */
3219 public function getCheckboxes( &$tabindex, $checked ) {
3220 global $wgUser;
3221
3222 $checkboxes = array();
3223
3224 // don't show the minor edit checkbox if it's a new page or section
3225 if ( !$this->isNew ) {
3226 $checkboxes['minor'] = '';
3227 $minorLabel = wfMessage( 'minoredit' )->parse();
3228 if ( $wgUser->isAllowed( 'minoredit' ) ) {
3229 $attribs = array(
3230 'tabindex' => ++$tabindex,
3231 'accesskey' => wfMessage( 'accesskey-minoredit' )->text(),
3232 'id' => 'wpMinoredit',
3233 );
3234 $checkboxes['minor'] =
3235 Xml::check( 'wpMinoredit', $checked['minor'], $attribs ) .
3236 "&#160;<label for='wpMinoredit' id='mw-editpage-minoredit'" .
3237 Xml::expandAttributes( array( 'title' => Linker::titleAttrib( 'minoredit', 'withaccess' ) ) ) .
3238 ">{$minorLabel}</label>";
3239 }
3240 }
3241
3242 $watchLabel = wfMessage( 'watchthis' )->parse();
3243 $checkboxes['watch'] = '';
3244 if ( $wgUser->isLoggedIn() ) {
3245 $attribs = array(
3246 'tabindex' => ++$tabindex,
3247 'accesskey' => wfMessage( 'accesskey-watch' )->text(),
3248 'id' => 'wpWatchthis',
3249 );
3250 $checkboxes['watch'] =
3251 Xml::check( 'wpWatchthis', $checked['watch'], $attribs ) .
3252 "&#160;<label for='wpWatchthis' id='mw-editpage-watch'" .
3253 Xml::expandAttributes( array( 'title' => Linker::titleAttrib( 'watch', 'withaccess' ) ) ) .
3254 ">{$watchLabel}</label>";
3255 }
3256 wfRunHooks( 'EditPageBeforeEditChecks', array( &$this, &$checkboxes, &$tabindex ) );
3257 return $checkboxes;
3258 }
3259
3260 /**
3261 * Returns an array of html code of the following buttons:
3262 * save, diff, preview and live
3263 *
3264 * @param $tabindex int Current tabindex
3265 *
3266 * @return array
3267 */
3268 public function getEditButtons( &$tabindex ) {
3269 $buttons = array();
3270
3271 $temp = array(
3272 'id' => 'wpSave',
3273 'name' => 'wpSave',
3274 'type' => 'submit',
3275 'tabindex' => ++$tabindex,
3276 'value' => wfMessage( 'savearticle' )->text(),
3277 'accesskey' => wfMessage( 'accesskey-save' )->text(),
3278 'title' => wfMessage( 'tooltip-save' )->text() . ' [' . wfMessage( 'accesskey-save' )->text() . ']',
3279 );
3280 $buttons['save'] = Xml::element( 'input', $temp, '' );
3281
3282 ++$tabindex; // use the same for preview and live preview
3283 $temp = array(
3284 'id' => 'wpPreview',
3285 'name' => 'wpPreview',
3286 'type' => 'submit',
3287 'tabindex' => $tabindex,
3288 'value' => wfMessage( 'showpreview' )->text(),
3289 'accesskey' => wfMessage( 'accesskey-preview' )->text(),
3290 'title' => wfMessage( 'tooltip-preview' )->text() . ' [' . wfMessage( 'accesskey-preview' )->text() . ']',
3291 );
3292 $buttons['preview'] = Xml::element( 'input', $temp, '' );
3293 $buttons['live'] = '';
3294
3295 $temp = array(
3296 'id' => 'wpDiff',
3297 'name' => 'wpDiff',
3298 'type' => 'submit',
3299 'tabindex' => ++$tabindex,
3300 'value' => wfMessage( 'showdiff' )->text(),
3301 'accesskey' => wfMessage( 'accesskey-diff' )->text(),
3302 'title' => wfMessage( 'tooltip-diff' )->text() . ' [' . wfMessage( 'accesskey-diff' )->text() . ']',
3303 );
3304 $buttons['diff'] = Xml::element( 'input', $temp, '' );
3305
3306 wfRunHooks( 'EditPageBeforeEditButtons', array( &$this, &$buttons, &$tabindex ) );
3307 return $buttons;
3308 }
3309
3310 /**
3311 * Output preview text only. This can be sucked into the edit page
3312 * via JavaScript, and saves the server time rendering the skin as
3313 * well as theoretically being more robust on the client (doesn't
3314 * disturb the edit box's undo history, won't eat your text on
3315 * failure, etc).
3316 *
3317 * @todo This doesn't include category or interlanguage links.
3318 * Would need to enhance it a bit, "<s>maybe wrap them in XML
3319 * or something...</s>" that might also require more skin
3320 * initialization, so check whether that's a problem.
3321 */
3322 function livePreview() {
3323 global $wgOut;
3324 $wgOut->disable();
3325 header( 'Content-type: text/xml; charset=utf-8' );
3326 header( 'Cache-control: no-cache' );
3327
3328 $previewText = $this->getPreviewText();
3329 #$categories = $skin->getCategoryLinks();
3330
3331 $s =
3332 '<?xml version="1.0" encoding="UTF-8" ?>' . "\n" .
3333 Xml::tags( 'livepreview', null,
3334 Xml::element( 'preview', null, $previewText )
3335 #. Xml::element( 'category', null, $categories )
3336 );
3337 echo $s;
3338 }
3339
3340 /**
3341 * Call the stock "user is blocked" page
3342 *
3343 * @deprecated in 1.19; throw an exception directly instead
3344 */
3345 function blockedPage() {
3346 wfDeprecated( __METHOD__, '1.19' );
3347 global $wgUser;
3348
3349 throw new UserBlockedError( $wgUser->getBlock() );
3350 }
3351
3352 /**
3353 * Produce the stock "please login to edit pages" page
3354 *
3355 * @deprecated in 1.19; throw an exception directly instead
3356 */
3357 function userNotLoggedInPage() {
3358 wfDeprecated( __METHOD__, '1.19' );
3359 throw new PermissionsError( 'edit' );
3360 }
3361
3362 /**
3363 * Show an error page saying to the user that he has insufficient permissions
3364 * to create a new page
3365 *
3366 * @deprecated in 1.19; throw an exception directly instead
3367 */
3368 function noCreatePermission() {
3369 wfDeprecated( __METHOD__, '1.19' );
3370 $permission = $this->mTitle->isTalkPage() ? 'createtalk' : 'createpage';
3371 throw new PermissionsError( $permission );
3372 }
3373
3374 /**
3375 * Creates a basic error page which informs the user that
3376 * they have attempted to edit a nonexistent section.
3377 */
3378 function noSuchSectionPage() {
3379 global $wgOut;
3380
3381 $wgOut->prepareErrorPage( wfMessage( 'nosuchsectiontitle' ) );
3382
3383 $res = wfMessage( 'nosuchsectiontext', $this->section )->parseAsBlock();
3384 wfRunHooks( 'EditPageNoSuchSection', array( &$this, &$res ) );
3385 $wgOut->addHTML( $res );
3386
3387 $wgOut->returnToMain( false, $this->mTitle );
3388 }
3389
3390 /**
3391 * Produce the stock "your edit contains spam" page
3392 *
3393 * @param $match string|bool Text which triggered one or more filters
3394 * @deprecated since 1.17 Use method spamPageWithContent() instead
3395 */
3396 static function spamPage( $match = false ) {
3397 wfDeprecated( __METHOD__, '1.17' );
3398
3399 global $wgOut, $wgTitle;
3400
3401 $wgOut->prepareErrorPage( wfMessage( 'spamprotectiontitle' ) );
3402
3403 $wgOut->addHTML( '<div id="spamprotected">' );
3404 $wgOut->addWikiMsg( 'spamprotectiontext' );
3405 if ( $match ) {
3406 $wgOut->addWikiMsg( 'spamprotectionmatch', wfEscapeWikiText( $match ) );
3407 }
3408 $wgOut->addHTML( '</div>' );
3409
3410 $wgOut->returnToMain( false, $wgTitle );
3411 }
3412
3413 /**
3414 * Show "your edit contains spam" page with your diff and text
3415 *
3416 * @param $match string|Array|bool Text (or array of texts) which triggered one or more filters
3417 */
3418 public function spamPageWithContent( $match = false ) {
3419 global $wgOut, $wgLang;
3420 $this->textbox2 = $this->textbox1;
3421
3422 if( is_array( $match ) ){
3423 $match = $wgLang->listToText( $match );
3424 }
3425 $wgOut->prepareErrorPage( wfMessage( 'spamprotectiontitle' ) );
3426
3427 $wgOut->addHTML( '<div id="spamprotected">' );
3428 $wgOut->addWikiMsg( 'spamprotectiontext' );
3429 if ( $match ) {
3430 $wgOut->addWikiMsg( 'spamprotectionmatch', wfEscapeWikiText( $match ) );
3431 }
3432 $wgOut->addHTML( '</div>' );
3433
3434 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
3435 $this->showDiff();
3436
3437 $wgOut->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
3438 $this->showTextbox2();
3439
3440 $wgOut->addReturnTo( $this->getContextTitle(), array( 'action' => 'edit' ) );
3441 }
3442
3443 /**
3444 * Format an anchor fragment as it would appear for a given section name
3445 * @param $text String
3446 * @return String
3447 * @private
3448 */
3449 function sectionAnchor( $text ) {
3450 global $wgParser;
3451 return $wgParser->guessSectionNameFromWikiText( $text );
3452 }
3453
3454 /**
3455 * Check if the browser is on a blacklist of user-agents known to
3456 * mangle UTF-8 data on form submission. Returns true if Unicode
3457 * should make it through, false if it's known to be a problem.
3458 * @return bool
3459 * @private
3460 */
3461 function checkUnicodeCompliantBrowser() {
3462 global $wgBrowserBlackList, $wgRequest;
3463
3464 $currentbrowser = $wgRequest->getHeader( 'User-Agent' );
3465 if ( $currentbrowser === false ) {
3466 // No User-Agent header sent? Trust it by default...
3467 return true;
3468 }
3469
3470 foreach ( $wgBrowserBlackList as $browser ) {
3471 if ( preg_match( $browser, $currentbrowser ) ) {
3472 return false;
3473 }
3474 }
3475 return true;
3476 }
3477
3478 /**
3479 * Filter an input field through a Unicode de-armoring process if it
3480 * came from an old browser with known broken Unicode editing issues.
3481 *
3482 * @param $request WebRequest
3483 * @param $field String
3484 * @return String
3485 * @private
3486 */
3487 function safeUnicodeInput( $request, $field ) {
3488 $text = rtrim( $request->getText( $field ) );
3489 return $request->getBool( 'safemode' )
3490 ? $this->unmakesafe( $text )
3491 : $text;
3492 }
3493
3494 /**
3495 * @param $request WebRequest
3496 * @param $text string
3497 * @return string
3498 */
3499 function safeUnicodeText( $request, $text ) {
3500 $text = rtrim( $text );
3501 return $request->getBool( 'safemode' )
3502 ? $this->unmakesafe( $text )
3503 : $text;
3504 }
3505
3506 /**
3507 * Filter an output field through a Unicode armoring process if it is
3508 * going to an old browser with known broken Unicode editing issues.
3509 *
3510 * @param $text String
3511 * @return String
3512 * @private
3513 */
3514 function safeUnicodeOutput( $text ) {
3515 global $wgContLang;
3516 $codedText = $wgContLang->recodeForEdit( $text );
3517 return $this->checkUnicodeCompliantBrowser()
3518 ? $codedText
3519 : $this->makesafe( $codedText );
3520 }
3521
3522 /**
3523 * A number of web browsers are known to corrupt non-ASCII characters
3524 * in a UTF-8 text editing environment. To protect against this,
3525 * detected browsers will be served an armored version of the text,
3526 * with non-ASCII chars converted to numeric HTML character references.
3527 *
3528 * Preexisting such character references will have a 0 added to them
3529 * to ensure that round-trips do not alter the original data.
3530 *
3531 * @param $invalue String
3532 * @return String
3533 * @private
3534 */
3535 function makesafe( $invalue ) {
3536 // Armor existing references for reversability.
3537 $invalue = strtr( $invalue, array( "&#x" => "&#x0" ) );
3538
3539 $bytesleft = 0;
3540 $result = "";
3541 $working = 0;
3542 for ( $i = 0; $i < strlen( $invalue ); $i++ ) {
3543 $bytevalue = ord( $invalue[$i] );
3544 if ( $bytevalue <= 0x7F ) { // 0xxx xxxx
3545 $result .= chr( $bytevalue );
3546 $bytesleft = 0;
3547 } elseif ( $bytevalue <= 0xBF ) { // 10xx xxxx
3548 $working = $working << 6;
3549 $working += ( $bytevalue & 0x3F );
3550 $bytesleft--;
3551 if ( $bytesleft <= 0 ) {
3552 $result .= "&#x" . strtoupper( dechex( $working ) ) . ";";
3553 }
3554 } elseif ( $bytevalue <= 0xDF ) { // 110x xxxx
3555 $working = $bytevalue & 0x1F;
3556 $bytesleft = 1;
3557 } elseif ( $bytevalue <= 0xEF ) { // 1110 xxxx
3558 $working = $bytevalue & 0x0F;
3559 $bytesleft = 2;
3560 } else { // 1111 0xxx
3561 $working = $bytevalue & 0x07;
3562 $bytesleft = 3;
3563 }
3564 }
3565 return $result;
3566 }
3567
3568 /**
3569 * Reverse the previously applied transliteration of non-ASCII characters
3570 * back to UTF-8. Used to protect data from corruption by broken web browsers
3571 * as listed in $wgBrowserBlackList.
3572 *
3573 * @param $invalue String
3574 * @return String
3575 * @private
3576 */
3577 function unmakesafe( $invalue ) {
3578 $result = "";
3579 for ( $i = 0; $i < strlen( $invalue ); $i++ ) {
3580 if ( ( substr( $invalue, $i, 3 ) == "&#x" ) && ( $invalue[$i + 3] != '0' ) ) {
3581 $i += 3;
3582 $hexstring = "";
3583 do {
3584 $hexstring .= $invalue[$i];
3585 $i++;
3586 } while ( ctype_xdigit( $invalue[$i] ) && ( $i < strlen( $invalue ) ) );
3587
3588 // Do some sanity checks. These aren't needed for reversability,
3589 // but should help keep the breakage down if the editor
3590 // breaks one of the entities whilst editing.
3591 if ( ( substr( $invalue, $i, 1 ) == ";" ) and ( strlen( $hexstring ) <= 6 ) ) {
3592 $codepoint = hexdec( $hexstring );
3593 $result .= codepointToUtf8( $codepoint );
3594 } else {
3595 $result .= "&#x" . $hexstring . substr( $invalue, $i, 1 );
3596 }
3597 } else {
3598 $result .= substr( $invalue, $i, 1 );
3599 }
3600 }
3601 // reverse the transform that we made for reversability reasons.
3602 return strtr( $result, array( "&#x0" => "&#x" ) );
3603 }
3604 }