MediaWiki  REL1_31
IRCColourfulRCFeedFormatter.php
Go to the documentation of this file.
1 <?php
2 
36  public function getLine( array $feed, RecentChange $rc, $actionComment ) {
39  $attribs = $rc->getAttributes();
40  if ( $attribs['rc_type'] == RC_CATEGORIZE ) {
41  // Don't send RC_CATEGORIZE events to IRC feed (T127360)
42  return null;
43  }
44 
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 );
49  } else {
50  $titleObj =& $rc->getTitle();
51  }
52  $title = $titleObj->getPrefixedText();
54 
55  if ( $attribs['rc_type'] == RC_LOG ) {
56  $url = '';
57  } else {
59  if ( $attribs['rc_type'] == RC_NEW ) {
60  $query = '?oldid=' . $attribs['rc_this_oldid'];
61  } else {
62  $query = '?diff=' . $attribs['rc_this_oldid'] . '&oldid=' . $attribs['rc_last_oldid'];
63  }
64  if ( $wgUseRCPatrol || ( $attribs['rc_type'] == RC_NEW && $wgUseNPPatrol ) ) {
65  $query .= '&rcid=' . $attribs['rc_id'];
66  }
67  // HACK: We need this hook for WMF's secure server setup
68  Hooks::run( 'IRCLineURL', [ &$url, &$query, $rc ] );
69  $url .= $query;
70  }
71 
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;
78  }
79  // @todo i18n with parentheses in content language?
80  $szdiff = '(' . $szdiff . ')';
81  } else {
82  $szdiff = '';
83  }
84 
85  $user = self::cleanupForIRC( $attribs['rc_user_text'] );
86 
87  if ( $attribs['rc_type'] == RC_LOG ) {
88  $targetText = $rc->getTitle()->getPrefixedText();
89  $comment = self::cleanupForIRC( str_replace(
90  "[[$targetText]]",
91  "[[\00302$targetText\00310]]",
92  $actionComment
93  ) );
94  $flag = $attribs['rc_log_action'];
95  } else {
96  $comment = self::cleanupForIRC(
97  CommentStore::getStore()->getComment( 'rc_comment', $attribs )->text
98  );
99  $flag = '';
100  if ( !$attribs['rc_patrolled']
101  && ( $wgUseRCPatrol || $attribs['rc_type'] == RC_NEW && $wgUseNPPatrol )
102  ) {
103  $flag .= '!';
104  }
105  $flag .= ( $attribs['rc_type'] == RC_NEW ? "N" : "" )
106  . ( $attribs['rc_minor'] ? "M" : "" ) . ( $attribs['rc_bot'] ? "B" : "" );
107  }
108 
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'];
114  } else {
115  $prefix = false;
116  }
117  if ( $prefix !== false ) {
118  $titleString = "\00314[[\00303$prefix:\00307$title\00314]]";
119  } else {
120  $titleString = "\00314[[\00307$title\00314]]";
121  }
122 
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";
127 
128  return $fullString;
129  }
130 
136  public static function cleanupForIRC( $text ) {
137  return str_replace(
138  [ "\n", "\r" ],
139  [ " ", "" ],
141  );
142  }
143 }
$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:247
IRCColourfulRCFeedFormatter\getLine
getLine(array $feed, RecentChange $rc, $actionComment)
Definition: IRCColourfulRCFeedFormatter.php:36
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:273
array
the array() calling protocol came about after MediaWiki 1.4rc1.
IRCColourfulRCFeedFormatter
Generates a colourful notification intended for humans on IRC.
Definition: IRCColourfulRCFeedFormatter.php:28
RecentChange\getAttributes
getAttributes()
Definition: RecentChange.php:1080
text
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
Definition: design.txt:18
$wgScript
$wgScript
The URL path to index.php.
Definition: DefaultSettings.php:206
RecentChange
Utility class for creating new RC entries.
Definition: RecentChange.php:68
RC_LOG
const RC_LOG
Definition: Defines.php:154
$wgUseRCPatrol
$wgUseRCPatrol
Use RC Patrolling to check for vandalism (from recent changes and watchlists) New pages and new files...
Definition: DefaultSettings.php:6860
$wgUseNPPatrol
$wgUseNPPatrol
Use new page patrolling to check new pages on Special:Newpages.
Definition: DefaultSettings.php:6895
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:37
NS_SPECIAL
const NS_SPECIAL
Definition: Defines.php:63
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:964
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
$wgCanonicalServer
$wgCanonicalServer
Canonical URL of the server, to use in IRC feeds and notification e-mails.
Definition: DefaultSettings.php:115
$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:2014
$wgLocalInterwikis
$wgLocalInterwikis
Array for multiple $wgLocalInterwiki values, in case there are several interwiki prefixes that point ...
Definition: DefaultSettings.php:3959
RC_NEW
const RC_NEW
Definition: Defines.php:153
IRCColourfulRCFeedFormatter\cleanupForIRC
static cleanupForIRC( $text)
Remove newlines, carriage returns and decode html entites.
Definition: IRCColourfulRCFeedFormatter.php:136
RC_CATEGORIZE
const RC_CATEGORIZE
Definition: Defines.php:156
Sanitizer\decodeCharReferences
static decodeCharReferences( $text)
Decode any character references, numeric or named entities, in the text and return a UTF-8 string.
Definition: Sanitizer.php:1647
RecentChange\getTitle
& getTitle()
Definition: RecentChange.php:319
$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:1620
RCFeedFormatter
Interface for RC feed formatters.
Definition: RCFeedFormatter.php:27
CommentStore\getStore
static getStore()
Definition: CommentStore.php:130
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:203