3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2009-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 * @package OStatusPlugin
26 * @maintainer Brion Vibber <brion@status.net>
30 PuSH subscription flow:
33 sends a sub request to the hub...
36 hub sends confirmation back to us via GET
37 We verify the request, then echo back the challenge.
38 On our end, we save the time we subscribed and the lease expiration
41 hub sends us updates via POST
44 class FeedDBException extends FeedSubException
48 function __construct($obj)
50 parent::__construct('Database insert failure');
56 * FeedSub handles low-level PubHubSubbub (PuSH) subscriptions.
57 * Higher-level behavior building OStatus stuff on top is handled
58 * under Ostatus_profile.
60 class FeedSub extends Managed_DataObject
62 public $__table = 'feedsub';
67 // PuSH subscription data
70 public $sub_state; // subscribe, active, unsubscribe, inactive
78 public static function schemaDef()
82 'id' => array('type' => 'serial', 'not null' => true, 'description' => 'FeedSub local unique id'),
83 'uri' => array('type' => 'varchar', 'not null' => true, 'length' => 255, 'description' => 'FeedSub uri'),
84 'huburi' => array('type' => 'text', 'description' => 'FeedSub hub-uri'),
85 'secret' => array('type' => 'text', 'description' => 'FeedSub stored secret'),
86 'sub_state' => array('type' => 'enum("subscribe","active","unsubscribe","inactive")', 'not null' => true, 'description' => 'subscription state'),
87 'sub_start' => array('type' => 'datetime', 'description' => 'subscription start'),
88 'sub_end' => array('type' => 'datetime', 'description' => 'subscription end'),
89 'last_update' => array('type' => 'datetime', 'not null' => true, 'description' => 'when this record was last updated'),
90 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'),
91 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
93 'primary key' => array('id'),
94 'unique keys' => array(
95 'feedsub_uri_key' => array('uri'),
101 * Fetch the StatusNet-side profile for this feed
104 public function localProfile()
106 if ($this->profile_id) {
107 return Profile::getKV('id', $this->profile_id);
113 * Fetch the StatusNet-side profile for this feed
116 public function localGroup()
118 if ($this->group_id) {
119 return User_group::getKV('id', $this->group_id);
125 * @param string $feeduri
127 * @throws FeedSubException if feed is invalid or lacks PuSH setup
129 public static function ensureFeed($feeduri)
131 $current = self::getKV('uri', $feeduri);
132 if ($current instanceof FeedSub) {
136 $discover = new FeedDiscovery();
137 $discover->discoverFromFeedURL($feeduri);
139 $huburi = $discover->getHubLink();
140 if (!$huburi && !common_config('feedsub', 'fallback_hub')) {
141 throw new FeedSubNoHubException();
144 $feedsub = new FeedSub();
145 $feedsub->uri = $feeduri;
146 $feedsub->huburi = $huburi;
147 $feedsub->sub_state = 'inactive';
149 $feedsub->created = common_sql_now();
150 $feedsub->modified = common_sql_now();
152 $result = $feedsub->insert();
153 if ($result === false) {
154 throw new FeedDBException($feedsub);
161 * Send a subscription request to the hub for this feed.
162 * The hub will later send us a confirmation POST to /main/push/callback.
164 * @return bool true on success, false on failure
165 * @throws ServerException if feed state is not valid
167 public function subscribe()
169 if ($this->sub_state && $this->sub_state != 'inactive') {
170 common_log(LOG_WARNING, "Attempting to (re)start PuSH subscription to {$this->uri} in unexpected state {$this->sub_state}");
172 if (empty($this->huburi)) {
173 if (common_config('feedsub', 'fallback_hub')) {
174 // No native hub on this feed?
175 // Use our fallback hub, which handles polling on our behalf.
176 } else if (common_config('feedsub', 'nohub')) {
177 // Fake it! We're just testing remote feeds w/o hubs.
178 // We'll never actually get updates in this mode.
181 // TRANS: Server exception.
182 throw new ServerException(_m('Attempting to start PuSH subscription for feed with no hub.'));
186 return $this->doSubscribe('subscribe');
190 * Send a PuSH unsubscription request to the hub for this feed.
191 * The hub will later send us a confirmation POST to /main/push/callback.
192 * Warning: this will cancel the subscription even if someone else in
193 * the system is using it. Most callers will want garbageCollect() instead,
194 * which confirms there's no uses left.
196 * @return bool true on success, false on failure
197 * @throws ServerException if feed state is not valid
199 public function unsubscribe() {
200 if ($this->sub_state != 'active') {
201 common_log(LOG_WARNING, "Attempting to (re)end PuSH subscription to {$this->uri} in unexpected state {$this->sub_state}");
203 if (empty($this->huburi)) {
204 if (common_config('feedsub', 'fallback_hub')) {
205 // No native hub on this feed?
206 // Use our fallback hub, which handles polling on our behalf.
207 } else if (common_config('feedsub', 'nohub')) {
208 // Fake it! We're just testing remote feeds w/o hubs.
209 // We'll never actually get updates in this mode.
212 // TRANS: Server exception.
213 throw new ServerException(_m('Attempting to end PuSH subscription for feed with no hub.'));
217 return $this->doSubscribe('unsubscribe');
221 * Check if there are any active local uses of this feed, and if not then
222 * make sure it's inactive, unsubscribing if necessary.
224 * @return boolean true if the subscription is now inactive, false if still active.
226 public function garbageCollect()
228 if ($this->sub_state == '' || $this->sub_state == 'inactive') {
229 // No active PuSH subscription, we can just leave it be.
232 // PuSH subscription is either active or in an indeterminate state.
233 // Check if we're out of subscribers, and if so send an unsubscribe.
235 Event::handle('FeedSubSubscriberCount', array($this, &$count));
238 common_log(LOG_INFO, __METHOD__ . ': ok, ' . $count . ' user(s) left for ' . $this->uri);
241 common_log(LOG_INFO, __METHOD__ . ': unsubscribing, no users left for ' . $this->uri);
242 return $this->unsubscribe();
247 static public function renewalCheck()
250 // the "" empty string check is because we historically haven't saved unsubscribed feeds as NULL
251 $fs->whereAdd('sub_end IS NOT NULL AND sub_end!="" AND sub_end < NOW() - INTERVAL 1 day');
252 if (!$fs->find()) { // find can be both false and 0, depending on why nothing was found
253 throw new NoResultException($fs);
258 public function renew()
264 * Setting to subscribe means it is _waiting_ to become active. This
265 * cannot be done in a transaction because there is a chance that the
266 * remote script we're calling (as in the case of PuSHpress) performs
267 * the lookup _while_ we're POSTing data, which means the transaction
268 * never completes (PushcallbackAction gets an 'inactive' state).
270 * @return boolean true on successful sub/unsub, false on failure
272 protected function doSubscribe($mode)
274 $orig = clone($this);
275 if ($mode == 'subscribe') {
276 $this->secret = common_random_hexstr(32);
278 $this->sub_state = $mode;
279 $this->update($orig);
283 $callback = common_local_url('pushcallback', array('feed' => $this->id));
284 $headers = array('Content-Type: application/x-www-form-urlencoded');
285 $post = array('hub.mode' => $mode,
286 'hub.callback' => $callback,
287 'hub.verify' => 'async', // TODO: deprecated, remove when noone uses PuSH <0.4 (only 'async' method used there)
288 'hub.verify_token' => 'Deprecated-since-PuSH-0.4', // TODO: rm!
290 'hub.secret' => $this->secret,
291 'hub.topic' => $this->uri);
292 $client = new HTTPClient();
294 $hub = $this->huburi;
296 if (common_config('feedsub', 'fallback_hub')) {
297 $hub = common_config('feedsub', 'fallback_hub');
298 if (common_config('feedsub', 'hub_user')) {
299 $u = common_config('feedsub', 'hub_user');
300 $p = common_config('feedsub', 'hub_pass');
301 $client->setAuth($u, $p);
304 throw new FeedSubException('WTF?');
307 $response = $client->post($hub, $headers, $post);
308 $status = $response->getStatus();
309 if ($status == 202) {
310 common_log(LOG_INFO, __METHOD__ . ': sub req ok, awaiting verification callback');
312 } else if ($status >= 200 && $status < 300) {
313 common_log(LOG_ERR, __METHOD__ . ": sub req returned unexpected HTTP $status: " . $response->getBody());
315 common_log(LOG_ERR, __METHOD__ . ": sub req failed with HTTP $status: " . $response->getBody());
317 } catch (Exception $e) {
319 common_log(LOG_ERR, __METHOD__ . ": error \"{$e->getMessage()}\" hitting hub $this->huburi subscribing to $this->uri");
321 $orig = clone($this);
322 $this->sub_state = 'inactive';
323 $this->update($orig);
330 * Save PuSH subscription confirmation.
331 * Sets approximate lease start and end times and finalizes state.
333 * @param int $lease_seconds provided hub.lease_seconds parameter, if given
335 public function confirmSubscribe($lease_seconds)
337 $original = clone($this);
339 $this->sub_state = 'active';
340 $this->sub_start = common_sql_date(time());
341 if ($lease_seconds > 0) {
342 $this->sub_end = common_sql_date(time() + $lease_seconds);
344 $this->sub_end = null; // Backwards compatibility to StatusNet (PuSH <0.4 supported permanent subs)
346 $this->modified = common_sql_now();
348 return $this->update($original);
352 * Save PuSH unsubscription confirmation.
353 * Wipes active PuSH sub info and resets state.
355 public function confirmUnsubscribe()
357 $original = clone($this);
359 // @fixme these should all be null, but DB_DataObject doesn't save null values...?????
361 $this->sub_state = '';
362 $this->sub_start = '';
364 $this->modified = common_sql_now();
366 return $this->update($original);
370 * Accept updates from a PuSH feed. If validated, this object and the
371 * feed (as a DOMDocument) will be passed to the StartFeedSubHandleFeed
372 * and EndFeedSubHandleFeed events for processing.
374 * Not guaranteed to be running in an immediate POST context; may be run
375 * from a queue handler.
377 * Side effects: the feedsub record's lastupdate field will be updated
378 * to the current time (not published time) if we got a legit update.
380 * @param string $post source of Atom or RSS feed
381 * @param string $hmac X-Hub-Signature header, if present
383 public function receive($post, $hmac)
385 common_log(LOG_INFO, __METHOD__ . ": packet for \"$this->uri\"! $hmac $post");
387 if ($this->sub_state != 'active') {
388 common_log(LOG_ERR, __METHOD__ . ": ignoring PuSH for inactive feed $this->uri (in state '$this->sub_state')");
393 common_log(LOG_ERR, __METHOD__ . ": ignoring empty post");
397 if (!$this->validatePushSig($post, $hmac)) {
398 // Per spec we silently drop input with a bad sig,
399 // while reporting receipt to the server.
403 $feed = new DOMDocument();
404 if (!$feed->loadXML($post)) {
405 // @fixme might help to include the err message
406 common_log(LOG_ERR, __METHOD__ . ": ignoring invalid XML");
410 $orig = clone($this);
411 $this->last_update = common_sql_now();
412 $this->update($orig);
414 Event::handle('StartFeedSubReceive', array($this, $feed));
415 Event::handle('EndFeedSubReceive', array($this, $feed));
419 * Validate the given Atom chunk and HMAC signature against our
420 * shared secret that was set up at subscription time.
422 * If we don't have a shared secret, there should be no signature.
423 * If we we do, our the calculated HMAC should match theirs.
425 * @param string $post raw XML source as POSTed to us
426 * @param string $hmac X-Hub-Signature HTTP header value, or empty
427 * @return boolean true for a match
429 protected function validatePushSig($post, $hmac)
432 if (preg_match('/^sha1=([0-9a-fA-F]{40})$/', $hmac, $matches)) {
433 $their_hmac = strtolower($matches[1]);
434 $our_hmac = hash_hmac('sha1', $post, $this->secret);
435 if ($their_hmac === $our_hmac) {
438 if (common_config('feedsub', 'debug')) {
439 $tempfile = tempnam(sys_get_temp_dir(), 'feedsub-receive');
441 file_put_contents($tempfile, $post);
443 common_log(LOG_ERR, __METHOD__ . ": ignoring PuSH with bad SHA-1 HMAC: got $their_hmac, expected $our_hmac for feed $this->uri on $this->huburi; saved to $tempfile");
445 common_log(LOG_ERR, __METHOD__ . ": ignoring PuSH with bad SHA-1 HMAC: got $their_hmac, expected $our_hmac for feed $this->uri on $this->huburi");
448 common_log(LOG_ERR, __METHOD__ . ": ignoring PuSH with bogus HMAC '$hmac'");
454 common_log(LOG_ERR, __METHOD__ . ": ignoring PuSH with unexpected HMAC '$hmac'");