TextConflictHelper.php

Go to the documentation of this file.

<?php
namespace MediaWiki\EditPage;
 
use Content;
use ContentHandler;
use Html;
use IBufferingStatsdDataFactory;
use MediaWiki\Content\IContentHandlerFactory;
use MediaWiki\MediaWikiServices;
use MWUnknownContentModelException;
use OutputPage;
use Title;
use User;
 
class TextConflictHelper {
 
    protected $title;
 
    public $contentModel;
 
    public $contentFormat;
 
    protected $out;
 
    protected $stats;
 
    protected $submitLabel;
 
    protected $yourtext = '';
 
    protected $storedversion = '';
 
    private $contentHandlerFactory;
 
    public function __construct( Title $title, OutputPage $out, IBufferingStatsdDataFactory $stats,
        $submitLabel, ?IContentHandlerFactory $contentHandlerFactory = null
    ) {
        $this->title = $title;
        $this->out = $out;
        $this->stats = $stats;
        $this->submitLabel = $submitLabel;
        $this->contentModel = $title->getContentModel();
 
        if ( !$contentHandlerFactory ) {
            wfDeprecated( __METHOD__ . ' without $contentHandlerFactory parameter', '1.35' );
            $contentHandlerFactory = MediaWikiServices::getInstance()->getContentHandlerFactory();
        }
        $this->contentHandlerFactory = $contentHandlerFactory;
 
        $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 ) {
        $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()
            );
        }
        if ( $user ) {
            $this->incrementStatsByUserEdits( $user->getEditCount(), 'edit.failures.conflict' );
        }
    }
 
    public function incrementResolvedStats( User $user = null ) {
        $this->stats->increment( '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
        ) {
            $this->stats->increment(
                'edit.failures.conflict.resolved.byNamespaceId.' . $this->title->getNamespace()
            );
        }
        if ( $user ) {
            $this->incrementStatsByUserEdits(
                $user->getEditCount(),
                'edit.failures.conflict.resolved'
            );
        }
    }
 
    protected function incrementStatsByUserEdits( $userEdits, $keyPrefixBase ) {
        if ( $userEdits === null ) {
            $userBucket = 'anon';
        } elseif ( $userEdits > 200 ) {
            $userBucket = 'over200';
        } elseif ( $userEdits > 100 ) {
            $userBucket = 'over100';
        } elseif ( $userEdits > 10 ) {
            $userBucket = 'over10';
        } else {
            $userBucket = 'under11';
        }
        $this->stats->increment( $keyPrefixBase . '.byUserEdits.' . $userBucket );
    }
 
    public function getExplainHeader() {
        return Html::rawElement(
            'div',
            [ 'class' => 'mw-explainconflict' ],
            $this->out->msg( 'explainconflict', $this->out->msg( $this->submitLabel )->text() )->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;
 
        $attribs = $builder->mergeClassesIntoAttributes( $classes, $attribs );
 
        $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
        );
    }
}