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/>.
21 * @package FeedSubPlugin
22 * @maintainer Brion Vibber <brion@status.net>
26 PuSH subscription flow:
29 generate random verification token
31 sends a sub request to the hub...
34 hub sends confirmation back to us via GET
35 We verify the request, then echo back the challenge.
36 On our end, we save the time we subscribed and the lease expiration
39 hub sends us updates via POST
43 class FeedDBException extends FeedSubException
47 function __construct($obj)
49 parent::__construct('Database insert failure');
54 class Ostatus_profile extends Memcached_DataObject
56 public $__table = 'ostatus_profile';
65 // PuSH subscription data
69 public $sub_state; // subscribe, active, unsubscribe
79 public /*static*/ function staticGet($k, $v=null)
81 return parent::staticGet(__CLASS__, $k, $v);
85 * return table definition for DB_DataObject
87 * DB_DataObject needs to know something about the table to manipulate
88 * instances. This method provides all the DB_DataObject needs to know.
90 * @return array array of column definitions
95 return array('id' => DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL,
96 'profile_id' => DB_DATAOBJECT_INT,
97 'group_id' => DB_DATAOBJECT_INT,
98 'feeduri' => DB_DATAOBJECT_STR + DB_DATAOBJECT_NOTNULL,
99 'homeuri' => DB_DATAOBJECT_STR + DB_DATAOBJECT_NOTNULL,
100 'huburi' => DB_DATAOBJECT_STR,
101 'secret' => DB_DATAOBJECT_STR,
102 'verify_token' => DB_DATAOBJECT_STR,
103 'sub_state' => DB_DATAOBJECT_STR,
104 'sub_start' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME,
105 'sub_end' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME,
106 'salmonuri' => DB_DATAOBJECT_STR,
107 'created' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL,
108 'lastupdate' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL);
111 static function schemaDef()
113 return array(new ColumnDef('id', 'integer',
119 /*auto_increment*/ true),
120 new ColumnDef('profile_id', 'integer',
122 new ColumnDef('group_id', 'integer',
124 new ColumnDef('feeduri', 'varchar',
126 new ColumnDef('homeuri', 'varchar',
128 new ColumnDef('huburi', 'text',
130 new ColumnDef('verify_token', 'varchar',
132 new ColumnDef('secret', 'varchar',
134 new ColumnDef('sub_state', "enum('subscribe','active','unsubscribe')",
136 new ColumnDef('sub_start', 'datetime',
138 new ColumnDef('sub_end', 'datetime',
140 new ColumnDef('salmonuri', 'text',
142 new ColumnDef('created', 'datetime',
144 new ColumnDef('lastupdate', 'datetime',
149 * return key definitions for DB_DataObject
151 * DB_DataObject needs to know about keys that the table has; this function
154 * @return array key definitions
159 return array_keys($this->keyTypes());
163 * return key definitions for Memcached_DataObject
165 * Our caching system uses the same key definitions, but uses a different
166 * method to get them.
168 * @return array key definitions
173 return array('id' => 'K', 'profile_id' => 'U', 'group_id' => 'U', 'feeduri' => 'U');
176 function sequenceKey()
178 return array('id', true, false);
182 * Fetch the StatusNet-side profile for this feed
185 public function getLocalProfile()
187 return Profile::staticGet('id', $this->profile_id);
191 * @param FeedMunger $munger
192 * @param boolean $isGroup is this a group record?
193 * @return Ostatus_profile
195 public static function ensureProfile($munger)
197 $entity = $munger->ostatusProfile();
199 $current = self::staticGet('feeduri', $entity->feeduri);
201 // @fixme we should probably update info as necessary
205 $entity->query('BEGIN');
207 // Awful hack! Awful hack!
208 $entity->verify = common_good_rand(16);
209 $entity->secret = common_good_rand(32);
212 $profile = $munger->profile();
213 $result = $profile->insert();
214 if (empty($result)) {
215 throw new FeedDBException($profile);
218 $avatar = $munger->getAvatar();
220 // @fixme this should be better encapsulated
221 // ripped from oauthstore.php (for old OMB client)
222 $temp_filename = tempnam(sys_get_temp_dir(), 'listener_avatar');
223 copy($avatar, $temp_filename);
224 $imagefile = new ImageFile($profile->id, $temp_filename);
225 $filename = Avatar::filename($profile->id,
226 image_type_to_extension($imagefile->type),
229 rename($temp_filename, Avatar::path($filename));
230 $profile->setOriginal($filename);
233 $entity->profile_id = $profile->id;
234 if ($entity->isGroup()) {
235 $group = new User_group();
236 $group->nickname = $profile->nickname . '@remote'; // @fixme
237 $group->fullname = $profile->fullname;
238 $group->homepage = $profile->homepage;
239 $group->location = $profile->location;
240 $group->created = $profile->created;
244 $group->setOriginal($filename);
247 $entity->group_id = $group->id;
250 $result = $entity->insert();
251 if (empty($result)) {
252 throw new FeedDBException($entity);
255 $entity->query('COMMIT');
256 } catch (FeedDBException $e) {
257 common_log_db_error($e->obj, 'INSERT', __FILE__);
258 $entity->query('ROLLBACK');
269 return (strpos($this->feeduri, '/groups/') !== false);
273 * Send a subscription request to the hub for this feed.
274 * The hub will later send us a confirmation POST to /main/push/callback.
276 * @return bool true on success, false on failure
278 public function subscribe($mode='subscribe')
280 if (common_config('feedsub', 'nohub')) {
281 // Fake it! We're just testing remote feeds w/o hubs.
284 // @fixme use the verification token
285 #$token = md5(mt_rand() . ':' . $this->feeduri);
286 #$this->verify_token = $token;
287 #$this->update(); // @fixme
289 $callback = common_local_url('pushcallback', array('feed' => $this->id));
290 $headers = array('Content-Type: application/x-www-form-urlencoded');
291 $post = array('hub.mode' => $mode,
292 'hub.callback' => $callback,
293 'hub.verify' => 'async',
294 'hub.verify_token' => $this->verify_token,
295 'hub.secret' => $this->secret,
296 //'hub.lease_seconds' => 0,
297 'hub.topic' => $this->feeduri);
298 $client = new HTTPClient();
299 $response = $client->post($this->huburi, $headers, $post);
300 $status = $response->getStatus();
301 if ($status == 202) {
302 common_log(LOG_INFO, __METHOD__ . ': sub req ok, awaiting verification callback');
304 } else if ($status == 204) {
305 common_log(LOG_INFO, __METHOD__ . ': sub req ok and verified');
307 } else if ($status >= 200 && $status < 300) {
308 common_log(LOG_ERR, __METHOD__ . ": sub req returned unexpected HTTP $status: " . $response->getBody());
311 common_log(LOG_ERR, __METHOD__ . ": sub req failed with HTTP $status: " . $response->getBody());
314 } catch (Exception $e) {
316 common_log(LOG_ERR, __METHOD__ . ": error \"{$e->getMessage()}\" hitting hub $this->huburi subscribing to $this->feeduri");
322 * Send an unsubscription request to the hub for this feed.
323 * The hub will later send us a confirmation POST to /main/push/callback.
325 * @return bool true on success, false on failure
327 public function unsubscribe() {
328 return $this->subscribe('unsubscribe');
332 * Read and post notices for updates from the feed.
333 * Currently assumes that all items in the feed are new,
334 * coming from a PuSH hub.
336 * @param string $xml source of Atom or RSS feed
337 * @param string $hmac X-Hub-Signature header, if present
339 public function postUpdates($xml, $hmac)
341 common_log(LOG_INFO, __METHOD__ . ": packet for \"$this->feeduri\"! $hmac $xml");
344 if (preg_match('/^sha1=([0-9a-fA-F]{40})$/', $hmac, $matches)) {
345 $their_hmac = strtolower($matches[1]);
346 $our_hmac = hash_hmac('sha1', $xml, $this->secret);
347 if ($their_hmac !== $our_hmac) {
348 common_log(LOG_ERR, __METHOD__ . ": ignoring PuSH with bad SHA-1 HMAC: got $their_hmac, expected $our_hmac");
352 common_log(LOG_ERR, __METHOD__ . ": ignoring PuSH with bogus HMAC '$hmac'");
356 common_log(LOG_ERR, __METHOD__ . ": ignoring PuSH with unexpected HMAC '$hmac'");
360 require_once "XML/Feed/Parser.php";
361 $feed = new XML_Feed_Parser($xml, false, false, true);
362 $munger = new FeedMunger($feed);
365 foreach ($feed as $index => $entry) {
366 // @fixme this might sort in wrong order if we get multiple updates
368 $notice = $munger->notice($index);
370 // Double-check for oldies
371 // @fixme this could explode horribly for multiple feeds on a blog. sigh
372 $dupe = new Notice();
373 $dupe->uri = $notice->uri;
374 if ($dupe->find(true)) {
375 common_log(LOG_WARNING, __METHOD__ . ": tried to save dupe notice for entry {$notice->uri} of feed {$this->feeduri}");
379 // @fixme need to ensure that groups get handled correctly
380 $saved = Notice::saveNew($notice->profile_id,
383 array('is_local' => Notice::REMOTE_OMB,
384 'uri' => $notice->uri,
385 'lat' => $notice->lat,
386 'lon' => $notice->lon,
387 'location_ns' => $notice->location_ns,
388 'location_id' => $notice->location_id));
391 common_log(LOG_DEBUG, "going to check group delivery...");
392 if ($this->group_id) {
393 $group = User_group::staticGet($this->group_id);
395 common_log(LOG_INFO, __METHOD__ . ": saving to local shadow group $group->id $group->nickname");
396 $groups = array($group);
398 common_log(LOG_INFO, __METHOD__ . ": lost the local shadow group?");
401 common_log(LOG_INFO, __METHOD__ . ": no local shadow groups");
404 common_log(LOG_DEBUG, "going to add to inboxes...");
405 $notice->addToInboxes($groups, array());
406 common_log(LOG_DEBUG, "added to inboxes.");
412 common_log(LOG_INFO, __METHOD__ . ": no updates in packet for \"$this->feeduri\"! $xml");