'MediaWiki\\Auth\\UsernameAuthenticationRequest' => __DIR__ . '/includes/auth/UsernameAuthenticationRequest.php',
'MediaWiki\\Diff\\ComplexityException' => __DIR__ . '/includes/diff/ComplexityException.php',
'MediaWiki\\Diff\\WordAccumulator' => __DIR__ . '/includes/diff/WordAccumulator.php',
+ 'MediaWiki\\EditPage\\TextConflictHelper' => __DIR__ . '/includes/editpage/TextConflictHelper.php',
+ 'MediaWiki\\EditPage\\TextboxBuilder' => __DIR__ . '/includes/editpage/TextboxBuilder.php',
'MediaWiki\\Edit\\PreparedEdit' => __DIR__ . '/includes/edit/PreparedEdit.php',
'MediaWiki\\HeaderCallback' => __DIR__ . '/includes/HeaderCallback.php',
'MediaWiki\\Interwiki\\ClassicInterwikiLookup' => __DIR__ . '/includes/interwiki/ClassicInterwikiLookup.php',
* @file
*/
+use MediaWiki\EditPage\TextboxBuilder;
+use MediaWiki\EditPage\TextConflictHelper;
use MediaWiki\Logger\LoggerFactory;
use MediaWiki\MediaWikiServices;
use Wikimedia\ScopedCallback;
*/
private $unicodeCheck;
+ /**
+ * Factory function to create an edit conflict helper
+ *
+ * @var callable
+ */
+ private $editConflictHelperFactory;
+
+ /**
+ * @var TextConflictHelper|null
+ */
+ private $editConflictHelper;
+
/**
* @param Article $article
*/
$handler = ContentHandler::getForModelID( $this->contentModel );
$this->contentFormat = $handler->getDefaultFormat();
+ $this->editConflictHelperFactory = [ $this, 'newTextConflictHelper' ];
}
/**
return;
}
- $stats = MediaWikiServices::getInstance()->getStatsdDataFactory();
- $stats->increment( 'edit.failures.conflict.resolved' );
+ $this->getEditConflictHelper()->incrementResolvedStats();
}
/**
}
$out->addHTML( $this->editFormTextBeforeContent );
+ if ( $this->isConflict ) {
+ // In an edit conflict, we turn textbox2 into the user's text,
+ // and textbox1 into the stored version
+ $this->textbox2 = $this->textbox1;
+
+ $content = $this->getCurrentContent();
+ $this->textbox1 = $this->toEditText( $content );
+
+ $editConflictHelper = $this->getEditConflictHelper();
+ $editConflictHelper->setTextboxes( $this->textbox2, $this->textbox1 );
+ $editConflictHelper->setContentModel( $this->contentModel );
+ $editConflictHelper->setContentFormat( $this->contentFormat );
+ $out->addHTML( $editConflictHelper->getEditFormHtmlBeforeContent() );
+ }
if ( !$this->mTitle->isCssJsSubpage() && $showToolbar && $user->getOption( 'showtoolbar' ) ) {
$out->addHTML( self::getEditToolbar( $this->mTitle ) );
// and fallback to the raw wpTextbox1 since editconflicts can't be
// resolved between page source edits and custom ui edits using the
// custom edit ui.
- $this->textbox2 = $this->textbox1;
-
- $content = $this->getCurrentContent();
- $this->textbox1 = $this->toEditText( $content );
-
$this->showTextbox1();
+ $out->addHTML( $editConflictHelper->getEditFormHtmlAfterContent() );
} else {
$this->showContentForm();
}
}
protected function showTextbox( $text, $name, $customAttribs = [] ) {
- $wikitext = $this->addNewLineAtEnd( $text );
-
- $attribs = $this->buildTextboxAttribs( $name, $customAttribs, $this->context->getUser() );
+ $builder = new TextboxBuilder();
+ $attribs = $builder->buildTextboxAttribs(
+ $name,
+ $customAttribs,
+ $this->context->getUser(),
+ $this->mTitle
+ );
- $this->context->getOutput()->addHTML( Html::textarea( $name, $wikitext, $attribs ) );
+ $this->context->getOutput()->addHTML(
+ Html::textarea( $name, $builder->addNewLineAtEnd( $text ), $attribs )
+ );
}
protected function displayPreviewArea( $previewOutput, $isOnTop = false ) {
if ( Hooks::run( 'EditPageBeforeConflictDiff', [ &$editPage, &$out ] ) ) {
$this->incrementConflictStats();
- $out->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
-
- $content1 = $this->toEditContent( $this->textbox1 );
- $content2 = $this->toEditContent( $this->textbox2 );
-
- $handler = ContentHandler::getForModelID( $this->contentModel );
- $de = $handler->createDifferenceEngine( $this->context );
- $de->setContent( $content2, $content1 );
- $de->showDiff(
- $this->context->msg( 'yourtext' )->parse(),
- $this->context->msg( 'storedversion' )->text()
- );
-
- $out->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
- $this->showTextbox2();
+ $this->getEditConflictHelper()->showEditFormTextAfterFooters();
}
}
protected function incrementConflictStats() {
- $stats = MediaWikiServices::getInstance()->getStatsdDataFactory();
- $stats->increment( 'edit.failures.conflict' );
- // Only include 'standard' namespaces to avoid creating unknown numbers of statsd metrics
- if (
- $this->mTitle->getNamespace() >= NS_MAIN &&
- $this->mTitle->getNamespace() <= NS_CATEGORY_TALK
- ) {
- $stats->increment( 'edit.failures.conflict.byNamespaceId.' . $this->mTitle->getNamespace() );
- }
+ $this->getEditConflictHelper()->incrementConflictStats();
}
/**
* @since 1.29
*/
protected function addExplainConflictHeader( OutputPage $out ) {
- $out->wrapWikiMsg(
- "<div class='mw-explainconflict'>\n$1\n</div>",
- [ 'explainconflict', $this->context->msg( $this->getSubmitButtonLabel() )->text() ]
+ $out->addHTML(
+ $this->getEditConflictHelper()->getExplainHeader()
);
}
* @since 1.29
*/
protected function buildTextboxAttribs( $name, array $customAttribs, User $user ) {
- $attribs = $customAttribs + [
- 'accesskey' => ',',
- 'id' => $name,
- 'cols' => 80,
- 'rows' => 25,
- // Avoid PHP notices when appending preferences
- // (appending allows customAttribs['style'] to still work).
- 'style' => ''
- ];
-
- // The following classes can be used here:
- // * mw-editfont-monospace
- // * mw-editfont-sans-serif
- // * mw-editfont-serif
- $class = 'mw-editfont-' . $user->getOption( 'editfont' );
-
- if ( isset( $attribs['class'] ) ) {
- if ( is_string( $attribs['class'] ) ) {
- $attribs['class'] .= ' ' . $class;
- } elseif ( is_array( $attribs['class'] ) ) {
- $attribs['class'][] = $class;
- }
- } else {
- $attribs['class'] = $class;
- }
-
- $pageLang = $this->mTitle->getPageLanguage();
- $attribs['lang'] = $pageLang->getHtmlCode();
- $attribs['dir'] = $pageLang->getDir();
-
- return $attribs;
+ return ( new TextboxBuilder() )->buildTextboxAttribs(
+ $name, $customAttribs, $user, $this->mTitle
+ );
}
/**
* @since 1.29
*/
protected function addNewLineAtEnd( $wikitext ) {
- if ( strval( $wikitext ) !== '' ) {
- // Ensure there's a newline at the end, otherwise adding lines
- // is awkward.
- // But don't add a newline if the text is empty, or Firefox in XHTML
- // mode will show an extra newline. A bit annoying.
- $wikitext .= "\n";
- return $wikitext;
- }
- return $wikitext;
+ return ( new TextboxBuilder() )->addNewLineAtEnd( $wikitext );
}
/**
// Meanwhile, real browsers get real anchors
return $wgParser->guessSectionNameFromWikiText( $text );
}
+
+ /**
+ * Set a factory function to create an EditConflictHelper
+ *
+ * @param callable $factory Factory function
+ * @since 1.31
+ */
+ public function setEditConflictHelperFactory( callable $factory ) {
+ $this->editConflictHelperFactory = $factory;
+ $this->editConflictHelper = null;
+ }
+
+ /**
+ * @return TextConflictHelper
+ */
+ private function getEditConflictHelper() {
+ if ( !$this->editConflictHelper ) {
+ $this->editConflictHelper = call_user_func(
+ $this->editConflictHelperFactory,
+ $this->getSubmitButtonLabel()
+ );
+ }
+
+ return $this->editConflictHelper;
+ }
+
+ /**
+ * @param string $submitButtonLabel
+ * @return TextConflictHelper
+ */
+ private function newTextConflictHelper( $submitButtonLabel ) {
+ return new TextConflictHelper(
+ $this->getTitle(),
+ $this->getContext()->getOutput(),
+ MediaWikiServices::getInstance()->getStatsdDataFactory(),
+ $submitButtonLabel
+ );
+ }
}
--- /dev/null
+<?php
+/**
+ * Helper for displaying edit conflicts to users
+ *
+ * Copyright (C) 2017 Kunal Mehta <legoktm@member.fsf.org>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
+
+namespace MediaWiki\EditPage;
+
+use Content;
+use ContentHandler;
+use Html;
+use IBufferingStatsdDataFactory;
+use OutputPage;
+use Title;
+
+/**
+ * Helper for displaying edit conflicts in text content
+ * models to users
+ *
+ * @since 1.31
+ */
+class TextConflictHelper {
+
+ /**
+ * @var Title
+ */
+ protected $title;
+
+ /**
+ * @var null|string
+ */
+ public $contentModel = null;
+
+ /**
+ * @var null|string
+ */
+ public $contentFormat = null;
+
+ /**
+ * @var OutputPage
+ */
+ protected $out;
+
+ /**
+ * @var IBufferingStatsdDataFactory
+ */
+ protected $stats;
+
+ /**
+ * @var string Message key for submit button's label
+ */
+ protected $submitLabel;
+
+ /**
+ * @var string
+ */
+ protected $yourtext = '';
+
+ /**
+ * @var string
+ */
+ protected $storedversion = '';
+
+ /**
+ * @param Title $title
+ * @param OutputPage $out
+ * @param IBufferingStatsdDataFactory $stats
+ * @param string $submitLabel
+ */
+ public function __construct( Title $title, OutputPage $out, IBufferingStatsdDataFactory $stats,
+ $submitLabel
+ ) {
+ $this->title = $title;
+ $this->out = $out;
+ $this->stats = $stats;
+ $this->submitLabel = $submitLabel;
+ $this->contentModel = $title->getContentModel();
+ $this->contentFormat = ContentHandler::getForModelID( $this->contentModel )->getDefaultFormat();
+ }
+
+ /**
+ * @param string $yourtext
+ * @param string $storedversion
+ */
+ public function setTextboxes( $yourtext, $storedversion ) {
+ $this->yourtext = $yourtext;
+ $this->storedversion = $storedversion;
+ }
+
+ /**
+ * @param string $contentModel
+ */
+ public function setContentModel( $contentModel ) {
+ $this->contentModel = $contentModel;
+ }
+
+ /**
+ * @param string $contentFormat
+ */
+ public function setContentFormat( $contentFormat ) {
+ $this->contentFormat = $contentFormat;
+ }
+
+ /**
+ * Record a user encountering an edit conflict
+ */
+ public function incrementConflictStats() {
+ $this->stats->increment( 'edit.failures.conflict' );
+ // Only include 'standard' namespaces to avoid creating unknown numbers of statsd metrics
+ if (
+ $this->title->getNamespace() >= NS_MAIN &&
+ $this->title->getNamespace() <= NS_CATEGORY_TALK
+ ) {
+ $this->stats->increment(
+ 'edit.failures.conflict.byNamespaceId.' . $this->title->getNamespace()
+ );
+ }
+ }
+
+ /**
+ * Record when a user has resolved an edit conflict
+ */
+ public function incrementResolvedStats() {
+ $this->stats->increment( 'edit.failures.conflict.resolved' );
+ }
+
+ /**
+ * @return string HTML
+ */
+ public function getExplainHeader() {
+ return Html::rawElement(
+ 'div',
+ [ 'class' => 'mw-explainconflict' ],
+ $this->out->msg( 'explainconflict', $this->out->msg( $this->submitLabel )->text() )->parse()
+ );
+ }
+
+ /**
+ * Content to go in the edit form before textbox1
+ *
+ * @see EditPage::$editFormTextBeforeContent
+ * @return string HTML
+ */
+ public function getEditFormHtmlBeforeContent() {
+ return '';
+ }
+
+ /**
+ * Content to go in the edit form after textbox1
+ *
+ * @see EditPage::$editFormTextAfterContent
+ * @return string HTML
+ */
+ public function getEditFormHtmlAfterContent() {
+ return '';
+ }
+
+ /**
+ * Content to go in the edit form after the footers
+ * (templates on this page, hidden categories, limit report)
+ */
+ public function showEditFormTextAfterFooters() {
+ $this->out->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
+
+ $yourContent = $this->toEditContent( $this->yourtext );
+ $storedContent = $this->toEditContent( $this->storedversion );
+ $handler = ContentHandler::getForModelID( $this->contentModel );
+ $diffEngine = $handler->createDifferenceEngine( $this->out );
+
+ $diffEngine->setContent( $yourContent, $storedContent );
+ $diffEngine->showDiff(
+ $this->out->msg( 'yourtext' )->parse(),
+ $this->out->msg( 'storedversion' )->text()
+ );
+
+ $this->out->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
+
+ $builder = new TextboxBuilder();
+ $attribs = $builder->buildTextboxAttribs(
+ 'wpTextbox2',
+ [ 'tabindex' => 6, 'readonly' ],
+ $this->out->getUser(),
+ $this->title
+ );
+
+ $this->out->addHTML(
+ Html::textarea( 'wpTextbox2', $builder->addNewLineAtEnd( $this->yourtext ), $attribs )
+ );
+ }
+
+ /**
+ * @param string $text
+ * @return Content
+ */
+ public function toEditContent( $text ) {
+ return ContentHandler::makeContent(
+ $text,
+ $this->title,
+ $this->contentModel,
+ $this->contentFormat
+ );
+ }
+}
--- /dev/null
+<?php
+/**
+ * Helps EditPage build textboxes
+ *
+ * (C) Copyright 2017 Kunal Mehta <legoktm@member.fsf.org>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
+
+namespace MediaWiki\EditPage;
+
+use Title;
+use User;
+
+/**
+ * Helps EditPage build textboxes
+ *
+ * @since 1.31
+ */
+class TextboxBuilder {
+
+ /**
+ * @param string $wikitext
+ * @return string
+ */
+ public function addNewLineAtEnd( $wikitext ) {
+ if ( strval( $wikitext ) !== '' ) {
+ // Ensure there's a newline at the end, otherwise adding lines
+ // is awkward.
+ // But don't add a newline if the text is empty, or Firefox in XHTML
+ // mode will show an extra newline. A bit annoying.
+ $wikitext .= "\n";
+ return $wikitext;
+ }
+ return $wikitext;
+ }
+
+ /**
+ * @param string $name
+ * @param mixed[] $customAttribs
+ * @param User $user
+ * @param Title $title
+ * @return mixed[]
+ */
+ public function buildTextboxAttribs( $name, array $customAttribs, User $user, Title $title ) {
+ $attribs = $customAttribs + [
+ 'accesskey' => ',',
+ 'id' => $name,
+ 'cols' => 80,
+ 'rows' => 25,
+ // Avoid PHP notices when appending preferences
+ // (appending allows customAttribs['style'] to still work).
+ 'style' => ''
+ ];
+
+ // The following classes can be used here:
+ // * mw-editfont-monospace
+ // * mw-editfont-sans-serif
+ // * mw-editfont-serif
+ $class = 'mw-editfont-' . $user->getOption( 'editfont' );
+
+ if ( isset( $attribs['class'] ) ) {
+ if ( is_string( $attribs['class'] ) ) {
+ $attribs['class'] .= ' ' . $class;
+ } elseif ( is_array( $attribs['class'] ) ) {
+ $attribs['class'][] = $class;
+ }
+ } else {
+ $attribs['class'] = $class;
+ }
+
+ $pageLang = $title->getPageLanguage();
+ $attribs['lang'] = $pageLang->getHtmlCode();
+ $attribs['dir'] = $pageLang->getDir();
+
+ return $attribs;
+ }
+
+}