Page MenuHomeWickedGov Phorge
Files F5952253

RedisPubSubFeedEngine.php
No OneTemporary
Actions

Size
2 KB
Referenced Files
None
Subscribers
None

RedisPubSubFeedEngine.php
View Options

<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
namespace MediaWiki\RCFeed;
use Wikimedia\ObjectCache\RedisConnectionPool;
/**
* Send recent change to a Redis Pub/Sub channel.
*
* 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.
*
* Parameters:
* - `formatter`: (Required) Which RCFeedFormatter class to use.
* - `uri`: (Required) Where to send the messages.
*
* @par Example:
* @code
* $wgRCFeeds['rc-to-redis'] = [
* 'class' => 'RedisPubSubFeedEngine',
* 'formatter' => 'JSONRCFeedFormatter',
* 'uri' => "redis://127.0.0.1:6379/rc.$wgDBname",
* ];
* @endcode
*
* @see $wgRCFeeds
* @since 1.22
* @ingroup RecentChanges
*/
class RedisPubSubFeedEngine extends FormattedRCFeed {
/**
* @see FormattedRCFeed::send
* @param array $feed
* @param string $line
* @return bool
*/
public function send( array $feed, $line ) {
$parsed = wfGetUrlUtils()->parse( $feed['uri'] );
// @phan-suppress-next-line PhanTypeArraySuspiciousNullable Valid URL
$server = $parsed['host'];
$options = [ '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 );
if ( $conn !== false ) {
$conn->publish( $channel, $line );
return true;
}
return false;
}
}
/** @deprecated class alias since 1.43 */
class_alias( RedisPubSubFeedEngine::class, 'RedisPubSubFeedEngine' );

File Metadata

Mime Type
text/x-php
Expires
Oct 3 2026, 01:20 (4 w, 4 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
d5/94/1029d37bf34e340d1fb51c26547e
Default Alt Text
RedisPubSubFeedEngine.php (2 KB)

Event Timeline