diff options
author | Pierre Schmitz <pierre@archlinux.de> | 2013-12-08 09:55:49 +0100 |
---|---|---|
committer | Pierre Schmitz <pierre@archlinux.de> | 2013-12-08 09:55:49 +0100 |
commit | 4ac9fa081a7c045f6a9f1cfc529d82423f485b2e (patch) | |
tree | af68743f2f4a47d13f2b0eb05f5c4aaf86d8ea37 /includes/rcfeed | |
parent | af4da56f1ad4d3ef7b06557bae365da2ea27a897 (diff) |
Update to MediaWiki 1.22.0
Diffstat (limited to 'includes/rcfeed')
-rw-r--r-- | includes/rcfeed/IRCColourfulRCFeedFormatter.php | 99 | ||||
-rw-r--r-- | includes/rcfeed/JSONRCFeedFormatter.php | 90 | ||||
-rw-r--r-- | includes/rcfeed/RCFeedEngine.php | 12 | ||||
-rw-r--r-- | includes/rcfeed/RCFeedFormatter.php | 13 | ||||
-rw-r--r-- | includes/rcfeed/RedisPubSubFeedEngine.php | 41 | ||||
-rw-r--r-- | includes/rcfeed/UDPRCFeedEngine.php | 10 |
6 files changed, 265 insertions, 0 deletions
diff --git a/includes/rcfeed/IRCColourfulRCFeedFormatter.php b/includes/rcfeed/IRCColourfulRCFeedFormatter.php new file mode 100644 index 00000000..507369f3 --- /dev/null +++ b/includes/rcfeed/IRCColourfulRCFeedFormatter.php @@ -0,0 +1,99 @@ +<?php +class IRCColourfulRCFeedFormatter implements RCFeedFormatter { + /** + * Generates a colourful notification intended for humans on IRC. + * @see RCFeedFormatter::getLine + */ + public function getLine( array $feed, RecentChange $rc, $actionComment ) { + global $wgUseRCPatrol, $wgUseNPPatrol, $wgLocalInterwiki, + $wgCanonicalServer, $wgScript; + $attribs = $rc->getAttributes(); + 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 + wfRunHooks( 'IRCLineURL', array( &$url, &$query ) ); + $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 { + $comment = self::cleanupForIRC( $attribs['rc_comment'] ); + $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 && $wgLocalInterwiki !== false ) { + $prefix = $wgLocalInterwiki; + } 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; + } + + /** + * Remove newlines, carriage returns and decode html entites + * @param string $text + * @return string + */ + public static function cleanupForIRC( $text ) { + return Sanitizer::decodeCharReferences( str_replace( + array( "\n", "\r" ), + array( " ", "" ), + $text + ) ); + } +} diff --git a/includes/rcfeed/JSONRCFeedFormatter.php b/includes/rcfeed/JSONRCFeedFormatter.php new file mode 100644 index 00000000..f4cb9921 --- /dev/null +++ b/includes/rcfeed/JSONRCFeedFormatter.php @@ -0,0 +1,90 @@ +<?php + +class JSONRCFeedFormatter implements RCFeedFormatter { + /** + * Generates a notification that can be easily interpreted by a machine. + * @see RCFeedFormatter::getLine + */ + public function getLine( array $feed, RecentChange $rc, $actionComment ) { + global $wgCanonicalServer, $wgScriptPath, $wgDBname; + $attrib = $rc->getAttributes(); + + $packet = array( + // Usually, RC ID is exposed only for patrolling purposes, + // but there is no real reason not to expose it in other cases, + // and I can see how this may be potentially useful for clients. + 'id' => $attrib['rc_id'], + 'type' => $attrib['rc_type'], + 'namespace' => $rc->getTitle()->getNamespace(), + 'title' => $rc->getTitle()->getPrefixedText(), + 'comment' => $attrib['rc_comment'], + 'timestamp' => (int)wfTimestamp( TS_UNIX, $attrib['rc_timestamp'] ), + 'user' => $attrib['rc_user_text'], + 'bot' => (bool)$attrib['rc_bot'], + ); + + if ( isset( $feed['channel'] ) ) { + $packet['channel'] = $feed['channel']; + } + + $type = $attrib['rc_type']; + if ( $type == RC_EDIT || $type == RC_NEW ) { + global $wgUseRCPatrol, $wgUseNPPatrol; + + $packet['minor'] = $attrib['rc_minor']; + if ( $wgUseRCPatrol || ( $type == RC_NEW && $wgUseNPPatrol ) ) { + $packet['patrolled'] = $attrib['rc_patrolled']; + } + } + + switch ( $type ) { + case RC_EDIT: + $packet['length'] = array( 'old' => $attrib['rc_old_len'], 'new' => $attrib['rc_new_len'] ); + $packet['revision'] = array( 'old' => $attrib['rc_last_oldid'], 'new' => $attrib['rc_this_oldid'] ); + break; + + case RC_NEW: + $packet['length'] = array( 'old' => NULL, 'new' => $attrib['rc_new_len'] ); + $packet['revision'] = array( 'old' => NULL, 'new' => $attrib['rc_this_oldid'] ); + break; + + case RC_LOG: + $packet['log_type'] = $attrib['rc_log_type']; + $packet['log_action'] = $attrib['rc_log_action']; + if ( $attrib['rc_params'] ) { + wfSuppressWarnings(); + $params = unserialize( $attrib['rc_params'] ); + wfRestoreWarnings(); + if ( + // If it's an actual serialised false... + $attrib['rc_params'] == serialize( false ) || + // Or if we did not get false back when trying to unserialise + $params !== false + ) { + // From ApiQueryLogEvents::addLogParams + $logParams = array(); + // Keys like "4::paramname" can't be used for output so we change them to "paramname" + foreach ( $params as $key => $value ) { + if ( strpos( $key, ':' ) === false ) { + $logParams[$key] = $value; + continue; + } + $logParam = explode( ':', $key, 3 ); + $logParams[$logParam[2]] = $value; + } + $packet['log_params'] = $logParams; + } else { + $packet['log_params'] = explode( "\n", $attrib['rc_params'] ); + } + } + $packet['log_action_comment'] = $actionComment; + break; + } + + $packet['server_url'] = $wgCanonicalServer; + $packet['server_script_path'] = $wgScriptPath ?: '/'; + $packet['wiki'] = $wgDBname; + + return FormatJson::encode( $packet ); + } +} diff --git a/includes/rcfeed/RCFeedEngine.php b/includes/rcfeed/RCFeedEngine.php new file mode 100644 index 00000000..f733bcb7 --- /dev/null +++ b/includes/rcfeed/RCFeedEngine.php @@ -0,0 +1,12 @@ +<?php +interface RCFeedEngine { + /** + * Sends some text to the specified live feed. + * + * @see RecentChange::cleanupForIRC + * @param array $feed The feed, as configured in an associative array. + * @param string $line The text to send. + * @return boolean success + */ + public function send( array $feed, $line ); +} diff --git a/includes/rcfeed/RCFeedFormatter.php b/includes/rcfeed/RCFeedFormatter.php new file mode 100644 index 00000000..6c9f8042 --- /dev/null +++ b/includes/rcfeed/RCFeedFormatter.php @@ -0,0 +1,13 @@ +<?php +interface RCFeedFormatter { + /** + * Formats the line for the live feed. + * + * @param array $feed The feed, as configured in an associative array. + * @param RecentChange $rc The RecentChange object showing what sort + * of event has taken place. + * @param string|null $actionComment + * @return string The text to send. + */ + public function getLine( array $feed, RecentChange $rc, $actionComment ); +} diff --git a/includes/rcfeed/RedisPubSubFeedEngine.php b/includes/rcfeed/RedisPubSubFeedEngine.php new file mode 100644 index 00000000..4bcc1337 --- /dev/null +++ b/includes/rcfeed/RedisPubSubFeedEngine.php @@ -0,0 +1,41 @@ +<?php +class RedisPubSubFeedEngine implements RCFeedEngine { + /** + * Emit a recent change notification via Redis Pub/Sub + * + * If the feed URI contains a path component, it will be used to generate a + * channel name by stripping the leading slash and replacing any remaining + * slashes with '.'. If no path component is present, the channel is set to + * 'rc'. If the URI contains a query string, its parameters will be parsed + * as RedisConnectionPool options. + * + * @example $wgRCFeeds['redis'] = array( + * 'formatter' => 'JSONRCFeedFormatter', + * 'uri' => "redis://127.0.0.1:6379/rc.$wgDBname", + * ); + * + * @since 1.22 + */ + public function send( array $feed, $line ) { + $parsed = parse_url( $feed['uri'] ); + $server = $parsed['host']; + $options = array( 'serializer' => 'none' ); + $channel = 'rc'; + + if ( isset( $parsed['port'] ) ) { + $server .= ":{$parsed['port']}"; + } + if ( isset( $parsed['query'] ) ) { + parse_str( $parsed['query'], $options ); + } + if ( isset( $parsed['pass'] ) ) { + $options['password'] = $parsed['pass']; + } + if ( isset( $parsed['path'] ) ) { + $channel = str_replace( '/', '.', ltrim( $parsed['path'], '/' ) ); + } + $pool = RedisConnectionPool::singleton( $options ); + $conn = $pool->getConnection( $server ); + $conn->publish( $channel, $line ); + } +} diff --git a/includes/rcfeed/UDPRCFeedEngine.php b/includes/rcfeed/UDPRCFeedEngine.php new file mode 100644 index 00000000..beeb73bd --- /dev/null +++ b/includes/rcfeed/UDPRCFeedEngine.php @@ -0,0 +1,10 @@ +<?php +class UDPRCFeedEngine implements RCFeedEngine { + /** + * Sends the notification to the specified host in a UDP packet. + * @see RCFeedEngine::send + */ + public function send( array $feed, $line ) { + wfErrorLog( $line, $feed['uri'] ); + } +} |