forked from GNUsocial/gnu-social
OStatus: fix group delivery, send reply/group Salmon pings from background.
This commit is contained in:
Brion Vibber
223
plugins/OStatus/lib/ostatusqueuehandler.php
Normal file
223
plugins/OStatus/lib/ostatusqueuehandler.php
Normal file
@@ -0,0 +1,223 @@
|
||||
<?php
|
||||
/*
|
||||
* StatusNet - the distributed open-source microblogging tool
|
||||
* Copyright (C) 2010, StatusNet, Inc.
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as published by
|
||||
* the Free Software Foundation, either version 3 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 Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
/**
|
||||
* Prepare PuSH and Salmon distributions for an outgoing message.
|
||||
*
|
||||
* @package OStatusPlugin
|
||||
* @author Brion Vibber <brion@status.net>
|
||||
*/
|
||||
class OStatusQueueHandler extends QueueHandler
|
||||
{
|
||||
function transport()
|
||||
{
|
||||
return 'ostatus';
|
||||
}
|
||||
|
||||
function handle($notice)
|
||||
{
|
||||
assert($notice instanceof Notice);
|
||||
|
||||
$this->notice = $notice;
|
||||
$this->user = User::staticGet($notice->profile_id);
|
||||
|
||||
$this->pushUser();
|
||||
|
||||
foreach ($notice->getGroups() as $group) {
|
||||
$oprofile = Ostatus_profile::staticGet('group_id', $group->id);
|
||||
if ($oprofile) {
|
||||
$this->pingReply($oprofile);
|
||||
} else {
|
||||
$this->pushGroup($group->id);
|
||||
}
|
||||
}
|
||||
|
||||
foreach ($notice->getReplies() as $profile_id) {
|
||||
$oprofile = Ostatus_profile::staticGet('profile_id', $profile_id);
|
||||
if ($oprofile) {
|
||||
$this->pingReply($oprofile);
|
||||
}
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
function pushUser()
|
||||
{
|
||||
if ($this->user) {
|
||||
// For local posts, ping the PuSH hub to update their feed.
|
||||
// http://identi.ca/api/statuses/user_timeline/1.atom
|
||||
$feed = common_local_url('ApiTimelineUser',
|
||||
array('id' => $this->user->id,
|
||||
'format' => 'atom'));
|
||||
$this->pushFeed($feed, array($this, 'userFeedForNotice'));
|
||||
}
|
||||
}
|
||||
|
||||
function pushGroup($group_id)
|
||||
{
|
||||
// For a local group, ping the PuSH hub to update its feed.
|
||||
// Updates may come from either a local or a remote user.
|
||||
$feed = common_local_url('ApiTimelineGroup',
|
||||
array('id' => $group_id,
|
||||
'format' => 'atom'));
|
||||
$this->pushFeed($feed, array($this, 'groupFeedForNotice'), $group_id);
|
||||
}
|
||||
|
||||
function pingReply($oprofile)
|
||||
{
|
||||
if ($this->user) {
|
||||
if (!empty($oprofile->salmonuri)) {
|
||||
// For local posts, send a Salmon ping to the mentioned
|
||||
// remote user or group.
|
||||
// @fixme as an optimization we can skip this if the
|
||||
// remote profile is subscribed to the author.
|
||||
|
||||
common_log(LOG_INFO, "Prepping to send notice '{$this->notice->uri}' to remote profile '{$oprofile->uri}'.");
|
||||
|
||||
$xml = '<?xml version="1.0" encoding="UTF-8" ?' . '>';
|
||||
$xml .= $this->notice->asAtomEntry(true, true);
|
||||
|
||||
$data = array('salmonuri' => $oprofile->salmonuri,
|
||||
'entry' => $xml);
|
||||
|
||||
$qm = QueueManager::get();
|
||||
$qm->enqueue($data, 'salmonout');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $feed URI to the feed
|
||||
* @param callable $callback function to generate Atom feed update if needed
|
||||
* any additional params are passed to the callback.
|
||||
*/
|
||||
function pushFeed($feed, $callback)
|
||||
{
|
||||
$hub = common_config('ostatus', 'hub');
|
||||
if ($hub) {
|
||||
$this->pushFeedExternal($feed, $hub);
|
||||
}
|
||||
|
||||
$sub = new HubSub();
|
||||
$sub->topic = $feed;
|
||||
if ($sub->find()) {
|
||||
$args = array_slice(func_get_args(), 2);
|
||||
$atom = call_user_func_array($callback, $args);
|
||||
$this->pushFeedInternal($atom, $sub);
|
||||
} else {
|
||||
common_log(LOG_INFO, "No PuSH subscribers for $feed");
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Ping external hub about this update.
|
||||
* The hub will pull the feed and check for new items later.
|
||||
* Not guaranteed safe in an environment with database replication.
|
||||
*
|
||||
* @param string $feed feed topic URI
|
||||
* @param string $hub PuSH hub URI
|
||||
* @fixme can consolidate pings for user & group posts
|
||||
*/
|
||||
function pushFeedExternal($feed, $hub)
|
||||
{
|
||||
$client = new HTTPClient();
|
||||
try {
|
||||
$data = array('hub.mode' => 'publish',
|
||||
'hub.url' => $feed);
|
||||
$response = $client->post($hub, array(), $data);
|
||||
if ($response->getStatus() == 204) {
|
||||
common_log(LOG_INFO, "PuSH ping to hub $hub for $feed ok");
|
||||
return true;
|
||||
} else {
|
||||
common_log(LOG_ERR, "PuSH ping to hub $hub for $feed failed with HTTP " .
|
||||
$response->getStatus() . ': ' .
|
||||
$response->getBody());
|
||||
}
|
||||
} catch (Exception $e) {
|
||||
common_log(LOG_ERR, "PuSH ping to hub $hub for $feed failed: " . $e->getMessage());
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Queue up direct feed update pushes to subscribers on our internal hub.
|
||||
* @param string $atom update feed, containing only new/changed items
|
||||
* @param HubSub $sub open query of subscribers
|
||||
*/
|
||||
function pushFeedInternal($atom, $sub)
|
||||
{
|
||||
common_log(LOG_INFO, "Preparing $sub->N PuSH distribution(s) for $sub->topic");
|
||||
while ($sub->fetch()) {
|
||||
$sub->distribute($atom);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Build a single-item version of the sending user's Atom feed.
|
||||
* @return string
|
||||
*/
|
||||
function userFeedForNotice()
|
||||
{
|
||||
// @fixme this feels VERY hacky...
|
||||
// should probably be a cleaner way to do it
|
||||
|
||||
ob_start();
|
||||
$api = new ApiTimelineUserAction();
|
||||
$api->prepare(array('id' => $this->notice->profile_id,
|
||||
'format' => 'atom',
|
||||
'max_id' => $this->notice->id,
|
||||
'since_id' => $this->notice->id - 1));
|
||||
$api->showTimeline();
|
||||
$feed = ob_get_clean();
|
||||
|
||||
// ...and override the content-type back to something normal... eww!
|
||||
// hope there's no other headers that got set while we weren't looking.
|
||||
header('Content-Type: text/html; charset=utf-8');
|
||||
|
||||
common_log(LOG_DEBUG, $feed);
|
||||
return $feed;
|
||||
}
|
||||
|
||||
function groupFeedForNotice($group_id)
|
||||
{
|
||||
// @fixme this feels VERY hacky...
|
||||
// should probably be a cleaner way to do it
|
||||
|
||||
ob_start();
|
||||
$api = new ApiTimelineGroupAction();
|
||||
$args = array('id' => $group_id,
|
||||
'format' => 'atom',
|
||||
'max_id' => $this->notice->id,
|
||||
'since_id' => $this->notice->id - 1);
|
||||
$api->prepare($args);
|
||||
$api->handle($args);
|
||||
$feed = ob_get_clean();
|
||||
|
||||
// ...and override the content-type back to something normal... eww!
|
||||
// hope there's no other headers that got set while we weren't looking.
|
||||
header('Content-Type: text/html; charset=utf-8');
|
||||
|
||||
common_log(LOG_DEBUG, $feed);
|
||||
return $feed;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user