IRCColourfulRCFeedFormatter.php

Go to the documentation of this file.

<?php

use MediaWiki\MediaWikiServices;

class IRCColourfulRCFeedFormatter implements RCFeedFormatter {
    public function getLine( array $feed, RecentChange $rc, $actionComment ) {
        global $wgUseRCPatrol, $wgUseNPPatrol, $wgLocalInterwikis,
            $wgCanonicalServer, $wgScript;
        $attribs = $rc->getAttributes();
        if ( $attribs['rc_type'] == RC_CATEGORIZE ) {
            // Don't send RC_CATEGORIZE events to IRC feed (T127360)
            return null;
        }

        if ( $attribs['rc_type'] == RC_LOG ) {
            // Don't use SpecialPage::getTitleFor, backwards compatibility with
            // IRC API which expects "Log".
            $titleObj = Title::newFromText( 'Log/' . $attribs['rc_log_type'], NS_SPECIAL );
        } else {
            $titleObj =& $rc->getTitle();
        }
        $title = $titleObj->getPrefixedText();
        $title = self::cleanupForIRC( $title );

        if ( $attribs['rc_type'] == RC_LOG ) {
            $url = '';
        } else {
            $url = $wgCanonicalServer . $wgScript;
            if ( $attribs['rc_type'] == RC_NEW ) {
                $query = '?oldid=' . $attribs['rc_this_oldid'];
            } else {
                $query = '?diff=' . $attribs['rc_this_oldid'] . '&oldid=' . $attribs['rc_last_oldid'];
            }
            if ( $wgUseRCPatrol || ( $attribs['rc_type'] == RC_NEW && $wgUseNPPatrol ) ) {
                $query .= '&rcid=' . $attribs['rc_id'];
            }
            // HACK: We need this hook for WMF's secure server setup
            Hooks::run( 'IRCLineURL', [ &$url, &$query, $rc ] );
            $url .= $query;
        }

        if ( $attribs['rc_old_len'] !== null && $attribs['rc_new_len'] !== null ) {
            $szdiff = $attribs['rc_new_len'] - $attribs['rc_old_len'];
            if ( $szdiff < -500 ) {
                $szdiff = "\002$szdiff\002";
            } elseif ( $szdiff >= 0 ) {
                $szdiff = '+' . $szdiff;
            }
            // @todo i18n with parentheses in content language?
            $szdiff = '(' . $szdiff . ')';
        } else {
            $szdiff = '';
        }

        $user = self::cleanupForIRC( $attribs['rc_user_text'] );

        if ( $attribs['rc_type'] == RC_LOG ) {
            $targetText = $rc->getTitle()->getPrefixedText();
            $comment = self::cleanupForIRC( str_replace(
                "[[$targetText]]",
                "[[\00302$targetText\00310]]",
                $actionComment
            ) );
            $flag = $attribs['rc_log_action'];
        } else {
            $store = MediaWikiServices::getInstance()->getCommentStore();
            $comment = self::cleanupForIRC(
                $store->getComment( 'rc_comment', $attribs )->text
            );
            $flag = '';
            if ( !$attribs['rc_patrolled']
                && ( $wgUseRCPatrol || $attribs['rc_type'] == RC_NEW && $wgUseNPPatrol )
            ) {
                $flag .= '!';
            }
            $flag .= ( $attribs['rc_type'] == RC_NEW ? "N" : "" )
                . ( $attribs['rc_minor'] ? "M" : "" ) . ( $attribs['rc_bot'] ? "B" : "" );
        }

        if ( $feed['add_interwiki_prefix'] === true && $wgLocalInterwikis ) {
            // we use the first entry in $wgLocalInterwikis in recent changes feeds
            $prefix = $wgLocalInterwikis[0];
        } elseif ( $feed['add_interwiki_prefix'] ) {
            $prefix = $feed['add_interwiki_prefix'];
        } else {
            $prefix = false;
        }
        if ( $prefix !== false ) {
            $titleString = "\00314[[\00303$prefix:\00307$title\00314]]";
        } else {
            $titleString = "\00314[[\00307$title\00314]]";
        }

        # see http://www.irssi.org/documentation/formats for some colour codes. prefix is \003,
        # no colour (\003) switches back to the term default
        $fullString = "$titleString\0034 $flag\00310 " .
            "\00302$url\003 \0035*\003 \00303$user\003 \0035*\003 $szdiff \00310$comment\003\n";

        return $fullString;
    }

    public static function cleanupForIRC( $text ) {
        return str_replace(
            [ "\n", "\r" ],
            [ " ", "" ],
            Sanitizer::decodeCharReferences( $text )
        );
    }
}