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 set_include_path(get_include_path() . PATH_SEPARATOR . dirname(__FILE__) . '/extlib/');
29 class FeedSubException extends Exception
33 class OStatusPlugin extends Plugin
36 * Hook for RouterInitialized event.
38 * @param Net_URL_Mapper $m path-to-action mapper
39 * @return boolean hook return
41 function onRouterInitialized($m)
44 $m->connect('.well-known/host-meta',
45 array('action' => 'hostmeta'));
46 $m->connect('main/xrd',
47 array('action' => 'userxrd'));
48 $m->connect('main/ownerxrd',
49 array('action' => 'ownerxrd'));
50 $m->connect('main/ostatus',
51 array('action' => 'ostatusinit'));
52 $m->connect('main/ostatus?nickname=:nickname',
53 array('action' => 'ostatusinit'), array('nickname' => '[A-Za-z0-9_-]+'));
54 $m->connect('main/ostatus?group=:group',
55 array('action' => 'ostatusinit'), array('group' => '[A-Za-z0-9_-]+'));
56 $m->connect('main/ostatussub',
57 array('action' => 'ostatussub'));
58 $m->connect('main/ostatusgroup',
59 array('action' => 'ostatusgroup'));
62 $m->connect('main/push/hub', array('action' => 'pushhub'));
64 $m->connect('main/push/callback/:feed',
65 array('action' => 'pushcallback'),
66 array('feed' => '[0-9]+'));
69 $m->connect('main/salmon/user/:id',
70 array('action' => 'usersalmon'),
71 array('id' => '[0-9]+'));
72 $m->connect('main/salmon/group/:id',
73 array('action' => 'groupsalmon'),
74 array('id' => '[0-9]+'));
79 * Set up queue handlers for outgoing hub pushes
80 * @param QueueManager $qm
81 * @return boolean hook return
83 function onEndInitializeQueueManager(QueueManager $qm)
85 // Prepare outgoing distributions after notice save.
86 $qm->connect('ostatus', 'OStatusQueueHandler');
88 // Outgoing from our internal PuSH hub
89 $qm->connect('hubconf', 'HubConfQueueHandler');
90 $qm->connect('hubout', 'HubOutQueueHandler');
92 // Outgoing Salmon replies (when we don't need a return value)
93 $qm->connect('salmon', 'SalmonQueueHandler');
95 // Incoming from a foreign PuSH hub
96 $qm->connect('pushin', 'PushInQueueHandler');
101 * Put saved notices into the queue for pubsub distribution.
103 function onStartEnqueueNotice($notice, &$transports)
105 $transports[] = 'ostatus';
110 * Add a link header for LRDD Discovery
112 function onStartShowHTML($action)
114 if ($action instanceof ShowstreamAction) {
115 $acct = 'acct:'. $action->profile->nickname .'@'. common_config('site', 'server');
116 $url = common_local_url('userxrd');
117 $url.= '?uri='. $acct;
119 header('Link: <'.$url.'>; rel="'. Discovery::LRDD_REL.'"; type="application/xrd+xml"');
124 * Set up a PuSH hub link to our internal link for canonical timeline
125 * Atom feeds for users and groups.
127 function onStartApiAtom($feed)
131 if ($feed instanceof AtomUserNoticeFeed) {
132 $salmonAction = 'usersalmon';
133 $user = $feed->getUser();
135 $profile = $user->getProfile();
136 $feed->setActivitySubject($profile->asActivityNoun('subject'));
137 } else if ($feed instanceof AtomGroupNoticeFeed) {
138 $salmonAction = 'groupsalmon';
139 $group = $feed->getGroup();
141 $feed->setActivitySubject($group->asActivitySubject());
147 $hub = common_config('ostatus', 'hub');
149 // Updates will be handled through our internal PuSH hub.
150 $hub = common_local_url('pushhub');
152 $feed->addLink($hub, array('rel' => 'hub'));
154 // Also, we'll add in the salmon link
155 $salmon = common_local_url($salmonAction, array('id' => $id));
156 $feed->addLink($salmon, array('rel' => Salmon::NS_REPLIES));
157 $feed->addLink($salmon, array('rel' => Salmon::NS_MENTIONS));
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 $map = array('activityverb' => 'activity',
176 'activityobject' => 'activity',
177 'activityutils' => 'activity');
178 if (isset($map[$lower])) {
179 $lower = $map[$lower];
181 $files = array("$base/classes/$cls.php",
182 "$base/lib/$lower.php");
183 if (substr($lower, -6) == 'action') {
184 $files[] = "$base/actions/" . substr($lower, 0, -6) . ".php";
186 foreach ($files as $file) {
187 if (file_exists($file)) {
196 * Add in an OStatus subscribe button
198 function onStartProfileRemoteSubscribe($output, $profile)
200 $cur = common_current_user();
203 // Add an OStatus subscribe
204 $output->elementStart('li', 'entity_subscribe');
205 $url = common_local_url('ostatusinit',
206 array('nickname' => $profile->nickname));
207 $output->element('a', array('href' => $url,
208 'class' => 'entity_remote_subscribe'),
211 $output->elementEnd('li');
217 function onStartGroupSubscribe($output, $group)
219 $cur = common_current_user();
222 // Add an OStatus subscribe
223 $url = common_local_url('ostatusinit',
224 array('group' => $group->nickname));
225 $output->element('a', array('href' => $url,
226 'class' => 'entity_remote_subscribe'),
234 * Check if we've got remote replies to send via Salmon.
236 * @fixme push webfinger lookup & sending to a background queue
237 * @fixme also detect short-form name for remote subscribees where not ambiguous
240 function onEndNoticeSave($notice)
245 * Find any explicit remote mentions. Accepted forms:
246 * Webfinger: @user@example.com
247 * Profile link: @example.com/mublog/user
248 * @param Profile $sender (os user?)
249 * @param string $text input markup text
250 * @param array &$mention in/out param: set of found mentions
251 * @return boolean hook return value
254 function onEndFindMentions($sender, $text, &$mentions)
258 // Webfinger matches: @user@example.com
259 if (preg_match_all('!(?:^|\s+)@((?:\w+\.)*\w+@(?:\w+\.)*\w+(?:\w+\-\w+)*\.\w+)!',
262 PREG_OFFSET_CAPTURE)) {
263 foreach ($wmatches[1] as $wmatch) {
264 list($target, $pos) = $wmatch;
265 $this->log(LOG_INFO, "Checking webfinger '$target'");
267 $oprofile = Ostatus_profile::ensureWebfinger($target);
268 if ($oprofile && !$oprofile->isGroup()) {
269 $profile = $oprofile->localProfile();
270 $matches[$pos] = array('mentioned' => array($profile),
273 'url' => $profile->profileurl);
275 } catch (Exception $e) {
276 $this->log(LOG_ERR, "Webfinger check failed: " . $e->getMessage());
281 // Profile matches: @example.com/mublog/user
282 if (preg_match_all('!(?:^|\s+)@((?:\w+\.)*\w+(?:\w+\-\w+)*\.\w+(?:/\w+)+)!',
285 PREG_OFFSET_CAPTURE)) {
286 foreach ($wmatches[1] as $wmatch) {
287 list($target, $pos) = $wmatch;
288 $schemes = array('http', 'https');
289 foreach ($schemes as $scheme) {
290 $url = "$scheme://$target";
291 $this->log(LOG_INFO, "Checking profile address '$url'");
293 $oprofile = Ostatus_profile::ensureProfile($url);
294 if ($oprofile && !$oprofile->isGroup()) {
295 $profile = $oprofile->localProfile();
296 $matches[$pos] = array('mentioned' => array($profile),
299 'url' => $profile->profileurl);
302 } catch (Exception $e) {
303 $this->log(LOG_ERR, "Profile check failed: " . $e->getMessage());
309 foreach ($mentions as $i => $other) {
310 // If we share a common prefix with a local user, override it!
311 $pos = $other['position'];
312 if (isset($matches[$pos])) {
313 $mentions[$i] = $matches[$pos];
314 unset($matches[$pos]);
317 foreach ($matches as $mention) {
318 $mentions[] = $mention;
325 * Allow remote profile references to be used in commands:
326 * sub update@status.net
327 * whois evan@identi.ca
328 * reply http://identi.ca/evan hey what's up
330 * @param Command $command
332 * @param Profile &$profile
333 * @return hook return code
335 function onStartCommandGetProfile($command, $arg, &$profile)
337 $oprofile = $this->pullRemoteProfile($arg);
338 if ($oprofile && !$oprofile->isGroup()) {
339 $profile = $oprofile->localProfile();
347 * Allow remote group references to be used in commands:
348 * join group+statusnet@identi.ca
349 * join http://identi.ca/group/statusnet
350 * drop identi.ca/group/statusnet
352 * @param Command $command
354 * @param User_group &$group
355 * @return hook return code
357 function onStartCommandGetGroup($command, $arg, &$group)
359 $oprofile = $this->pullRemoteProfile($arg);
360 if ($oprofile && $oprofile->isGroup()) {
361 $group = $oprofile->localGroup();
368 protected function pullRemoteProfile($arg)
371 if (preg_match('!^((?:\w+\.)*\w+@(?:\w+\.)*\w+(?:\w+\-\w+)*\.\w+)$!', $arg)) {
374 return Ostatus_profile::ensureWebfinger($arg);
375 } catch (Exception $e) {
376 common_log(LOG_ERR, 'Webfinger lookup failed for ' .
377 $arg . ': ' . $e->getMessage());
381 // Look for profile URLs, with or without scheme:
383 if (preg_match('!^https?://((?:\w+\.)*\w+(?:\w+\-\w+)*\.\w+(?:/\w+)+)$!', $arg)) {
386 if (preg_match('!^((?:\w+\.)*\w+(?:\w+\-\w+)*\.\w+(?:/\w+)+)$!', $arg)) {
387 $schemes = array('http', 'https');
388 foreach ($schemes as $scheme) {
389 $urls[] = "$scheme://$arg";
393 foreach ($urls as $url) {
395 return Ostatus_profile::ensureProfile($url);
396 } catch (Exception $e) {
397 common_log(LOG_ERR, 'Profile lookup failed for ' .
398 $arg . ': ' . $e->getMessage());
405 * Make sure necessary tables are filled out.
407 function onCheckSchema() {
408 $schema = Schema::get();
409 $schema->ensureTable('ostatus_profile', Ostatus_profile::schemaDef());
410 $schema->ensureTable('ostatus_source', Ostatus_source::schemaDef());
411 $schema->ensureTable('feedsub', FeedSub::schemaDef());
412 $schema->ensureTable('hubsub', HubSub::schemaDef());
413 $schema->ensureTable('magicsig', Magicsig::schemaDef());
417 function onEndShowStatusNetStyles($action) {
418 $action->cssLink('plugins/OStatus/theme/base/css/ostatus.css');
422 function onEndShowStatusNetScripts($action) {
423 $action->script('plugins/OStatus/js/ostatus.js');
428 * Override the "from ostatus" bit in notice lists to link to the
429 * original post and show the domain it came from.
431 * @param Notice in $notice
432 * @param string out &$name
433 * @param string out &$url
434 * @param string out &$title
435 * @return mixed hook return code
437 function onStartNoticeSourceLink($notice, &$name, &$url, &$title)
439 if ($notice->source == 'ostatus') {
441 $bits = parse_url($notice->url);
442 $domain = $bits['host'];
443 if (substr($domain, 0, 4) == 'www.') {
444 $name = substr($domain, 4);
450 $title = sprintf(_m("Sent from %s via OStatus"), $domain);
457 * Send incoming PuSH feeds for OStatus endpoints in for processing.
459 * @param FeedSub $feedsub
460 * @param DOMDocument $feed
461 * @return mixed hook return code
463 function onStartFeedSubReceive($feedsub, $feed)
465 $oprofile = Ostatus_profile::staticGet('feeduri', $feedsub->uri);
467 $oprofile->processFeed($feed, 'push');
469 common_log(LOG_DEBUG, "No ostatus profile for incoming feed $feedsub->uri");
474 * When about to subscribe to a remote user, start a server-to-server
475 * PuSH subscription if needed. If we can't establish that, abort.
477 * @fixme If something else aborts later, we could end up with a stray
478 * PuSH subscription. This is relatively harmless, though.
480 * @param Profile $subscriber
481 * @param Profile $other
483 * @return hook return code
487 function onStartSubscribe($subscriber, $other)
489 $user = User::staticGet('id', $subscriber->id);
495 $oprofile = Ostatus_profile::staticGet('profile_id', $other->id);
497 if (empty($oprofile)) {
501 if (!$oprofile->subscribe()) {
502 throw new Exception(_m('Could not set up remote subscription.'));
507 * Having established a remote subscription, send a notification to the
508 * remote OStatus profile's endpoint.
510 * @param Profile $subscriber
511 * @param Profile $other
513 * @return hook return code
517 function onEndSubscribe($subscriber, $other)
519 $user = User::staticGet('id', $subscriber->id);
525 $oprofile = Ostatus_profile::staticGet('profile_id', $other->id);
527 if (empty($oprofile)) {
531 $act = new Activity();
533 $act->verb = ActivityVerb::FOLLOW;
535 $act->id = TagURI::mint('follow:%d:%d:%s',
538 common_date_iso8601(time()));
541 $act->title = _("Follow");
542 $act->content = sprintf(_("%s is now following %s."),
543 $subscriber->getBestName(),
544 $other->getBestName());
546 $act->actor = ActivityObject::fromProfile($subscriber);
547 $act->object = ActivityObject::fromProfile($other);
549 $oprofile->notifyActivity($act, $subscriber);
555 * Notify remote server and garbage collect unused feeds on unsubscribe.
556 * @fixme send these operations to background queues
559 * @param Profile $other
560 * @return hook return value
562 function onEndUnsubscribe($profile, $other)
564 $user = User::staticGet('id', $profile->id);
570 $oprofile = Ostatus_profile::staticGet('profile_id', $other->id);
572 if (empty($oprofile)) {
576 // Drop the PuSH subscription if there are no other subscribers.
577 $oprofile->garbageCollect();
579 $act = new Activity();
581 $act->verb = ActivityVerb::UNFOLLOW;
583 $act->id = TagURI::mint('unfollow:%d:%d:%s',
586 common_date_iso8601(time()));
589 $act->title = _("Unfollow");
590 $act->content = sprintf(_("%s stopped following %s."),
591 $profile->getBestName(),
592 $other->getBestName());
594 $act->actor = ActivityObject::fromProfile($profile);
595 $act->object = ActivityObject::fromProfile($other);
597 $oprofile->notifyActivity($act, $profile);
603 * When one of our local users tries to join a remote group,
604 * notify the remote server. If the notification is rejected,
607 * @param User_group $group
610 * @return mixed hook return value
613 function onStartJoinGroup($group, $user)
615 $oprofile = Ostatus_profile::staticGet('group_id', $group->id);
617 if (!$oprofile->subscribe()) {
618 throw new Exception(_m('Could not set up remote group membership.'));
621 $member = Profile::staticGet($user->id);
623 $act = new Activity();
624 $act->id = TagURI::mint('join:%d:%d:%s',
627 common_date_iso8601(time()));
629 $act->actor = ActivityObject::fromProfile($member);
630 $act->verb = ActivityVerb::JOIN;
631 $act->object = $oprofile->asActivityObject();
634 $act->title = _m("Join");
635 $act->content = sprintf(_m("%s has joined group %s."),
636 $member->getBestName(),
637 $oprofile->getBestName());
639 if ($oprofile->notifyActivity($act, $member)) {
642 $oprofile->garbageCollect();
643 throw new Exception(_m("Failed joining remote group."));
649 * When one of our local users leaves a remote group, notify the remote
652 * @fixme Might be good to schedule a resend of the leave notification
653 * if it failed due to a transitory error. We've canceled the local
654 * membership already anyway, but if the remote server comes back up
655 * it'll be left with a stray membership record.
657 * @param User_group $group
660 * @return mixed hook return value
663 function onEndLeaveGroup($group, $user)
665 $oprofile = Ostatus_profile::staticGet('group_id', $group->id);
667 // Drop the PuSH subscription if there are no other subscribers.
668 $oprofile->garbageCollect();
670 $member = Profile::staticGet($user->id);
672 $act = new Activity();
673 $act->id = TagURI::mint('leave:%d:%d:%s',
676 common_date_iso8601(time()));
678 $act->actor = ActivityObject::fromProfile($member);
679 $act->verb = ActivityVerb::LEAVE;
680 $act->object = $oprofile->asActivityObject();
683 $act->title = _m("Leave");
684 $act->content = sprintf(_m("%s has left group %s."),
685 $member->getBestName(),
686 $oprofile->getBestName());
688 $oprofile->notifyActivity($act, $member);
693 * Notify remote users when their notices get favorited.
695 * @param Profile or User $profile of local user doing the faving
696 * @param Notice $notice being favored
697 * @return hook return value
700 function onEndFavorNotice(Profile $profile, Notice $notice)
702 $user = User::staticGet('id', $profile->id);
708 $oprofile = Ostatus_profile::staticGet('profile_id', $notice->profile_id);
710 if (empty($oprofile)) {
714 $act = new Activity();
716 $act->verb = ActivityVerb::FAVORITE;
717 $act->id = TagURI::mint('favor:%d:%d:%s',
720 common_date_iso8601(time()));
723 $act->title = _("Favor");
724 $act->content = sprintf(_("%s marked notice %s as a favorite."),
725 $profile->getBestName(),
728 $act->actor = ActivityObject::fromProfile($profile);
729 $act->object = ActivityObject::fromNotice($notice);
731 $oprofile->notifyActivity($act, $profile);
737 * Notify remote users when their notices get de-favorited.
739 * @param Profile $profile Profile person doing the de-faving
740 * @param Notice $notice Notice being favored
742 * @return hook return value
745 function onEndDisfavorNotice(Profile $profile, Notice $notice)
747 $user = User::staticGet('id', $profile->id);
753 $oprofile = Ostatus_profile::staticGet('profile_id', $notice->profile_id);
755 if (empty($oprofile)) {
759 $act = new Activity();
761 $act->verb = ActivityVerb::UNFAVORITE;
762 $act->id = TagURI::mint('disfavor:%d:%d:%s',
765 common_date_iso8601(time()));
767 $act->title = _("Disfavor");
768 $act->content = sprintf(_("%s marked notice %s as no longer a favorite."),
769 $profile->getBestName(),
772 $act->actor = ActivityObject::fromProfile($profile);
773 $act->object = ActivityObject::fromNotice($notice);
775 $oprofile->notifyActivity($act, $profile);
780 function onStartGetProfileUri($profile, &$uri)
782 $oprofile = Ostatus_profile::staticGet('profile_id', $profile->id);
783 if (!empty($oprofile)) {
784 $uri = $oprofile->uri;
790 function onStartUserGroupHomeUrl($group, &$url)
792 return $this->onStartUserGroupPermalink($group, $url);
795 function onStartUserGroupPermalink($group, &$url)
797 $oprofile = Ostatus_profile::staticGet('group_id', $group->id);
799 // @fixme this should probably be in the user_group table
800 // @fixme this uri not guaranteed to be a profile page
801 $url = $oprofile->uri;
806 function onStartShowSubscriptionsContent($action)
808 $this->showEntityRemoteSubscribe($action);
813 function onStartShowUserGroupsContent($action)
815 $this->showEntityRemoteSubscribe($action, 'ostatusgroup');
820 function onEndShowSubscriptionsMiniList($action)
822 $this->showEntityRemoteSubscribe($action);
827 function onEndShowGroupsMiniList($action)
829 $this->showEntityRemoteSubscribe($action, 'ostatusgroup');
834 function showEntityRemoteSubscribe($action, $target='ostatussub')
836 $user = common_current_user();
837 if ($user && ($user->id == $action->profile->id)) {
838 $action->elementStart('div', 'entity_actions');
839 $action->elementStart('p', array('id' => 'entity_remote_subscribe',
840 'class' => 'entity_subscribe'));
841 $action->element('a', array('href' => common_local_url($target),
842 'class' => 'entity_remote_subscribe')
844 $action->elementEnd('p');
845 $action->elementEnd('div');
850 * Ping remote profiles with updates to this profile.
851 * Salmon pings are queued for background processing.
853 function onEndBroadcastProfile(Profile $profile)
855 $user = User::staticGet('id', $profile->id);
857 // Find foreign accounts I'm subscribed to that support Salmon pings.
859 // @fixme we could run updates through the PuSH feed too,
860 // in which case we can skip Salmon pings to folks who
861 // are also subscribed to me.
862 $sql = "SELECT * FROM ostatus_profile " .
863 "WHERE profile_id IN " .
864 "(SELECT subscribed FROM subscription WHERE subscriber=%d) " .
866 "(SELECT group_id FROM group_member WHERE profile_id=%d)";
867 $oprofile = new Ostatus_profile();
868 $oprofile->query(sprintf($sql, $profile->id, $profile->id));
870 if ($oprofile->N == 0) {
871 common_log(LOG_DEBUG, "No OStatus remote subscribees for $profile->nickname");
875 $act = new Activity();
877 $act->verb = ActivityVerb::UPDATE_PROFILE;
878 $act->id = TagURI::mint('update-profile:%d:%s',
880 common_date_iso8601(time()));
882 $act->title = _m("Profile update");
883 $act->content = sprintf(_m("%s has updated their profile page."),
884 $profile->getBestName());
886 $act->actor = ActivityObject::fromProfile($profile);
887 $act->object = $act->actor;
889 while ($oprofile->fetch()) {
890 $oprofile->notifyDeferred($act, $profile);
896 function onStartProfileListItemActionElements($item)
898 if (!common_logged_in()) {
900 $profileUser = User::staticGet('id', $item->profile->id);
902 if (!empty($profileUser)) {
904 $output = $item->out;
906 // Add an OStatus subscribe
907 $output->elementStart('li', 'entity_subscribe');
908 $url = common_local_url('ostatusinit',
909 array('nickname' => $profileUser->nickname));
910 $output->element('a', array('href' => $url,
911 'class' => 'entity_remote_subscribe'),
913 $output->elementEnd('li');
920 function onPluginVersion(&$versions)
922 $versions[] = array('name' => 'OStatus',
923 'version' => STATUSNET_VERSION,
924 'author' => 'Evan Prodromou, James Walker, Brion Vibber, Zach Copley',
925 'homepage' => 'http://status.net/wiki/Plugin:OStatus',
927 _m('Follow people across social networks that implement '.
928 '<a href="http://ostatus.org/">OStatus</a>.'));
934 * Utility function to check if the given URL is a canonical group profile
935 * page, and if so return the ID number.
938 * @return mixed int or false
940 public static function localGroupFromUrl($url)
942 $template = common_local_url('groupbyid', array('id' => '31337'));
943 $template = preg_quote($template, '/');
944 $template = str_replace('31337', '(\d+)', $template);
945 if (preg_match("/$template/", $url, $matches)) {
946 return intval($matches[1]);
952 * Utility function to check if the given URL is a canonical user profile
953 * page, and if so return the ID number.
956 * @return mixed int or false
958 public static function localProfileFromUrl($url)
960 $template = common_local_url('userbyid', array('id' => '31337'));
961 $template = preg_quote($template, '/');
962 $template = str_replace('31337', '(\d+)', $template);
963 if (preg_match("/$template/", $url, $matches)) {
964 return intval($matches[1]);