MediaWiki  1.29.1
IRCColourfulRCFeedFormatter.php
Go to the documentation of this file.
1 <?php
2 
28 class IRCColourfulRCFeedFormatter implements RCFeedFormatter {
32  public function getLine( array $feed, RecentChange $rc, $actionComment ) {
33  global $wgUseRCPatrol, $wgUseNPPatrol, $wgLocalInterwikis,
34  $wgCanonicalServer, $wgScript;
35  $attribs = $rc->getAttributes();
36  if ( $attribs['rc_type'] == RC_CATEGORIZE ) {
37  // Don't send RC_CATEGORIZE events to IRC feed (T127360)
38  return null;
39  }
40 
41  if ( $attribs['rc_type'] == RC_LOG ) {
42  // Don't use SpecialPage::getTitleFor, backwards compatibility with
43  // IRC API which expects "Log".
44  $titleObj = Title::newFromText( 'Log/' . $attribs['rc_log_type'], NS_SPECIAL );
45  } else {
46  $titleObj =& $rc->getTitle();
47  }
48  $title = $titleObj->getPrefixedText();
49  $title = self::cleanupForIRC( $title );
50 
51  if ( $attribs['rc_type'] == RC_LOG ) {
52  $url = '';
53  } else {
54  $url = $wgCanonicalServer . $wgScript;
55  if ( $attribs['rc_type'] == RC_NEW ) {
56  $query = '?oldid=' . $attribs['rc_this_oldid'];
57  } else {
58  $query = '?diff=' . $attribs['rc_this_oldid'] . '&oldid=' . $attribs['rc_last_oldid'];
59  }
60  if ( $wgUseRCPatrol || ( $attribs['rc_type'] == RC_NEW && $wgUseNPPatrol ) ) {
61  $query .= '&rcid=' . $attribs['rc_id'];
62  }
63  // HACK: We need this hook for WMF's secure server setup
64  Hooks::run( 'IRCLineURL', [ &$url, &$query, $rc ] );
65  $url .= $query;
66  }
67 
68  if ( $attribs['rc_old_len'] !== null && $attribs['rc_new_len'] !== null ) {
69  $szdiff = $attribs['rc_new_len'] - $attribs['rc_old_len'];
70  if ( $szdiff < -500 ) {
71  $szdiff = "\002$szdiff\002";
72  } elseif ( $szdiff >= 0 ) {
73  $szdiff = '+' . $szdiff;
74  }
75  // @todo i18n with parentheses in content language?
76  $szdiff = '(' . $szdiff . ')';
77  } else {
78  $szdiff = '';
79  }
80 
81  $user = self::cleanupForIRC( $attribs['rc_user_text'] );
82 
83  if ( $attribs['rc_type'] == RC_LOG ) {
84  $targetText = $rc->getTitle()->getPrefixedText();
85  $comment = self::cleanupForIRC( str_replace(
86  "[[$targetText]]",
87  "[[\00302$targetText\00310]]",
88  $actionComment
89  ) );
90  $flag = $attribs['rc_log_action'];
91  } else {
92  $comment = self::cleanupForIRC( $attribs['rc_comment'] );
93  $flag = '';
94  if ( !$attribs['rc_patrolled']
95  && ( $wgUseRCPatrol || $attribs['rc_type'] == RC_NEW && $wgUseNPPatrol )
96  ) {
97  $flag .= '!';
98  }
99  $flag .= ( $attribs['rc_type'] == RC_NEW ? "N" : "" )
100  . ( $attribs['rc_minor'] ? "M" : "" ) . ( $attribs['rc_bot'] ? "B" : "" );
101  }
102 
103  if ( $feed['add_interwiki_prefix'] === true && $wgLocalInterwikis ) {
104  // we use the first entry in $wgLocalInterwikis in recent changes feeds
105  $prefix = $wgLocalInterwikis[0];
106  } elseif ( $feed['add_interwiki_prefix'] ) {
107  $prefix = $feed['add_interwiki_prefix'];
108  } else {
109  $prefix = false;
110  }
111  if ( $prefix !== false ) {
112  $titleString = "\00314[[\00303$prefix:\00307$title\00314]]";
113  } else {
114  $titleString = "\00314[[\00307$title\00314]]";
115  }
116 
117  # see http://www.irssi.org/documentation/formats for some colour codes. prefix is \003,
118  # no colour (\003) switches back to the term default
119  $fullString = "$titleString\0034 $flag\00310 " .
120  "\00302$url\003 \0035*\003 \00303$user\003 \0035*\003 $szdiff \00310$comment\003\n";
121 
122  return $fullString;
123  }
124 
130  public static function cleanupForIRC( $text ) {
131  return str_replace(
132  [ "\n", "\r" ],
133  [ " ", "" ],
134  Sanitizer::decodeCharReferences( $text )
135  );
136  }
137 }
IRCColourfulRCFeedFormatter\getLine
getLine(array $feed, RecentChange $rc, $actionComment)
Definition: IRCColourfulRCFeedFormatter.php:32
Title\newFromText
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:265
IRCColourfulRCFeedFormatter
Generates a colourful notification intended for humans on IRC.
Definition: IRCColourfulRCFeedFormatter.php:28
RecentChange\getAttributes
getAttributes()
Definition: RecentChange.php:930
$wgScript
$wgScript
The URL path to index.php.
Definition: DefaultSettings.php:202
RecentChange
Utility class for creating new RC entries.
Definition: RecentChange.php:63
RC_LOG
const RC_LOG
Definition: Defines.php:142
$user
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
Definition: hooks.txt:246
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
$query
null for the wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition: hooks.txt:1572
NS_SPECIAL
const NS_SPECIAL
Definition: Defines.php:51
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:934
$attribs
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing & $attribs
Definition: hooks.txt:1956
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:93
$wgCanonicalServer
$wgCanonicalServer
Canonical URL of the server, to use in IRC feeds and notification e-mails.
Definition: DefaultSettings.php:118
RC_NEW
const RC_NEW
Definition: Defines.php:141
IRCColourfulRCFeedFormatter\cleanupForIRC
static cleanupForIRC( $text)
Remove newlines, carriage returns and decode html entites.
Definition: IRCColourfulRCFeedFormatter.php:130
RC_CATEGORIZE
const RC_CATEGORIZE
Definition: Defines.php:144
RecentChange\getTitle
& getTitle()
Definition: RecentChange.php:252
RCFeedFormatter
Interface for RC feed formatters.
Definition: RCFeedFormatter.php:27
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
array
the array() calling protocol came about after MediaWiki 1.4rc1.