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 OStatusPlugin
22 * @maintainer Brion Vibber <brion@status.net>
25 if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
27 class FeedSubException extends Exception
31 class OStatusPlugin extends Plugin
34 * Hook for RouterInitialized event.
36 * @param Net_URL_Mapper $m path-to-action mapper
37 * @return boolean hook return
39 function onRouterInitialized($m)
42 $m->connect('.well-known/host-meta',
43 array('action' => 'hostmeta'));
44 $m->connect('main/webfinger',
45 array('action' => 'webfinger'));
46 $m->connect('main/ostatus',
47 array('action' => 'ostatusinit'));
48 $m->connect('main/ostatus?nickname=:nickname',
49 array('action' => 'ostatusinit'), array('nickname' => '[A-Za-z0-9_-]+'));
50 $m->connect('main/ostatussub',
51 array('action' => 'ostatussub'));
52 $m->connect('main/ostatussub',
53 array('action' => 'ostatussub'), array('feed' => '[A-Za-z0-9\.\/\:]+'));
56 $m->connect('main/push/hub', array('action' => 'pushhub'));
58 $m->connect('main/push/callback/:feed',
59 array('action' => 'pushcallback'),
60 array('feed' => '[0-9]+'));
61 $m->connect('settings/feedsub',
62 array('action' => 'feedsubsettings'));
65 $m->connect('main/salmon/user/:id',
66 array('action' => 'usersalmon'),
67 array('id' => '[0-9]+'));
68 $m->connect('main/salmon/group/:id',
69 array('action' => 'groupsalmon'),
70 array('id' => '[0-9]+'));
75 * Set up queue handlers for outgoing hub pushes
76 * @param QueueManager $qm
77 * @return boolean hook return
79 function onEndInitializeQueueManager(QueueManager $qm)
81 $qm->connect('hubverify', 'HubVerifyQueueHandler');
82 $qm->connect('hubdistrib', 'HubDistribQueueHandler');
83 $qm->connect('hubout', 'HubOutQueueHandler');
88 * Put saved notices into the queue for pubsub distribution.
90 function onStartEnqueueNotice($notice, &$transports)
92 $transports[] = 'hubdistrib';
97 * Set up a PuSH hub link to our internal link for canonical timeline
98 * Atom feeds for users and groups.
100 function onStartApiAtom($feed)
104 if ($feed instanceof AtomUserNoticeFeed) {
105 $salmonAction = 'usersalmon';
106 $user = $feed->getUser();
108 $profile = $user->getProfile();
109 $feed->setActivitySubject($profile->asActivityNoun('subject'));
110 } else if ($feed instanceof AtomGroupNoticeFeed) {
111 $salmonAction = 'groupsalmon';
112 $group = $feed->getGroup();
114 $feed->setActivitySubject($group->asActivitySubject());
120 $hub = common_config('ostatus', 'hub');
122 // Updates will be handled through our internal PuSH hub.
123 $hub = common_local_url('pushhub');
125 $feed->addLink($hub, array('rel' => 'hub'));
127 // Also, we'll add in the salmon link
128 $salmon = common_local_url($salmonAction, array('id' => $id));
129 $feed->addLink($salmon, array('rel' => 'salmon'));
136 * Add the feed settings page to the Connect Settings menu
138 * @param Action &$action The calling page
140 * @return boolean hook return
142 function onEndConnectSettingsNav(&$action)
144 $action_name = $action->trimmed('action');
146 $action->menuItem(common_local_url('feedsubsettings'),
148 _m('Feed subscription options'),
149 $action_name === 'feedsubsettings');
155 * Automatically load the actions and libraries used by the plugin
157 * @param Class $cls the class
159 * @return boolean hook return
162 function onAutoload($cls)
164 $base = dirname(__FILE__);
165 $lower = strtolower($cls);
166 $map = array('activityverb' => 'activity',
167 'activityobject' => 'activity',
168 'activityutils' => 'activity');
169 if (isset($map[$lower])) {
170 $lower = $map[$lower];
172 $files = array("$base/classes/$cls.php",
173 "$base/lib/$lower.php");
174 if (substr($lower, -6) == 'action') {
175 $files[] = "$base/actions/" . substr($lower, 0, -6) . ".php";
177 foreach ($files as $file) {
178 if (file_exists($file)) {
187 * Add in an OStatus subscribe button
189 function onStartProfileRemoteSubscribe($output, $profile)
191 $cur = common_current_user();
194 // Add an OStatus subscribe
195 $output->elementStart('li', 'entity_subscribe');
196 $url = common_local_url('ostatusinit',
197 array('nickname' => $profile->nickname));
198 $output->element('a', array('href' => $url,
199 'class' => 'entity_remote_subscribe'),
202 $output->elementEnd('li');
209 * Check if we've got remote replies to send via Salmon.
211 * @fixme push webfinger lookup & sending to a background queue
212 * @fixme also detect short-form name for remote subscribees where not ambiguous
214 function onEndNoticeSave($notice)
216 $count = preg_match_all('/(\w+\.)*\w+@(\w+\.)*\w+(\w+\-\w+)*\.\w+/', $notice->content, $matches);
218 foreach ($matches[0] as $webfinger) {
220 // FIXME: look up locally first
222 // Check to see if we've got an actual webfinger
227 $result = $w->lookup($webfinger);
228 if (empty($result)) {
232 foreach ($result->links as $link) {
233 if ($link['rel'] == 'salmon') {
234 $endpoint_uri = $link['href'];
238 if (empty($endpoint_uri)) {
242 // FIXME: this needs to go out in a queue handler
244 $xml = '<?xml version="1.0" encoding="UTF-8" ?>';
245 $xml .= $notice->asAtomEntry();
247 $salmon = new Salmon();
248 $salmon->post($endpoint_uri, $xml);
254 * Notify remote server and garbage collect unused feeds on unsubscribe.
255 * @fixme send these operations to background queues
258 * @param Profile $other
259 * @return hook return value
261 function onEndUnsubscribe($profile, $other)
263 $user = User::staticGet('id', $profile->id);
269 $oprofile = Ostatus_profile::staticGet('profile_id', $other->id);
271 if (empty($oprofile)) {
275 // Drop the PuSH subscription if there are no other subscribers.
277 if ($other->subscriberCount() == 0) {
278 common_log(LOG_INFO, "Unsubscribing from now-unused feed $oprofile->feeduri");
279 $oprofile->unsubscribe();
282 $act = new Activity();
284 $act->verb = ActivityVerb::UNFOLLOW;
286 $act->id = TagURI::mint('unfollow:%d:%d:%s',
289 common_date_iso8601(time()));
292 $act->title = _("Unfollow");
293 $act->content = sprintf(_("%s stopped following %s."),
294 $profile->getBestName(),
295 $other->getBestName());
297 $act->actor = ActivityObject::fromProfile($profile);
298 $act->object = ActivityObject::fromProfile($other);
300 $oprofile->notifyActivity($act);
306 * Make sure necessary tables are filled out.
308 function onCheckSchema() {
309 $schema = Schema::get();
310 $schema->ensureTable('ostatus_profile', Ostatus_profile::schemaDef());
311 $schema->ensureTable('feedsub', FeedSub::schemaDef());
312 $schema->ensureTable('hubsub', HubSub::schemaDef());
316 function onEndShowStatusNetStyles($action) {
317 $action->cssLink(common_path('plugins/OStatus/theme/base/css/ostatus.css'));
321 function onEndShowStatusNetScripts($action) {
322 $action->script(common_path('plugins/OStatus/js/ostatus.js'));
327 * Override the "from ostatus" bit in notice lists to link to the
328 * original post and show the domain it came from.
330 * @param Notice in $notice
331 * @param string out &$name
332 * @param string out &$url
333 * @param string out &$title
334 * @return mixed hook return code
336 function onStartNoticeSourceLink($notice, &$name, &$url, &$title)
338 if ($notice->source == 'ostatus') {
339 $bits = parse_url($notice->uri);
340 $domain = $bits['host'];
344 $title = sprintf(_m("Sent from %s via OStatus"), $domain);
350 * Send incoming PuSH feeds for OStatus endpoints in for processing.
352 * @param FeedSub $feedsub
353 * @param DOMDocument $feed
354 * @return mixed hook return code
356 function onStartFeedSubReceive($feedsub, $feed)
358 $oprofile = Ostatus_profile::staticGet('feeduri', $feedsub->uri);
360 $oprofile->processFeed($feed);
362 common_log(LOG_DEBUG, "No ostatus profile for incoming feed $feedsub->uri");
366 function onEndSubscribe($subscriber, $other)
368 $user = User::staticGet('id', $subscriber->id);
374 $oprofile = Ostatus_profile::staticGet('profile_id', $other->id);
376 if (empty($oprofile)) {
380 $act = new Activity();
382 $act->verb = ActivityVerb::FOLLOW;
384 $act->id = TagURI::mint('follow:%d:%d:%s',
387 common_date_iso8601(time()));
390 $act->title = _("Follow");
391 $act->content = sprintf(_("%s is now following %s."),
392 $subscriber->getBestName(),
393 $other->getBestName());
395 $act->actor = ActivityObject::fromProfile($subscriber);
396 $act->object = ActivityObject::fromProfile($other);
398 $oprofile->notifyActivity($act);
404 * Notify remote users when their notices get favorited.
406 * @param Profile or User $profile of local user doing the faving
407 * @param Notice $notice being favored
408 * @return hook return value
411 function onEndFavorNotice(Profile $profile, Notice $notice)
413 $user = User::staticGet('id', $profile->id);
419 $oprofile = Ostatus_profile::staticGet('profile_id', $notice->profile_id);
421 if (empty($oprofile)) {
425 $act = new Activity();
427 $act->verb = ActivityVerb::FAVORITE;
428 $act->id = TagURI::mint('favor:%d:%d:%s',
431 common_date_iso8601(time()));
434 $act->title = _("Favor");
435 $act->content = sprintf(_("%s marked notice %s as a favorite."),
436 $profile->getBestName(),
439 $act->actor = ActivityObject::fromProfile($profile);
440 $act->object = ActivityObject::fromNotice($notice);
442 $oprofile->notifyActivity($act);
448 * Notify remote users when their notices get de-favorited.
450 * @param Profile $profile Profile person doing the de-faving
451 * @param Notice $notice Notice being favored
453 * @return hook return value
456 function onEndDisfavorNotice(Profile $profile, Notice $notice)
458 $user = User::staticGet('id', $profile->id);
464 $oprofile = Ostatus_profile::staticGet('profile_id', $notice->profile_id);
466 if (empty($oprofile)) {
470 $act = new Activity();
472 $act->verb = ActivityVerb::UNFAVORITE;
473 $act->id = TagURI::mint('disfavor:%d:%d:%s',
476 common_date_iso8601(time()));
478 $act->title = _("Disfavor");
479 $act->content = sprintf(_("%s marked notice %s as no longer a favorite."),
480 $profile->getBestName(),
483 $act->actor = ActivityObject::fromProfile($profile);
484 $act->object = ActivityObject::fromNotice($notice);
486 $oprofile->notifyActivity($act);