TextConflictHelper.php

Go to the documentation of this file.

<?php
namespace MediaWiki\EditPage;
 
use MediaWiki\Content\Content;
use MediaWiki\Content\ContentHandler;
use MediaWiki\Content\IContentHandlerFactory;
use MediaWiki\Content\UnknownContentModelException;
use MediaWiki\Html\Html;
use MediaWiki\Output\OutputPage;
use MediaWiki\Title\Title;
use MediaWiki\User\User;
use Wikimedia\Stats\IBufferingStatsdDataFactory;
use Wikimedia\Stats\StatsFactory;
 
class TextConflictHelper {
 
    public $contentModel;
 
    public $contentFormat;
 
    protected $yourtext = '';
 
    protected $storedversion = '';
 
    public function __construct(
        protected readonly Title $title,
        protected readonly OutputPage $out,
        protected readonly IBufferingStatsdDataFactory|StatsFactory $stats,
        protected readonly string $submitLabel,
        private readonly IContentHandlerFactory $contentHandlerFactory
    ) {
        $this->contentModel = $title->getContentModel();
 
        $this->contentFormat = $this->contentHandlerFactory
            ->getContentHandler( $this->contentModel )
            ->getDefaultFormat();
    }
 
    public function setTextboxes( $yourtext, $storedversion ) {
        $this->yourtext = $yourtext;
        $this->storedversion = $storedversion;
    }
 
    public function setContentModel( $contentModel ) {
        $this->contentModel = $contentModel;
    }
 
    public function setContentFormat( $contentFormat ) {
        $this->contentFormat = $contentFormat;
    }
 
    public function incrementConflictStats( ?User $user = null ) {
        $namespace = 'n/a';
        $userBucket = 'n/a';
 
        // 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';
        }
        if ( $user ) {
            $userBucket = $this->getUserBucket( $user->getEditCount() );
        }
        if ( $this->stats instanceof StatsFactory ) {
            $this->stats->getCounter( 'edit_failure_total' )
                ->setLabel( 'cause', 'conflict' )
                ->setLabel( 'namespace', $namespace )
                ->setLabel( 'user_bucket', $userBucket )
                ->increment();
        }
    }
 
    public function incrementResolvedStats( ?User $user = null ) {
        $namespace = 'n/a';
        $userBucket = 'n/a';
 
        // 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';
        }
 
        if ( $user ) {
            $userBucket = $this->getUserBucket( $user->getEditCount() );
        }
 
        if ( $this->stats instanceof StatsFactory ) {
            $this->stats->getCounter( 'edit_failure_resolved_total' )
                ->setLabel( 'cause', 'conflict' )
                ->setLabel( 'namespace', $namespace )
                ->setLabel( 'user_bucket', $userBucket )
                ->increment();
        }
    }
 
    protected function incrementStatsByUserEdits( $userEdits, $keyPrefixBase ) {
        if ( $this->stats instanceof IBufferingStatsdDataFactory ) {
            $this->stats->increment( $keyPrefixBase . '.byUserEdits.' . $this->getUserBucket( $userEdits ) );
        }
    }
 
    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';
        }
    }
 
    public function getExplainHeader() {
        return Html::rawElement(
            'div',
            [ 'class' => 'mw-explainconflict' ],
            $this->out->msg( 'explainconflict', $this->out->msg( $this->submitLabel ) )->parse()
        );
    }
 
    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;
        foreach ( $classes as $class ) {
            Html::addClass( $attribs['class'], $class );
        }
 
        $attribs = $builder->buildTextboxAttribs(
            'wpTextbox1',
            $attribs,
            $this->out->getUser(),
            $this->title
        );
 
        return Html::textarea(
            'wpTextbox1',
            $builder->addNewLineAtEnd( $this->storedversion ),
            $attribs
        );
    }
 
    public function getEditFormHtmlBeforeContent() {
        return '';
    }
 
    public function getEditFormHtmlAfterContent() {
        return '';
    }
 
    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 )
        );
    }
 
    private function toEditContent( $text ) {
        return ContentHandler::makeContent(
            $text,
            $this->title,
            $this->contentModel,
            $this->contentFormat
        );
    }
}