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