1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354
|
<?php
/**
* 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 MediaWiki\Content\Content;
use MediaWiki\Content\ContentHandler;
use MediaWiki\Content\IContentHandlerFactory;
use MediaWiki\Html\Html;
use MediaWiki\Output\OutputPage;
use MediaWiki\Title\Title;
use MediaWiki\User\User;
use MWUnknownContentModelException;
use Wikimedia\Stats\IBufferingStatsdDataFactory;
use Wikimedia\Stats\StatsFactory;
/**
* Helper for displaying edit conflicts in text content models to users
*
* @since 1.31
* @author Kunal Mehta <legoktm@debian.org>
*/
class TextConflictHelper {
/**
* @var Title
*/
protected $title;
/**
* @var null|string
*/
public $contentModel;
/**
* @var null|string
*/
public $contentFormat;
/**
* @var OutputPage
*/
protected $out;
/**
* @var IBufferingStatsdDataFactory|StatsFactory
*/
protected $stats;
/**
* @var string Message key for submit button's label
*/
protected $submitLabel;
/**
* @var string
*/
protected $yourtext = '';
/**
* @var string
*/
protected $storedversion = '';
/**
* @var IContentHandlerFactory
*/
private $contentHandlerFactory;
/**
* @param Title $title
* @param OutputPage $out
* @param IBufferingStatsdDataFactory|StatsFactory $stats
* @param string $submitLabel
* @param IContentHandlerFactory $contentHandlerFactory Required param with legacy support
*
* @throws MWUnknownContentModelException
*/
public function __construct(
Title $title, OutputPage $out, $stats, $submitLabel,
IContentHandlerFactory $contentHandlerFactory
) {
$this->title = $title;
$this->out = $out;
$this->stats = $stats;
$this->submitLabel = $submitLabel;
$this->contentModel = $title->getContentModel();
$this->contentHandlerFactory = $contentHandlerFactory;
$this->contentFormat = $this->contentHandlerFactory
->getContentHandler( $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
* @param User|null $user
*/
public function incrementConflictStats( ?User $user = null ) {
$namespace = 'n/a';
$userBucket = 'n/a';
$statsdMetrics = [ '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
) {
// getNsText() returns empty string if getNamespace() === NS_MAIN
$namespace = $this->title->getNsText() ?: 'Main';
$statsdMetrics[] = 'edit.failures.conflict.byNamespaceId.' . $this->title->getNamespace();
}
if ( $user ) {
$userBucket = $this->getUserBucket( $user->getEditCount() );
$statsdMetrics[] = 'edit.failures.conflict.byUserEdits.' . $userBucket;
}
if ( $this->stats instanceof StatsFactory ) {
$this->stats->getCounter( 'edit_failure_total' )
->setLabel( 'cause', 'conflict' )
->setLabel( 'namespace', $namespace )
->setLabel( 'user_bucket', $userBucket )
->copyToStatsdAt( $statsdMetrics )
->increment();
}
if ( $this->stats instanceof IBufferingStatsdDataFactory ) {
foreach ( $statsdMetrics as $metric ) {
$this->stats->increment( $metric );
}
}
}
/**
* Record when a user has resolved an edit conflict
* @param User|null $user
*/
public function incrementResolvedStats( ?User $user = null ) {
$namespace = 'n/a';
$userBucket = 'n/a';
$statsdMetrics = [ 'edit.failures.conflict.resolved' ];
// Only include 'standard' namespaces to avoid creating unknown numbers of statsd metrics
if (
$this->title->getNamespace() >= NS_MAIN &&
$this->title->getNamespace() <= NS_CATEGORY_TALK
) {
// getNsText() returns empty string if getNamespace() === NS_MAIN
$namespace = $this->title->getNsText() ?: 'Main';
$statsdMetrics[] = 'edit.failures.conflict.resolved.byNamespaceId.' . $this->title->getNamespace();
}
if ( $user ) {
$userBucket = $this->getUserBucket( $user->getEditCount() );
$statsdMetrics[] = 'edit.failures.conflict.resolved.byUserEdits.' . $userBucket;
}
if ( $this->stats instanceof StatsFactory ) {
$this->stats->getCounter( 'edit_failure_resolved_total' )
->setLabel( 'cause', 'conflict' )
->setLabel( 'namespace', $namespace )
->setLabel( 'user_bucket', $userBucket )
->copyToStatsdAt( $statsdMetrics )
->increment();
}
if ( $this->stats instanceof IBufferingStatsdDataFactory ) {
foreach ( $statsdMetrics as $metric ) {
$this->stats->increment( $metric );
}
}
}
/**
* Retained temporarily for backwards-compatibility.
*
* This action should be moved into incrementConflictStats, incrementResolvedStats.
*
* @deprecated since 1.42, do not use
* @param int|null $userEdits
* @param string $keyPrefixBase
*/
protected function incrementStatsByUserEdits( $userEdits, $keyPrefixBase ) {
if ( $this->stats instanceof IBufferingStatsdDataFactory ) {
$this->stats->increment( $keyPrefixBase . '.byUserEdits.' . $this->getUserBucket( $userEdits ) );
}
}
/**
* @param int|null $userEdits
* @return string
*/
protected function getUserBucket( ?int $userEdits ): string {
if ( $userEdits === null ) {
return 'anon';
} elseif ( $userEdits > 200 ) {
return 'over200';
} elseif ( $userEdits > 100 ) {
return 'over100';
} elseif ( $userEdits > 10 ) {
return 'over10';
} else {
return 'under11';
}
}
/**
* @return string HTML
*/
public function getExplainHeader() {
return Html::rawElement(
'div',
[ 'class' => 'mw-explainconflict' ],
$this->out->msg( 'explainconflict', $this->out->msg( $this->submitLabel )->text() )->parse()
);
}
/**
* HTML to build the textbox1 on edit conflicts
*
* @param array $customAttribs
* @return string HTML
*/
public function getEditConflictMainTextBox( array $customAttribs = [] ) {
$builder = new TextboxBuilder();
$classes = $builder->getTextboxProtectionCSSClasses( $this->title );
$attribs = [
'aria-label' => $this->out->msg( 'edit-textarea-aria-label' )->text(),
'tabindex' => 1,
];
$attribs += $customAttribs;
$attribs = $builder->mergeClassesIntoAttributes( $classes, $attribs );
$attribs = $builder->buildTextboxAttribs(
'wpTextbox1',
$attribs,
$this->out->getUser(),
$this->title
);
return Html::textarea(
'wpTextbox1',
$builder->addNewLineAtEnd( $this->storedversion ),
$attribs
);
}
/**
* 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 = $this->contentHandlerFactory->getContentHandler( $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
*/
private function toEditContent( $text ) {
return ContentHandler::makeContent(
$text,
$this->title,
$this->contentModel,
$this->contentFormat
);
}
}
|