plugins/OStatus/lib/ostatusqueuehandler.php

   1 <?php
   2 /*
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2010, StatusNet, Inc.
   5  *
   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.
  10  *
  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.
  15  *
  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/>.
  18  */
  19
  20 /**
  21  * Prepare PuSH and Salmon distributions for an outgoing message.
  22  *
  23  * @package OStatusPlugin
  24  * @author Brion Vibber <brion@status.net>
  25  */
  26 class OStatusQueueHandler extends QueueHandler
  27 {
  28     // If we have more than this many subscribing sites on a single feed,
  29     // break up the PuSH distribution into smaller batches which will be
  30     // rolled into the queue progressively. This reduces disruption to
  31     // other, shorter activities being enqueued while we work.
  32     const MAX_UNBATCHED = 50;
  33
  34     // Each batch (a 'hubprep' entry) will have this many items.
  35     // Selected to provide a balance between queue packet size
  36     // and number of batches that will end up getting processed.
  37     // For 20,000 target sites, 1000 should work acceptably.
  38     const BATCH_SIZE = 1000;
  39
  40     function transport()
  41     {
  42         return 'ostatus';
  43     }
  44
  45     function handle($notice)
  46     {
  47         assert($notice instanceof Notice);
  48
  49         $this->notice = $notice;
  50         $this->user = User::staticGet($notice->profile_id);
  51
  52         $this->pushUser();
  53
  54         foreach ($notice->getGroups() as $group) {
  55             $oprofile = Ostatus_profile::staticGet('group_id', $group->id);
  56             if ($oprofile) {
  57                 $this->pingReply($oprofile);
  58             } else {
  59                 $this->pushGroup($group->id);
  60             }
  61         }
  62
  63         foreach ($notice->getReplies() as $profile_id) {
  64             $oprofile = Ostatus_profile::staticGet('profile_id', $profile_id);
  65             if ($oprofile) {
  66                 $this->pingReply($oprofile);
  67             }
  68         }
  69
  70         return true;
  71     }
  72
  73     function pushUser()
  74     {
  75         if ($this->user) {
  76             // For local posts, ping the PuSH hub to update their feed.
  77             // http://identi.ca/api/statuses/user_timeline/1.atom
  78             $feed = common_local_url('ApiTimelineUser',
  79                                      array('id' => $this->user->id,
  80                                            'format' => 'atom'));
  81             $this->pushFeed($feed, array($this, 'userFeedForNotice'));
  82         }
  83     }
  84
  85     function pushGroup($group_id)
  86     {
  87         // For a local group, ping the PuSH hub to update its feed.
  88         // Updates may come from either a local or a remote user.
  89         $feed = common_local_url('ApiTimelineGroup',
  90                                  array('id' => $group_id,
  91                                        'format' => 'atom'));
  92         $this->pushFeed($feed, array($this, 'groupFeedForNotice'), $group_id);
  93     }
  94
  95     function pingReply($oprofile)
  96     {
  97         if ($this->user) {
  98             // For local posts, send a Salmon ping to the mentioned
  99             // remote user or group.
 100             // @fixme as an optimization we can skip this if the
 101             // remote profile is subscribed to the author.
 102             $oprofile->notifyDeferred($this->notice, $this->user);
 103         }
 104     }
 105
 106     /**
 107      * @param string $feed URI to the feed
 108      * @param callable $callback function to generate Atom feed update if needed
 109      *        any additional params are passed to the callback.
 110      */
 111     function pushFeed($feed, $callback)
 112     {
 113         $hub = common_config('ostatus', 'hub');
 114         if ($hub) {
 115             $this->pushFeedExternal($feed, $hub);
 116         }
 117
 118         $sub = new HubSub();
 119         $sub->topic = $feed;
 120         if ($sub->find()) {
 121             $args = array_slice(func_get_args(), 2);
 122             $atom = call_user_func_array($callback, $args);
 123             $this->pushFeedInternal($atom, $sub);
 124         } else {
 125             common_log(LOG_INFO, "No PuSH subscribers for $feed");
 126         }
 127         return true;
 128     }
 129
 130     /**
 131      * Ping external hub about this update.
 132      * The hub will pull the feed and check for new items later.
 133      * Not guaranteed safe in an environment with database replication.
 134      *
 135      * @param string $feed feed topic URI
 136      * @param string $hub PuSH hub URI
 137      * @fixme can consolidate pings for user & group posts
 138      */
 139     function pushFeedExternal($feed, $hub)
 140     {
 141         $client = new HTTPClient();
 142         try {
 143             $data = array('hub.mode' => 'publish',
 144                           'hub.url' => $feed);
 145             $response = $client->post($hub, array(), $data);
 146             if ($response->getStatus() == 204) {
 147                 common_log(LOG_INFO, "PuSH ping to hub $hub for $feed ok");
 148                 return true;
 149             } else {
 150                 common_log(LOG_ERR, "PuSH ping to hub $hub for $feed failed with HTTP " .
 151                                     $response->getStatus() . ': ' .
 152                                     $response->getBody());
 153             }
 154         } catch (Exception $e) {
 155             common_log(LOG_ERR, "PuSH ping to hub $hub for $feed failed: " . $e->getMessage());
 156             return false;
 157         }
 158     }
 159
 160     /**
 161      * Queue up direct feed update pushes to subscribers on our internal hub.
 162      * If there are a large number of subscriber sites, intermediate bulk
 163      * distribution triggers may be queued.
 164      *
 165      * @param string $atom update feed, containing only new/changed items
 166      * @param HubSub $sub open query of subscribers
 167      */
 168     function pushFeedInternal($atom, $sub)
 169     {
 170         common_log(LOG_INFO, "Preparing $sub->N PuSH distribution(s) for $sub->topic");
 171         $n = 0;
 172         $batch = array();
 173         while ($sub->fetch()) {
 174             $n++;
 175             if ($n < self::MAX_UNBATCHED) {
 176                 $sub->distribute($atom);
 177             } else {
 178                 $batch[] = $sub->callback;
 179                 if (count($batch) >= self::BATCH_SIZE) {
 180                     $sub->bulkDistribute($atom, $batch);
 181                     $batch = array();
 182                 }
 183             }
 184         }
 185         if (count($batch) >= 0) {
 186             $sub->bulkDistribute($atom, $batch);
 187         }
 188     }
 189
 190     /**
 191      * Build a single-item version of the sending user's Atom feed.
 192      * @return string
 193      */
 194     function userFeedForNotice()
 195     {
 196         $atom = new AtomUserNoticeFeed($this->user);
 197         $atom->addEntryFromNotice($this->notice);
 198         $feed = $atom->getString();
 199
 200         return $feed;
 201     }
 202
 203     function groupFeedForNotice($group_id)
 204     {
 205         $group = User_group::staticGet('id', $group_id);
 206
 207         $atom = new AtomGroupNoticeFeed($group);
 208         $atom->addEntryFromNotice($this->notice);
 209         $feed = $atom->getString();
 210
 211         return $feed;
 212     }
 213
 214 }
 215