4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17 * http://www.gnu.org/copyleft/gpl.html
23 * Generates a colourful notification intended for humans on IRC.
28 class IRCColourfulRCFeedFormatter
implements RCFeedFormatter
{
30 * @see RCFeedFormatter::getLine
32 * @param RecentChange $rc
33 * @param string|null $actionComment
36 public function getLine( array $feed, RecentChange
$rc, $actionComment ) {
37 global $wgUseRCPatrol, $wgUseNPPatrol, $wgLocalInterwikis,
38 $wgCanonicalServer, $wgScript;
39 $attribs = $rc->getAttributes();
40 if ( $attribs['rc_type'] == RC_CATEGORIZE
) {
41 // Don't send RC_CATEGORIZE events to IRC feed (T127360)
45 if ( $attribs['rc_type'] == RC_LOG
) {
46 // Don't use SpecialPage::getTitleFor, backwards compatibility with
47 // IRC API which expects "Log".
48 $titleObj = Title
::newFromText( 'Log/' . $attribs['rc_log_type'], NS_SPECIAL
);
50 $titleObj =& $rc->getTitle();
52 $title = $titleObj->getPrefixedText();
53 $title = self
::cleanupForIRC( $title );
55 if ( $attribs['rc_type'] == RC_LOG
) {
58 $url = $wgCanonicalServer . $wgScript;
59 if ( $attribs['rc_type'] == RC_NEW
) {
60 $query = '?oldid=' . $attribs['rc_this_oldid'];
62 $query = '?diff=' . $attribs['rc_this_oldid'] . '&oldid=' . $attribs['rc_last_oldid'];
64 if ( $wgUseRCPatrol ||
( $attribs['rc_type'] == RC_NEW
&& $wgUseNPPatrol ) ) {
65 $query .= '&rcid=' . $attribs['rc_id'];
67 // HACK: We need this hook for WMF's secure server setup
68 Hooks
::run( 'IRCLineURL', [ &$url, &$query, $rc ] );
72 if ( $attribs['rc_old_len'] !== null && $attribs['rc_new_len'] !== null ) {
73 $szdiff = $attribs['rc_new_len'] - $attribs['rc_old_len'];
74 if ( $szdiff < -500 ) {
75 $szdiff = "\002$szdiff\002";
76 } elseif ( $szdiff >= 0 ) {
77 $szdiff = '+' . $szdiff;
79 // @todo i18n with parentheses in content language?
80 $szdiff = '(' . $szdiff . ')';
85 $user = self
::cleanupForIRC( $attribs['rc_user_text'] );
87 if ( $attribs['rc_type'] == RC_LOG
) {
88 $targetText = $rc->getTitle()->getPrefixedText();
89 $comment = self
::cleanupForIRC( str_replace(
91 "[[\00302$targetText\00310]]",
94 $flag = $attribs['rc_log_action'];
96 $comment = self
::cleanupForIRC(
97 CommentStore
::getStore()->getComment( 'rc_comment', $attribs )->text
100 if ( !$attribs['rc_patrolled']
101 && ( $wgUseRCPatrol ||
$attribs['rc_type'] == RC_NEW
&& $wgUseNPPatrol )
105 $flag .= ( $attribs['rc_type'] == RC_NEW ?
"N" : "" )
106 . ( $attribs['rc_minor'] ?
"M" : "" ) . ( $attribs['rc_bot'] ?
"B" : "" );
109 if ( $feed['add_interwiki_prefix'] === true && $wgLocalInterwikis ) {
110 // we use the first entry in $wgLocalInterwikis in recent changes feeds
111 $prefix = $wgLocalInterwikis[0];
112 } elseif ( $feed['add_interwiki_prefix'] ) {
113 $prefix = $feed['add_interwiki_prefix'];
117 if ( $prefix !== false ) {
118 $titleString = "\00314[[\00303$prefix:\00307$title\00314]]";
120 $titleString = "\00314[[\00307$title\00314]]";
123 # see http://www.irssi.org/documentation/formats for some colour codes. prefix is \003,
124 # no colour (\003) switches back to the term default
125 $fullString = "$titleString\0034 $flag\00310 " .
126 "\00302$url\003 \0035*\003 \00303$user\003 \0035*\003 $szdiff \00310$comment\003\n";
132 * Remove newlines, carriage returns and decode html entites
133 * @param string $text
136 public static function cleanupForIRC( $text ) {
140 Sanitizer
::decodeCharReferences( $text )