f8ecea1e5c
Follows-up 39a6e3dc4d (I8be497c623c5d92).
* Improve documentation all around and advertise 'class'
everywhere instead of 'uri'.
* Add test coverage for RCFeed::factory().
* Deprecate the $wgRCEngines "uri to class" mapping in favour
of specifying "class" directly in $wgRCFeeds.
* Deprecate RCFeedEngine in favour of FormattedRCFeed.
Convert to class_alias so that UDPRCFeedEngine no longer has
to extend the deprecated class name explicitly (for instanceof compat).
* Hard-deprecate RecentChange::getEngine.
Bug: T250628
Depends-On: Ie939e1d06b9ee2d841ec7256c8d24cc4e7e386dd
Change-Id: Ib6758d724c7200404c89c7ab157aa55f1cad9763
81 lines
2.4 KiB
PHP
81 lines
2.4 KiB
PHP
<?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
|
|
*/
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
class RedisPubSubFeedEngine extends FormattedRCFeed {
|
|
|
|
/**
|
|
* @see FormattedRCFeed::send
|
|
* @param array $feed
|
|
* @param string $line
|
|
* @return bool
|
|
*/
|
|
public function send( array $feed, $line ) {
|
|
$parsed = wfParseUrl( $feed['uri'] );
|
|
$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;
|
|
}
|
|
}
|