3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2010, StatusNet, Inc.
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Affero General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Affero General Public License for more details.
16 * You should have received a copy of the GNU Affero General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 if (!defined('STATUSNET')) {
25 * Prepare PuSH and Salmon distributions for an outgoing message.
27 * @package OStatusPlugin
28 * @author Brion Vibber <brion@status.net>
30 class OStatusQueueHandler extends QueueHandler
32 // If we have more than this many subscribing sites on a single feed,
33 // break up the PuSH distribution into smaller batches which will be
34 // rolled into the queue progressively. This reduces disruption to
35 // other, shorter activities being enqueued while we work.
36 const MAX_UNBATCHED = 50;
38 // Each batch (a 'hubprep' entry) will have this many items.
39 // Selected to provide a balance between queue packet size
40 // and number of batches that will end up getting processed.
41 // For 20,000 target sites, 1000 should work acceptably.
42 const BATCH_SIZE = 1000;
49 function handle($notice)
51 assert($notice instanceof Notice);
53 $this->notice = $notice;
54 $this->user = User::getKV('id', $notice->profile_id);
57 $profile = $this->notice->getProfile();
58 } catch (Exception $e) {
59 common_log(LOG_ERR, "Can't get profile for notice; skipping: " . $e->getMessage());
63 foreach ($notice->getAttentionProfiles() as $target) {
64 common_debug("OSTATUS [{$this->notice->getID()}]: Attention target profile {$target->getNickname()} ({$target->getID()})");
65 if ($target->isGroup()) {
66 common_debug("OSTATUS [{$this->notice->getID()}]: {$target->getID()} is a group");
67 $oprofile = Ostatus_profile::getKV('group_id', $target->getGroup()->getID());
68 if (!$oprofile instanceof Ostatus_profile) {
69 // we don't save profiles like this yet, but in the future
70 $oprofile = Ostatus_profile::getKV('profile_id', $target->getID());
72 if ($oprofile instanceof Ostatus_profile) {
74 if ($notice->isLocal()) {
75 common_debug("OSTATUS [{$this->notice->getID()}]: notice is local and remote group with profile ID {$target->getID()} gets a ping");
76 $this->pingReply($oprofile);
79 common_debug("OSTATUS [{$this->notice->getID()}]: local group with profile id {$target->getID()} gets pushed out");
81 $this->pushGroup($target->getGroup());
83 } elseif ($notice->isLocal()) {
84 // Notices generated on other sites will have already
85 // pinged their reply-targets, so only do these things
86 // if the target is not a group and the notice is locally generated
88 $oprofile = Ostatus_profile::getKV('profile_id', $target->getID());
89 if ($oprofile instanceof Ostatus_profile) {
90 common_debug("OSTATUS [{$this->notice->getID()}]: Notice is local and {$target->getID()} is remote profile, getting pingReply");
91 $this->pingReply($oprofile);
96 if ($notice->isLocal()) {
97 // Notices generated on remote sites will have already
98 // been pushed to user's subscribers by their origin sites.
102 $parent = $this->notice->getParent();
103 foreach($parent->getAttentionProfiles() as $related) {
104 if ($related->isGroup()) {
105 // don't ping groups in parent notices since we might not be a member of them,
106 // though it could be useful if we study this and use it correctly
109 common_debug("OSTATUS [{$this->notice->getID()}]: parent notice {$parent->getID()} has related profile id=={$related->getID()}");
110 // FIXME: don't ping twice in case someone is in both notice attention spans!
111 $oprofile = Ostatus_profile::getKV('profile_id', $related->getID());
112 if ($oprofile instanceof Ostatus_profile) {
113 $this->pingReply($oprofile);
116 } catch (NoParentNoticeException $e) {
117 // nothing to do then
120 foreach ($notice->getProfileTags() as $ptag) {
121 $oprofile = Ostatus_profile::getKV('peopletag_id', $ptag->id);
123 $this->pushPeopletag($ptag);
134 common_debug("OSTATUS [{$this->notice->getID()}]: pushing feed for local user {$this->user->getID()}");
135 // For local posts, ping the PuSH hub to update their feed.
136 // http://identi.ca/api/statuses/user_timeline/1.atom
137 $feed = common_local_url('ApiTimelineUser',
138 array('id' => $this->user->id,
139 'format' => 'atom'));
140 $this->pushFeed($feed, array($this, 'userFeedForNotice'));
144 function pushGroup(User_group $group)
146 common_debug("OSTATUS [{$this->notice->getID()}]: pushing group '{$group->getNickname()}' profile_id={$group->profile_id}");
147 // For a local group, ping the PuSH hub to update its feed.
148 // Updates may come from either a local or a remote user.
149 $feed = common_local_url('ApiTimelineGroup',
150 array('id' => $group->getID(),
151 'format' => 'atom'));
152 $this->pushFeed($feed, array($this, 'groupFeedForNotice'), $group->getID());
155 function pushPeopletag($ptag)
157 common_debug("OSTATUS [{$this->notice->getID()}]: pushing peopletag '{$ptag->id}'");
158 // For a local people tag, ping the PuSH hub to update its feed.
159 // Updates may come from either a local or a remote user.
160 $feed = common_local_url('ApiTimelineList',
161 array('id' => $ptag->id,
162 'user' => $ptag->tagger,
163 'format' => 'atom'));
164 $this->pushFeed($feed, array($this, 'peopletagFeedForNotice'), $ptag);
167 function pingReply(Ostatus_profile $oprofile)
170 common_debug("OSTATUS [{$this->notice->getID()}]: pinging reply to {$oprofile->localProfile()->getNickname()} for local user '{$this->user->getID()}'");
171 // For local posts, send a Salmon ping to the mentioned
172 // remote user or group.
173 // @fixme as an optimization we can skip this if the
174 // remote profile is subscribed to the author.
175 $oprofile->notifyDeferred($this->notice, $this->user);
180 * @param string $feed URI to the feed
181 * @param callable $callback function to generate Atom feed update if needed
182 * any additional params are passed to the callback.
184 function pushFeed($feed, $callback)
186 $hub = common_config('ostatus', 'hub');
188 $this->pushFeedExternal($feed, $hub);
194 $args = array_slice(func_get_args(), 2);
195 $atom = call_user_func_array($callback, $args);
196 $this->pushFeedInternal($atom, $sub);
198 common_log(LOG_INFO, "No PuSH subscribers for $feed");
204 * Ping external hub about this update.
205 * The hub will pull the feed and check for new items later.
206 * Not guaranteed safe in an environment with database replication.
208 * @param string $feed feed topic URI
209 * @param string $hub PuSH hub URI
210 * @fixme can consolidate pings for user & group posts
212 function pushFeedExternal($feed, $hub)
214 $client = new HTTPClient();
216 $data = array('hub.mode' => 'publish',
218 $response = $client->post($hub, array(), $data);
219 if ($response->getStatus() == 204) {
220 common_log(LOG_INFO, "PuSH ping to hub $hub for $feed ok");
223 common_log(LOG_ERR, "PuSH ping to hub $hub for $feed failed with HTTP " .
224 $response->getStatus() . ': ' .
225 $response->getBody());
227 } catch (Exception $e) {
228 common_log(LOG_ERR, "PuSH ping to hub $hub for $feed failed: " . $e->getMessage());
234 * Queue up direct feed update pushes to subscribers on our internal hub.
235 * If there are a large number of subscriber sites, intermediate bulk
236 * distribution triggers may be queued.
238 * @param string $atom update feed, containing only new/changed items
239 * @param HubSub $sub open query of subscribers
241 function pushFeedInternal($atom, $sub)
243 common_log(LOG_INFO, "Preparing $sub->N PuSH distribution(s) for $sub->topic");
246 while ($sub->fetch()) {
248 if ($n < self::MAX_UNBATCHED) {
249 $sub->distribute($atom);
251 $batch[] = $sub->callback;
252 if (count($batch) >= self::BATCH_SIZE) {
253 $sub->bulkDistribute($atom, $batch);
258 if (count($batch) > 0) {
259 $sub->bulkDistribute($atom, $batch);
264 * Build a single-item version of the sending user's Atom feed.
267 function userFeedForNotice()
269 $atom = new AtomUserNoticeFeed($this->user);
270 $atom->addEntryFromNotice($this->notice);
271 $feed = $atom->getString();
276 function groupFeedForNotice($group_id)
278 $group = User_group::getKV('id', $group_id);
280 $atom = new AtomGroupNoticeFeed($group);
281 $atom->addEntryFromNotice($this->notice);
282 $feed = $atom->getString();
287 function peopletagFeedForNotice($ptag)
289 $atom = new AtomListNoticeFeed($ptag);
290 $atom->addEntryFromNotice($this->notice);
291 $feed = $atom->getString();