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';
65 public $uri; // varchar(191) not 255 because utf8mb4 takes more space
67 // PuSH subscription data
70 public $sub_state; // subscribe, active, unsubscribe, inactive, nohub
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' => 191, '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","nohub")', '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', '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 * Get the feed uri (http/https)
103 public function getUri()
105 if (empty($this->uri)) {
106 throw new NoUriException($this);
111 function getLeaseRemaining()
113 if (empty($this->sub_end)) {
116 return strtotime($this->sub_end) - time();
120 * Do we have a hub? Then we are a PuSH feed.
121 * https://en.wikipedia.org/wiki/PubSubHubbub
123 * If huburi is empty, then doublecheck that we are not using
124 * a fallback hub. If there is a fallback hub, it is only if the
125 * sub_state is "nohub" that we assume it's not a PuSH feed.
127 public function isPuSH()
129 if (empty($this->huburi)
130 && (!common_config('feedsub', 'fallback_hub')
131 || $this->sub_state === 'nohub')) {
132 // Here we have no huburi set. Also, either there is no
133 // fallback hub configured or sub_state is "nohub".
140 * Fetch the StatusNet-side profile for this feed
143 public function localProfile()
145 if ($this->profile_id) {
146 return Profile::getKV('id', $this->profile_id);
152 * Fetch the StatusNet-side profile for this feed
155 public function localGroup()
157 if ($this->group_id) {
158 return User_group::getKV('id', $this->group_id);
164 * @param string $feeduri
166 * @throws FeedSubException if feed is invalid or lacks PuSH setup
168 public static function ensureFeed($feeduri)
170 $current = self::getKV('uri', $feeduri);
171 if ($current instanceof FeedSub) {
175 $discover = new FeedDiscovery();
176 $discover->discoverFromFeedURL($feeduri);
178 $huburi = $discover->getHubLink();
179 if (!$huburi && !common_config('feedsub', 'fallback_hub') && !common_config('feedsub', 'nohub')) {
180 throw new FeedSubNoHubException();
183 $feedsub = new FeedSub();
184 $feedsub->uri = $feeduri;
185 $feedsub->huburi = $huburi;
186 $feedsub->sub_state = 'inactive';
188 $feedsub->created = common_sql_now();
189 $feedsub->modified = common_sql_now();
191 $result = $feedsub->insert();
192 if ($result === false) {
193 throw new FeedDBException($feedsub);
200 * Send a subscription request to the hub for this feed.
201 * The hub will later send us a confirmation POST to /main/push/callback.
204 * @throws ServerException if feed state is not valid
206 public function subscribe()
208 if ($this->sub_state && $this->sub_state != 'inactive') {
209 common_log(LOG_WARNING, sprintf('Attempting to (re)start PuSH subscription to %s in unexpected state %s', $this->getUri(), $this->sub_state));
212 if (!Event::handle('FeedSubscribe', array($this))) {
213 // A plugin handled it
217 if (empty($this->huburi)) {
218 if (common_config('feedsub', 'fallback_hub')) {
219 // No native hub on this feed?
220 // Use our fallback hub, which handles polling on our behalf.
221 } else if (common_config('feedsub', 'nohub')) {
222 // For this to actually work, we'll need some polling mechanism.
223 // The FeedPoller plugin should take care of it.
226 // TRANS: Server exception.
227 throw new ServerException(_m('Attempting to start PuSH subscription for feed with no hub.'));
231 $this->doSubscribe('subscribe');
235 * Send a PuSH unsubscription request to the hub for this feed.
236 * The hub will later send us a confirmation POST to /main/push/callback.
237 * Warning: this will cancel the subscription even if someone else in
238 * the system is using it. Most callers will want garbageCollect() instead,
239 * which confirms there's no uses left.
241 * @throws ServerException if feed state is not valid
243 public function unsubscribe() {
244 if ($this->sub_state != 'active') {
245 common_log(LOG_WARNING, sprintf('Attempting to (re)end PuSH subscription to %s in unexpected state %s', $this->getUri(), $this->sub_state));
248 if (!Event::handle('FeedUnsubscribe', array($this))) {
249 // A plugin handled it
253 if (empty($this->huburi)) {
254 if (common_config('feedsub', 'fallback_hub')) {
255 // No native hub on this feed?
256 // Use our fallback hub, which handles polling on our behalf.
257 } else if (common_config('feedsub', 'nohub')) {
258 // We need a feedpolling plugin (like FeedPoller) active so it will
259 // set the 'nohub' state to 'inactive' for us.
262 // TRANS: Server exception.
263 throw new ServerException(_m('Attempting to end PuSH subscription for feed with no hub.'));
267 $this->doSubscribe('unsubscribe');
271 * Check if there are any active local uses of this feed, and if not then
272 * make sure it's inactive, unsubscribing if necessary.
274 * @return boolean true if the subscription is now inactive, false if still active.
275 * @throws NoProfileException in FeedSubSubscriberCount for missing Profile entries
276 * @throws Exception if something goes wrong in unsubscribe() method
278 public function garbageCollect()
280 if ($this->sub_state == '' || $this->sub_state == 'inactive') {
281 // No active PuSH subscription, we can just leave it be.
285 // PuSH subscription is either active or in an indeterminate state.
286 // Check if we're out of subscribers, and if so send an unsubscribe.
288 Event::handle('FeedSubSubscriberCount', array($this, &$count));
291 common_log(LOG_INFO, __METHOD__ . ': ok, ' . $count . ' user(s) left for ' . $this->getUri());
295 common_log(LOG_INFO, __METHOD__ . ': unsubscribing, no users left for ' . $this->getUri());
296 // Unsubscribe throws various Exceptions on failure
297 $this->unsubscribe();
302 static public function renewalCheck()
305 // the "" empty string check is because we historically haven't saved unsubscribed feeds as NULL
306 $fs->whereAdd('sub_end IS NOT NULL AND sub_end!="" AND sub_end < NOW() + INTERVAL 1 day');
307 if (!$fs->find()) { // find can be both false and 0, depending on why nothing was found
308 throw new NoResultException($fs);
313 public function renew()
319 * Setting to subscribe means it is _waiting_ to become active. This
320 * cannot be done in a transaction because there is a chance that the
321 * remote script we're calling (as in the case of PuSHpress) performs
322 * the lookup _while_ we're POSTing data, which means the transaction
323 * never completes (PushcallbackAction gets an 'inactive' state).
325 * @return boolean true when everything is ok (throws Exception on fail)
326 * @throws Exception on failure, can be HTTPClient's or our own.
328 protected function doSubscribe($mode)
330 $orig = clone($this);
331 if ($mode == 'subscribe') {
332 $this->secret = common_random_hexstr(32);
334 $this->sub_state = $mode;
335 $this->update($orig);
339 $callback = common_local_url('pushcallback', array('feed' => $this->id));
340 $headers = array('Content-Type: application/x-www-form-urlencoded');
341 $post = array('hub.mode' => $mode,
342 'hub.callback' => $callback,
343 'hub.verify' => 'async', // TODO: deprecated, remove when noone uses PuSH <0.4 (only 'async' method used there)
344 'hub.verify_token' => 'Deprecated-since-PuSH-0.4', // TODO: rm!
346 'hub.lease_seconds' => 2592000, // 3600*24*30, request approximately month long lease (may be changed by hub)
347 'hub.secret' => $this->secret,
348 'hub.topic' => $this->getUri());
349 $client = new HTTPClient();
351 $hub = $this->huburi;
353 if (common_config('feedsub', 'fallback_hub')) {
354 $hub = common_config('feedsub', 'fallback_hub');
355 if (common_config('feedsub', 'hub_user')) {
356 $u = common_config('feedsub', 'hub_user');
357 $p = common_config('feedsub', 'hub_pass');
358 $client->setAuth($u, $p);
361 throw new FeedSubException('Server could not find a usable PuSH hub.');
364 $response = $client->post($hub, $headers, $post);
365 $status = $response->getStatus();
366 // PuSH specificed response status code
367 if ($status == 202 || $status == 204) {
368 common_log(LOG_INFO, __METHOD__ . ': sub req ok, awaiting verification callback');
370 } else if ($status >= 200 && $status < 300) {
371 common_log(LOG_ERR, __METHOD__ . ": sub req returned unexpected HTTP $status: " . $response->getBody());
373 common_log(LOG_ERR, __METHOD__ . ": sub req failed with HTTP $status: " . $response->getBody());
375 } catch (Exception $e) {
376 common_log(LOG_ERR, __METHOD__ . ": error \"{$e->getMessage()}\" hitting hub {$this->huburi} subscribing to {$this->getUri()}");
378 // Reset the subscription state.
379 $orig = clone($this);
380 $this->sub_state = 'inactive';
381 $this->update($orig);
383 // Throw the Exception again.
386 throw new ServerException("{$mode} request failed.");
390 * Save PuSH subscription confirmation.
391 * Sets approximate lease start and end times and finalizes state.
393 * @param int $lease_seconds provided hub.lease_seconds parameter, if given
395 public function confirmSubscribe($lease_seconds)
397 $original = clone($this);
399 $this->sub_state = 'active';
400 $this->sub_start = common_sql_date(time());
401 if ($lease_seconds > 0) {
402 $this->sub_end = common_sql_date(time() + $lease_seconds);
404 $this->sub_end = null; // Backwards compatibility to StatusNet (PuSH <0.4 supported permanent subs)
406 $this->modified = common_sql_now();
408 return $this->update($original);
412 * Save PuSH unsubscription confirmation.
413 * Wipes active PuSH sub info and resets state.
415 public function confirmUnsubscribe()
417 $original = clone($this);
419 // @fixme these should all be null, but DB_DataObject doesn't save null values...?????
421 $this->sub_state = '';
422 $this->sub_start = '';
424 $this->modified = common_sql_now();
426 return $this->update($original);
430 * Accept updates from a PuSH feed. If validated, this object and the
431 * feed (as a DOMDocument) will be passed to the StartFeedSubHandleFeed
432 * and EndFeedSubHandleFeed events for processing.
434 * Not guaranteed to be running in an immediate POST context; may be run
435 * from a queue handler.
437 * Side effects: the feedsub record's lastupdate field will be updated
438 * to the current time (not published time) if we got a legit update.
440 * @param string $post source of Atom or RSS feed
441 * @param string $hmac X-Hub-Signature header, if present
443 public function receive($post, $hmac)
445 common_log(LOG_INFO, sprintf(__METHOD__.': packet for %s with HMAC %s', _ve($this->getUri()), _ve($hmac)));
447 if (!in_array($this->sub_state, array('active', 'nohub'))) {
448 common_log(LOG_ERR, sprintf(__METHOD__.': ignoring PuSH for inactive feed %s (in state %s)', _ve($this->getUri()), _ve($this->sub_state)));
453 common_log(LOG_ERR, __METHOD__ . ": ignoring empty post");
457 if (!$this->validatePushSig($post, $hmac)) {
458 // Per spec we silently drop input with a bad sig,
459 // while reporting receipt to the server.
463 $feed = new DOMDocument();
464 if (!$feed->loadXML($post)) {
465 // @fixme might help to include the err message
466 common_log(LOG_ERR, __METHOD__ . ": ignoring invalid XML");
470 $orig = clone($this);
471 $this->last_update = common_sql_now();
472 $this->update($orig);
474 Event::handle('StartFeedSubReceive', array($this, $feed));
475 Event::handle('EndFeedSubReceive', array($this, $feed));
479 * Validate the given Atom chunk and HMAC signature against our
480 * shared secret that was set up at subscription time.
482 * If we don't have a shared secret, there should be no signature.
483 * If we do, our calculated HMAC should match theirs.
485 * @param string $post raw XML source as POSTed to us
486 * @param string $hmac X-Hub-Signature HTTP header value, or empty
487 * @return boolean true for a match
489 protected function validatePushSig($post, $hmac)
492 // {3,16} because shortest hash algorithm name is 3 characters (md2,md4,md5) and longest
493 // is currently 11 characters, but we'll leave some margin in the end...
494 if (preg_match('/^([0-9a-zA-Z\-\,]{3,16})=([0-9a-fA-F]+)$/', $hmac, $matches)) {
495 $hash_algo = strtolower($matches[1]);
496 $their_hmac = strtolower($matches[2]);
497 common_debug(sprintf(__METHOD__ . ': PuSH from feed %s uses HMAC algorithm %s with value: %s', _ve($this->getUri()), _ve($hash_algo), _ve($their_hmac)));
499 if (!in_array($hash_algo, hash_algos())) {
500 // We can't handle this at all, PHP doesn't recognize the algorithm name ('md5', 'sha1', 'sha256' etc: https://secure.php.net/manual/en/function.hash-algos.php)
501 common_log(LOG_ERR, sprintf(__METHOD__.': HMAC algorithm %s unsupported, not found in PHP hash_algos()', _ve($hash_algo)));
503 } elseif (!is_null(common_config('security', 'hash_algos')) && !in_array($hash_algo, common_config('security', 'hash_algos'))) {
504 // We _won't_ handle this because there is a list of accepted hash algorithms and this one is not in it.
505 common_log(LOG_ERR, sprintf(__METHOD__.': Whitelist for HMAC algorithms exist, but %s is not included.', _ve($hash_algo)));
509 $our_hmac = hash_hmac($hash_algo, $post, $this->secret);
510 if ($their_hmac === $our_hmac) {
513 common_log(LOG_ERR, sprintf(__METHOD__.': ignoring PuSH with bad HMAC hash: got %s, expected %s for feed %s from hub %s', _ve($their_hmac), _ve($our_hmac), _ve($this->getUri()), _ve($this->huburi)));
515 common_log(LOG_ERR, sprintf(__METHOD__.': ignoring PuSH with bogus HMAC==', _ve($hmac)));
521 common_log(LOG_ERR, sprintf(__METHOD__.': ignoring PuSH with unexpected HMAC==%s', _ve($hmac)));
527 public function delete($useWhere=false)
530 $oprofile = Ostatus_profile::getKV('feeduri', $this->getUri());
531 if ($oprofile instanceof Ostatus_profile) {
532 // Check if there's a profile. If not, handle the NoProfileException below
533 $profile = $oprofile->localProfile();
535 } catch (NoProfileException $e) {
536 // If the Ostatus_profile has no local Profile bound to it, let's clean it out at the same time
538 } catch (NoUriException $e) {
539 // FeedSub->getUri() can throw a NoUriException, let's just go ahead and delete it
541 return parent::delete($useWhere);