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]+'));
87 * Set up queue handlers for outgoing hub pushes
88 * @param QueueManager $qm
89 * @return boolean hook return
91 function onEndInitializeQueueManager(QueueManager $qm)
93 $qm->connect('hubverify', 'HubVerifyQueueHandler');
94 $qm->connect('hubdistrib', 'HubDistribQueueHandler');
95 $qm->connect('hubout', 'HubOutQueueHandler');
100 * Put saved notices into the queue for pubsub distribution.
102 function onStartEnqueueNotice($notice, &$transports)
104 $transports[] = 'hubdistrib';
109 * Set up a PuSH hub link to our internal link for canonical timeline
110 * Atom feeds for users and groups.
112 function onStartApiAtom(Action $action)
114 if ($action instanceof ApiTimelineUserAction || $action instanceof ApiTimelineGroupAction) {
115 $id = $action->arg('id');
116 if (strval(intval($id)) === strval($id)) {
117 // Canonical form of id in URL?
118 // Updates will be handled for our internal PuSH hub.
119 $action->element('link', array('rel' => 'hub',
120 'href' => common_local_url('pushhub')));
122 // Also, we'll add in the salmon link
123 $action->element('link', array('rel' => 'salmon',
124 'href' => common_local_url('salmon')));
131 * Add the feed settings page to the Connect Settings menu
133 * @param Action &$action The calling page
135 * @return boolean hook return
137 function onEndConnectSettingsNav(&$action)
139 $action_name = $action->trimmed('action');
141 $action->menuItem(common_local_url('feedsubsettings'),
143 _m('Feed subscription options'),
144 $action_name === 'feedsubsettings');
150 * Automatically load the actions and libraries used by the plugin
152 * @param Class $cls the class
154 * @return boolean hook return
157 function onAutoload($cls)
159 $base = dirname(__FILE__);
160 $lower = strtolower($cls);
161 $files = array("$base/classes/$cls.php",
162 "$base/lib/$lower.php");
163 if (substr($lower, -6) == 'action') {
164 $files[] = "$base/actions/" . substr($lower, 0, -6) . ".php";
166 foreach ($files as $file) {
167 if (file_exists($file)) {
176 * Add in an OStatus subscribe button
178 function onStartProfilePageActionsElements($output, $profile)
180 $cur = common_current_user();
183 // Add an OStatus subscribe
184 $output->elementStart('li', 'entity_subscribe');
185 $url = common_local_url('ostatusinit',
186 array('nickname' => $profile->nickname));
187 $output->element('a', array('href' => $url,
188 'class' => 'entity_remote_subscribe'),
191 $output->elementEnd('li');
196 * Check if we've got some Salmon stuff to send
198 function onEndNoticeSave($notice)
200 $count = preg_match_all('/(\w+\.)*\w+@(\w+\.)*\w+(\w+\-\w+)*\.\w+/', $notice->content, $matches);
202 foreach ($matches[0] as $webfinger) {
203 // Check to see if we've got an actual webfinger
208 $result = $w->lookup($webfinger);
209 if (empty($result)) {
213 foreach ($result->links as $link) {
214 if ($link['rel'] == 'salmon') {
215 $endpoint_uri = $link['href'];
219 if (empty($endpoint_uri)) {
223 $xml = '<?xml version="1.0" encoding="UTF-8" ?>';
224 $xml .= $notice->asAtomEntry();
226 $salmon = new Salmon();
227 $salmon->post($endpoint_uri, $xml);
233 function onCheckSchema() {
234 // warning: the autoincrement doesn't seem to set.
235 // alter table feedinfo change column id id int(11) not null auto_increment;
236 $schema = Schema::get();
237 $schema->ensureTable('feedinfo', Feedinfo::schemaDef());
238 $schema->ensureTable('hubsub', HubSub::schemaDef());