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     function transport()
  29     {
  30         return 'ostatus';
  31     }
  32
  33     function handle($notice)
  34     {
  35         assert($notice instanceof Notice);
  36
  37         $this->notice = $notice;
  38         $this->user = User::staticGet($notice->profile_id);
  39
  40         $this->pushUser();
  41
  42         foreach ($notice->getGroups() as $group) {
  43             $oprofile = Ostatus_profile::staticGet('group_id', $group->id);
  44             if ($oprofile) {
  45                 $this->pingReply($oprofile);
  46             } else {
  47                 $this->pushGroup($group->id);
  48             }
  49         }
  50
  51         foreach ($notice->getReplies() as $profile_id) {
  52             $oprofile = Ostatus_profile::staticGet('profile_id', $profile_id);
  53             if ($oprofile) {
  54                 $this->pingReply($oprofile);
  55             }
  56         }
  57
  58         return true;
  59     }
  60
  61     function pushUser()
  62     {
  63         if ($this->user) {
  64             // For local posts, ping the PuSH hub to update their feed.
  65             // http://identi.ca/api/statuses/user_timeline/1.atom
  66             $feed = common_local_url('ApiTimelineUser',
  67                                      array('id' => $this->user->id,
  68                                            'format' => 'atom'));
  69             $this->pushFeed($feed, array($this, 'userFeedForNotice'));
  70         }
  71     }
  72
  73     function pushGroup($group_id)
  74     {
  75         // For a local group, ping the PuSH hub to update its feed.
  76         // Updates may come from either a local or a remote user.
  77         $feed = common_local_url('ApiTimelineGroup',
  78                                  array('id' => $group_id,
  79                                        'format' => 'atom'));
  80         $this->pushFeed($feed, array($this, 'groupFeedForNotice'), $group_id);
  81     }
  82
  83     function pingReply($oprofile)
  84     {
  85         if ($this->user) {
  86             // For local posts, send a Salmon ping to the mentioned
  87             // remote user or group.
  88             // @fixme as an optimization we can skip this if the
  89             // remote profile is subscribed to the author.
  90             $oprofile->notifyDeferred($this->notice, $this->user);
  91         }
  92     }
  93
  94     /**
  95      * @param string $feed URI to the feed
  96      * @param callable $callback function to generate Atom feed update if needed
  97      *        any additional params are passed to the callback.
  98      */
  99     function pushFeed($feed, $callback)
 100     {
 101         $hub = common_config('ostatus', 'hub');
 102         if ($hub) {
 103             $this->pushFeedExternal($feed, $hub);
 104         }
 105
 106         $sub = new HubSub();
 107         $sub->topic = $feed;
 108         if ($sub->find()) {
 109             $args = array_slice(func_get_args(), 2);
 110             $atom = call_user_func_array($callback, $args);
 111             $this->pushFeedInternal($atom, $sub);
 112         } else {
 113             common_log(LOG_INFO, "No PuSH subscribers for $feed");
 114         }
 115         return true;
 116     }
 117
 118     /**
 119      * Ping external hub about this update.
 120      * The hub will pull the feed and check for new items later.
 121      * Not guaranteed safe in an environment with database replication.
 122      *
 123      * @param string $feed feed topic URI
 124      * @param string $hub PuSH hub URI
 125      * @fixme can consolidate pings for user & group posts
 126      */
 127     function pushFeedExternal($feed, $hub)
 128     {
 129         $client = new HTTPClient();
 130         try {
 131             $data = array('hub.mode' => 'publish',
 132                           'hub.url' => $feed);
 133             $response = $client->post($hub, array(), $data);
 134             if ($response->getStatus() == 204) {
 135                 common_log(LOG_INFO, "PuSH ping to hub $hub for $feed ok");
 136                 return true;
 137             } else {
 138                 common_log(LOG_ERR, "PuSH ping to hub $hub for $feed failed with HTTP " .
 139                                     $response->getStatus() . ': ' .
 140                                     $response->getBody());
 141             }
 142         } catch (Exception $e) {
 143             common_log(LOG_ERR, "PuSH ping to hub $hub for $feed failed: " . $e->getMessage());
 144             return false;
 145         }
 146     }
 147
 148     /**
 149      * Queue up direct feed update pushes to subscribers on our internal hub.
 150      * @param string $atom update feed, containing only new/changed items
 151      * @param HubSub $sub open query of subscribers
 152      */
 153     function pushFeedInternal($atom, $sub)
 154     {
 155         common_log(LOG_INFO, "Preparing $sub->N PuSH distribution(s) for $sub->topic");
 156         while ($sub->fetch()) {
 157             $sub->distribute($atom);
 158         }
 159     }
 160
 161     /**
 162      * Build a single-item version of the sending user's Atom feed.
 163      * @return string
 164      */
 165     function userFeedForNotice()
 166     {
 167         $atom = new AtomUserNoticeFeed($this->user);
 168         $atom->addEntryFromNotice($this->notice);
 169         $feed = $atom->getString();
 170
 171         return $feed;
 172     }
 173
 174     function groupFeedForNotice($group_id)
 175     {
 176         $group = User_group::staticGet('id', $group_id);
 177
 178         $atom = new AtomGroupNoticeFeed($group);
 179         $atom->addEntryFromNotice($this->notice);
 180         $feed = $atom->getString();
 181
 182         return $feed;
 183     }
 184
 185 }
 186