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