5 Plugin URI: http://status.net/wiki/Feed_subscription
6 Description: FeedSub allows subscribing to real-time updates from external feeds supporting PubHubSubbub protocol.
8 Author: Brion Vibber <brion@status.net>
9 Author URI: http://status.net/
13 * StatusNet - the distributed open-source microblogging tool
14 * Copyright (C) 2009, StatusNet, Inc.
16 * This program is free software: you can redistribute it and/or modify
17 * it under the terms of the GNU Affero General Public License as published by
18 * the Free Software Foundation, either version 3 of the License, or
19 * (at your option) any later version.
21 * This program is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * GNU Affero General Public License for more details.
26 * You should have received a copy of the GNU Affero General Public License
27 * along with this program. If not, see <http://www.gnu.org/licenses/>.
31 * @package FeedSubPlugin
32 * @maintainer Brion Vibber <brion@status.net>
35 if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
37 define('FEEDSUB_SERVICE', 100); // fixme -- avoid hardcoding these?
39 // We bundle the XML_Parse_Feed library...
40 set_include_path(get_include_path() . PATH_SEPARATOR . dirname(__FILE__) . '/extlib');
42 class FeedSubException extends Exception
46 class OStatusPlugin extends Plugin
49 * Hook for RouterInitialized event.
51 * @param Net_URL_Mapper $m path-to-action mapper
52 * @return boolean hook return
54 function onRouterInitialized($m)
57 $m->connect('.well-known/host-meta',
58 array('action' => 'hostmeta'));
59 $m->connect('main/webfinger',
60 array('action' => 'webfinger'));
61 $m->connect('main/ostatus',
62 array('action' => 'ostatusinit'));
63 $m->connect('main/ostatus?nickname=:nickname',
64 array('action' => 'ostatusinit'), array('nickname' => '[A-Za-z0-9_-]+'));
65 $m->connect('main/ostatussub',
66 array('action' => 'ostatussub'));
67 $m->connect('main/ostatussub',
68 array('action' => 'ostatussub'), array('feed' => '[A-Za-z0-9\.\/\:]+'));
71 $m->connect('main/push/hub', array('action' => 'pushhub'));
73 $m->connect('main/push/callback/:feed',
74 array('action' => 'pushcallback'),
75 array('feed' => '[0-9]+'));
76 $m->connect('settings/feedsub',
77 array('action' => 'feedsubsettings'));
80 $m->connect('main/salmon/user/:id',
81 array('action' => 'salmon'),
82 array('id' => '[0-9]+'));
83 $m->connect('main/salmon/group/:id',
84 array('action' => 'salmongroup'),
85 array('id' => '[0-9]+'));
90 * Set up queue handlers for outgoing hub pushes
91 * @param QueueManager $qm
92 * @return boolean hook return
94 function onEndInitializeQueueManager(QueueManager $qm)
96 $qm->connect('hubverify', 'HubVerifyQueueHandler');
97 $qm->connect('hubdistrib', 'HubDistribQueueHandler');
98 $qm->connect('hubout', 'HubOutQueueHandler');
103 * Put saved notices into the queue for pubsub distribution.
105 function onStartEnqueueNotice($notice, &$transports)
107 $transports[] = 'hubdistrib';
112 * Set up a PuSH hub link to our internal link for canonical timeline
113 * Atom feeds for users and groups.
115 function onStartApiAtom(Action $action)
117 if ($action instanceof ApiTimelineUserAction) {
118 $salmonAction = 'salmon';
119 } else if ($action instanceof ApiTimelineGroupAction) {
120 $salmonAction = 'salmongroup';
125 $id = $action->arg('id');
126 if (strval(intval($id)) === strval($id)) {
127 // Canonical form of id in URL? These are used for OStatus syndication.
129 $hub = common_config('ostatus', 'hub');
131 // Updates will be handled through our internal PuSH hub.
132 $hub = common_local_url('pushhub');
134 $action->element('link', array('rel' => 'hub',
137 // Also, we'll add in the salmon link
138 $salmon = common_local_url($salmonAction, array('id' => $id));
139 $action->element('link', array('rel' => 'salmon',
145 * Add the feed settings page to the Connect Settings menu
147 * @param Action &$action The calling page
149 * @return boolean hook return
151 function onEndConnectSettingsNav(&$action)
153 $action_name = $action->trimmed('action');
155 $action->menuItem(common_local_url('feedsubsettings'),
157 _m('Feed subscription options'),
158 $action_name === 'feedsubsettings');
164 * Automatically load the actions and libraries used by the plugin
166 * @param Class $cls the class
168 * @return boolean hook return
171 function onAutoload($cls)
173 $base = dirname(__FILE__);
174 $lower = strtolower($cls);
175 $files = array("$base/classes/$cls.php",
176 "$base/lib/$lower.php");
177 if (substr($lower, -6) == 'action') {
178 $files[] = "$base/actions/" . substr($lower, 0, -6) . ".php";
180 foreach ($files as $file) {
181 if (file_exists($file)) {
190 * Add in an OStatus subscribe button
192 function onStartProfilePageActionsElements($output, $profile)
194 $cur = common_current_user();
197 // Add an OStatus subscribe
198 $output->elementStart('li', 'entity_subscribe');
199 $url = common_local_url('ostatusinit',
200 array('nickname' => $profile->nickname));
201 $output->element('a', array('href' => $url,
202 'class' => 'entity_remote_subscribe'),
205 $output->elementEnd('li');
210 * Check if we've got remote replies to send via Salmon.
212 * @fixme push webfinger lookup & sending to a background queue
213 * @fixme also detect short-form name for remote subscribees where not ambiguous
215 function onEndNoticeSave($notice)
217 $count = preg_match_all('/(\w+\.)*\w+@(\w+\.)*\w+(\w+\-\w+)*\.\w+/', $notice->content, $matches);
219 foreach ($matches[0] as $webfinger) {
220 // Check to see if we've got an actual webfinger
225 $result = $w->lookup($webfinger);
226 if (empty($result)) {
230 foreach ($result->links as $link) {
231 if ($link['rel'] == 'salmon') {
232 $endpoint_uri = $link['href'];
236 if (empty($endpoint_uri)) {
240 $xml = '<?xml version="1.0" encoding="UTF-8" ?>';
241 $xml .= $notice->asAtomEntry();
243 $salmon = new Salmon();
244 $salmon->post($endpoint_uri, $xml);
250 * Garbage collect unused feeds on unsubscribe
252 function onEndUnsubscribe($user, $other)
254 $profile = Ostatus_profile::staticGet('profile_id', $other->id);
256 $sub = new Subscription();
257 $sub->subscribed = $other->id;
259 if (!$sub->find(true)) {
260 common_log(LOG_INFO, "Unsubscribing from now-unused feed $feed->feeduri on hub $feed->huburi");
261 $profile->unsubscribe();
268 * Make sure necessary tables are filled out.
270 function onCheckSchema() {
271 $schema = Schema::get();
272 $schema->ensureTable('ostatus_profile', Ostatus_profile::schemaDef());
273 $schema->ensureTable('hubsub', HubSub::schemaDef());