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]+'));
63 $m->connect('main/salmon/user/:id',
64 array('action' => 'usersalmon'),
65 array('id' => '[0-9]+'));
66 $m->connect('main/salmon/group/:id',
67 array('action' => 'groupsalmon'),
68 array('id' => '[0-9]+'));
73 * Set up queue handlers for outgoing hub pushes
74 * @param QueueManager $qm
75 * @return boolean hook return
77 function onEndInitializeQueueManager(QueueManager $qm)
79 // Outgoing from our internal PuSH hub
80 $qm->connect('hubverify', 'HubVerifyQueueHandler');
81 $qm->connect('hubdistrib', 'HubDistribQueueHandler');
82 $qm->connect('hubout', 'HubOutQueueHandler');
84 // Incoming from a foreign PuSH hub
85 $qm->connect('pushinput', 'PushInputQueueHandler');
90 * Put saved notices into the queue for pubsub distribution.
92 function onStartEnqueueNotice($notice, &$transports)
94 $transports[] = 'hubdistrib';
99 * Set up a PuSH hub link to our internal link for canonical timeline
100 * Atom feeds for users and groups.
102 function onStartApiAtom($feed)
106 if ($feed instanceof AtomUserNoticeFeed) {
107 $salmonAction = 'usersalmon';
108 $user = $feed->getUser();
110 $profile = $user->getProfile();
111 $feed->setActivitySubject($profile->asActivityNoun('subject'));
112 } else if ($feed instanceof AtomGroupNoticeFeed) {
113 $salmonAction = 'groupsalmon';
114 $group = $feed->getGroup();
116 $feed->setActivitySubject($group->asActivitySubject());
122 $hub = common_config('ostatus', 'hub');
124 // Updates will be handled through our internal PuSH hub.
125 $hub = common_local_url('pushhub');
127 $feed->addLink($hub, array('rel' => 'hub'));
129 // Also, we'll add in the salmon link
130 $salmon = common_local_url($salmonAction, array('id' => $id));
131 $feed->addLink($salmon, array('rel' => 'salmon'));
138 * Automatically load the actions and libraries used by the plugin
140 * @param Class $cls the class
142 * @return boolean hook return
145 function onAutoload($cls)
147 $base = dirname(__FILE__);
148 $lower = strtolower($cls);
149 $map = array('activityverb' => 'activity',
150 'activityobject' => 'activity',
151 'activityutils' => 'activity');
152 if (isset($map[$lower])) {
153 $lower = $map[$lower];
155 $files = array("$base/classes/$cls.php",
156 "$base/lib/$lower.php");
157 if (substr($lower, -6) == 'action') {
158 $files[] = "$base/actions/" . substr($lower, 0, -6) . ".php";
160 foreach ($files as $file) {
161 if (file_exists($file)) {
170 * Add in an OStatus subscribe button
172 function onStartProfileRemoteSubscribe($output, $profile)
174 $cur = common_current_user();
177 // Add an OStatus subscribe
178 $output->elementStart('li', 'entity_subscribe');
179 $url = common_local_url('ostatusinit',
180 array('nickname' => $profile->nickname));
181 $output->element('a', array('href' => $url,
182 'class' => 'entity_remote_subscribe'),
185 $output->elementEnd('li');
192 * Check if we've got remote replies to send via Salmon.
194 * @fixme push webfinger lookup & sending to a background queue
195 * @fixme also detect short-form name for remote subscribees where not ambiguous
198 function onEndNoticeSave($notice)
200 $mentioned = $notice->getReplies();
202 foreach ($mentioned as $profile_id) {
204 $oprofile = Ostatus_profile::staticGet('profile_id', $profile_id);
206 if (!empty($oprofile) && !empty($oprofile->salmonuri)) {
208 // FIXME: this needs to go out in a queue handler
210 $xml = '<?xml version="1.0" encoding="UTF-8" ?>';
211 $xml .= $notice->asAtomEntry(true, true);
213 $salmon = new Salmon();
214 $salmon->post($oprofile->salmonuri, $xml);
223 function onEndFindMentions($sender, $text, &$mentions)
225 preg_match_all('/(?:^|\s+)@((?:\w+\.)*\w+@(?:\w+\.)*\w+(?:\w+\-\w+)*\.\w+)/',
228 PREG_OFFSET_CAPTURE);
230 foreach ($wmatches[1] as $wmatch) {
232 $webfinger = $wmatch[0];
234 $oprofile = Ostatus_profile::ensureWebfinger($webfinger);
236 if (!empty($oprofile)) {
238 $profile = $oprofile->localProfile();
240 $mentions[] = array('mentioned' => array($profile),
241 'text' => $wmatch[0],
242 'position' => $wmatch[1],
243 'url' => $profile->profileurl);
251 * Notify remote server and garbage collect unused feeds on unsubscribe.
252 * @fixme send these operations to background queues
255 * @param Profile $other
256 * @return hook return value
258 function onEndUnsubscribe($profile, $other)
260 $user = User::staticGet('id', $profile->id);
266 $oprofile = Ostatus_profile::staticGet('profile_id', $other->id);
268 if (empty($oprofile)) {
272 // Drop the PuSH subscription if there are no other subscribers.
274 if ($other->subscriberCount() == 0) {
275 common_log(LOG_INFO, "Unsubscribing from now-unused feed $oprofile->feeduri");
276 $oprofile->unsubscribe();
279 $act = new Activity();
281 $act->verb = ActivityVerb::UNFOLLOW;
283 $act->id = TagURI::mint('unfollow:%d:%d:%s',
286 common_date_iso8601(time()));
289 $act->title = _("Unfollow");
290 $act->content = sprintf(_("%s stopped following %s."),
291 $profile->getBestName(),
292 $other->getBestName());
294 $act->actor = ActivityObject::fromProfile($profile);
295 $act->object = ActivityObject::fromProfile($other);
297 $oprofile->notifyActivity($act);
303 * Make sure necessary tables are filled out.
305 function onCheckSchema() {
306 $schema = Schema::get();
307 $schema->ensureTable('ostatus_profile', Ostatus_profile::schemaDef());
308 $schema->ensureTable('ostatus_source', Ostatus_source::schemaDef());
309 $schema->ensureTable('feedsub', FeedSub::schemaDef());
310 $schema->ensureTable('hubsub', HubSub::schemaDef());
314 function onEndShowStatusNetStyles($action) {
315 $action->cssLink(common_path('plugins/OStatus/theme/base/css/ostatus.css'));
319 function onEndShowStatusNetScripts($action) {
320 $action->script(common_path('plugins/OStatus/js/ostatus.js'));
325 * Override the "from ostatus" bit in notice lists to link to the
326 * original post and show the domain it came from.
328 * @param Notice in $notice
329 * @param string out &$name
330 * @param string out &$url
331 * @param string out &$title
332 * @return mixed hook return code
334 function onStartNoticeSourceLink($notice, &$name, &$url, &$title)
336 if ($notice->source == 'ostatus') {
337 $bits = parse_url($notice->uri);
338 $domain = $bits['host'];
342 $title = sprintf(_m("Sent from %s via OStatus"), $domain);
348 * Send incoming PuSH feeds for OStatus endpoints in for processing.
350 * @param FeedSub $feedsub
351 * @param DOMDocument $feed
352 * @return mixed hook return code
354 function onStartFeedSubReceive($feedsub, $feed)
356 $oprofile = Ostatus_profile::staticGet('feeduri', $feedsub->uri);
358 $oprofile->processFeed($feed);
360 common_log(LOG_DEBUG, "No ostatus profile for incoming feed $feedsub->uri");
364 function onEndSubscribe($subscriber, $other)
366 $user = User::staticGet('id', $subscriber->id);
372 $oprofile = Ostatus_profile::staticGet('profile_id', $other->id);
374 if (empty($oprofile)) {
378 $act = new Activity();
380 $act->verb = ActivityVerb::FOLLOW;
382 $act->id = TagURI::mint('follow:%d:%d:%s',
385 common_date_iso8601(time()));
388 $act->title = _("Follow");
389 $act->content = sprintf(_("%s is now following %s."),
390 $subscriber->getBestName(),
391 $other->getBestName());
393 $act->actor = ActivityObject::fromProfile($subscriber);
394 $act->object = ActivityObject::fromProfile($other);
396 $oprofile->notifyActivity($act);
402 * Notify remote users when their notices get favorited.
404 * @param Profile or User $profile of local user doing the faving
405 * @param Notice $notice being favored
406 * @return hook return value
409 function onEndFavorNotice(Profile $profile, Notice $notice)
411 $user = User::staticGet('id', $profile->id);
417 $oprofile = Ostatus_profile::staticGet('profile_id', $notice->profile_id);
419 if (empty($oprofile)) {
423 $act = new Activity();
425 $act->verb = ActivityVerb::FAVORITE;
426 $act->id = TagURI::mint('favor:%d:%d:%s',
429 common_date_iso8601(time()));
432 $act->title = _("Favor");
433 $act->content = sprintf(_("%s marked notice %s as a favorite."),
434 $profile->getBestName(),
437 $act->actor = ActivityObject::fromProfile($profile);
438 $act->object = ActivityObject::fromNotice($notice);
440 $oprofile->notifyActivity($act);
446 * Notify remote users when their notices get de-favorited.
448 * @param Profile $profile Profile person doing the de-faving
449 * @param Notice $notice Notice being favored
451 * @return hook return value
454 function onEndDisfavorNotice(Profile $profile, Notice $notice)
456 $user = User::staticGet('id', $profile->id);
462 $oprofile = Ostatus_profile::staticGet('profile_id', $notice->profile_id);
464 if (empty($oprofile)) {
468 $act = new Activity();
470 $act->verb = ActivityVerb::UNFAVORITE;
471 $act->id = TagURI::mint('disfavor:%d:%d:%s',
474 common_date_iso8601(time()));
476 $act->title = _("Disfavor");
477 $act->content = sprintf(_("%s marked notice %s as no longer a favorite."),
478 $profile->getBestName(),
481 $act->actor = ActivityObject::fromProfile($profile);
482 $act->object = ActivityObject::fromNotice($notice);
484 $oprofile->notifyActivity($act);
489 function onStartGetProfileUri($profile, &$uri)
491 $oprofile = Ostatus_profile::staticGet('profile_id', $profile->id);
492 if (!empty($oprofile)) {
493 $uri = $oprofile->uri;