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')) {
29 set_include_path(get_include_path() . PATH_SEPARATOR . dirname(__FILE__) . '/extlib/');
31 class FeedSubException extends Exception
33 function __construct($msg=null)
35 $type = get_class($this);
37 parent::__construct("$type: $msg");
39 parent::__construct($type);
44 class OStatusPlugin extends Plugin
47 * Hook for RouterInitialized event.
49 * @param Net_URL_Mapper $m path-to-action mapper
50 * @return boolean hook return
52 function onRouterInitialized($m)
55 $m->connect('main/ownerxrd',
56 array('action' => 'ownerxrd'));
57 $m->connect('main/ostatus',
58 array('action' => 'ostatusinit'));
59 $m->connect('main/ostatustag',
60 array('action' => 'ostatustag'));
61 $m->connect('main/ostatustag?nickname=:nickname',
62 array('action' => 'ostatustag'), array('nickname' => '[A-Za-z0-9_-]+'));
63 $m->connect('main/ostatus?nickname=:nickname',
64 array('action' => 'ostatusinit'), array('nickname' => '[A-Za-z0-9_-]+'));
65 $m->connect('main/ostatus?group=:group',
66 array('action' => 'ostatusinit'), array('group' => '[A-Za-z0-9_-]+'));
67 $m->connect('main/ostatus?peopletag=:peopletag&tagger=:tagger',
68 array('action' => 'ostatusinit'), array('tagger' => '[A-Za-z0-9_-]+',
69 'peopletag' => '[A-Za-z0-9_-]+'));
71 // Remote subscription actions
72 $m->connect('main/ostatussub',
73 array('action' => 'ostatussub'));
74 $m->connect('main/ostatusgroup',
75 array('action' => 'ostatusgroup'));
76 $m->connect('main/ostatuspeopletag',
77 array('action' => 'ostatuspeopletag'));
80 $m->connect('main/push/hub', array('action' => 'pushhub'));
82 $m->connect('main/push/callback/:feed',
83 array('action' => 'pushcallback'),
84 array('feed' => '[0-9]+'));
87 $m->connect('main/salmon/user/:id',
88 array('action' => 'usersalmon'),
89 array('id' => '[0-9]+'));
90 $m->connect('main/salmon/group/:id',
91 array('action' => 'groupsalmon'),
92 array('id' => '[0-9]+'));
93 $m->connect('main/salmon/peopletag/:id',
94 array('action' => 'peopletagsalmon'),
95 array('id' => '[0-9]+'));
100 * Set up queue handlers for outgoing hub pushes
101 * @param QueueManager $qm
102 * @return boolean hook return
104 function onEndInitializeQueueManager(QueueManager $qm)
106 // Prepare outgoing distributions after notice save.
107 $qm->connect('ostatus', 'OStatusQueueHandler');
109 // Outgoing from our internal PuSH hub
110 $qm->connect('hubconf', 'HubConfQueueHandler');
111 $qm->connect('hubprep', 'HubPrepQueueHandler');
113 $qm->connect('hubout', 'HubOutQueueHandler');
115 // Outgoing Salmon replies (when we don't need a return value)
116 $qm->connect('salmon', 'SalmonQueueHandler');
118 // Incoming from a foreign PuSH hub
119 $qm->connect('pushin', 'PushInQueueHandler');
124 * Put saved notices into the queue for pubsub distribution.
126 function onStartEnqueueNotice($notice, &$transports)
128 if ($notice->isLocal()) {
129 if ($notice->inScope(null)) {
130 // put our transport first, in case there's any conflict (like OMB)
131 array_unshift($transports, 'ostatus');
132 $this->log(LOG_INFO, "Notice {$notice->id} queued for OStatus processing");
134 // FIXME: we don't do privacy-controlled OStatus updates yet.
135 // once that happens, finer grain of control here.
136 $this->log(LOG_NOTICE, "Not queueing notice {$notice->id} for OStatus because of privacy; scope = {$notice->scope}");
139 $this->log(LOG_NOTICE, "Not queueing notice {$notice->id} for OStatus because it's not local.");
145 * Add a link header for LRDD Discovery
147 function onStartShowHTML($action)
149 if ($action instanceof ShowstreamAction) {
150 $acct = 'acct:'. $action->profile->nickname .'@'. common_config('site', 'server');
151 $url = common_local_url('userxrd');
152 $url.= '?uri='. $acct;
154 header('Link: <'.$url.'>; rel="'. Discovery::LRDD_REL.'"; type="application/xrd+xml"');
159 * Set up a PuSH hub link to our internal link for canonical timeline
160 * Atom feeds for users and groups.
162 function onStartApiAtom($feed)
166 if ($feed instanceof AtomUserNoticeFeed) {
167 $salmonAction = 'usersalmon';
168 $user = $feed->getUser();
170 $profile = $user->getProfile();
171 } else if ($feed instanceof AtomGroupNoticeFeed) {
172 $salmonAction = 'groupsalmon';
173 $group = $feed->getGroup();
175 } else if ($feed instanceof AtomListNoticeFeed) {
176 $salmonAction = 'peopletagsalmon';
177 $peopletag = $feed->getList();
178 $id = $peopletag->id;
184 $hub = common_config('ostatus', 'hub');
186 // Updates will be handled through our internal PuSH hub.
187 $hub = common_local_url('pushhub');
189 $feed->addLink($hub, array('rel' => 'hub'));
191 // Also, we'll add in the salmon link
192 $salmon = common_local_url($salmonAction, array('id' => $id));
193 $feed->addLink($salmon, array('rel' => Salmon::REL_SALMON));
195 // XXX: these are deprecated
196 $feed->addLink($salmon, array('rel' => Salmon::NS_REPLIES));
197 $feed->addLink($salmon, array('rel' => Salmon::NS_MENTIONS));
204 * Automatically load the actions and libraries used by the plugin
206 * @param Class $cls the class
208 * @return boolean hook return
211 function onAutoload($cls)
213 $base = dirname(__FILE__);
214 $lower = strtolower($cls);
215 $map = array('activityverb' => 'activity',
216 'activityobject' => 'activity',
217 'activityutils' => 'activity');
218 if (isset($map[$lower])) {
219 $lower = $map[$lower];
221 $files = array("$base/classes/$cls.php",
222 "$base/lib/$lower.php");
223 if (substr($lower, -6) == 'action') {
224 $files[] = "$base/actions/" . substr($lower, 0, -6) . ".php";
226 foreach ($files as $file) {
227 if (file_exists($file)) {
236 * Add in an OStatus subscribe button
238 function onStartProfileRemoteSubscribe($output, $profile)
240 $this->onStartProfileListItemActionElements($output, $profile);
244 function onStartGroupSubscribe($widget, $group)
246 $cur = common_current_user();
249 $output->elementStart('li', 'entity_subscribe');
250 $profile = $peopletag->getTagger();
251 $url = common_local_url('ostatusinit',
252 array('group' => $group->nickname));
253 $widget->out->element('a', array('href' => $url,
254 'class' => 'entity_remote_subscribe'),
255 // TRANS: Link to subscribe to a remote entity.
258 $output->elementEnd('li');
265 function onStartSubscribePeopletagForm($output, $peopletag)
267 $cur = common_current_user();
270 $output->elementStart('li', 'entity_subscribe');
271 $profile = $peopletag->getTagger();
272 $url = common_local_url('ostatusinit',
273 array('tagger' => $profile->nickname, 'peopletag' => $peopletag->tag));
274 $output->element('a', array('href' => $url,
275 'class' => 'entity_remote_subscribe'),
276 // TRANS: Link to subscribe to a remote entity.
279 $output->elementEnd('li');
286 function onStartShowTagProfileForm($action, $profile)
288 $action->elementStart('form', array('method' => 'post',
289 'id' => 'form_tag_user',
290 'class' => 'form_settings',
291 'name' => 'tagprofile',
292 'action' => common_local_url('tagprofile', array('id' => @$profile->id))));
294 $action->elementStart('fieldset');
295 // TRANS: Fieldset legend.
296 $action->element('legend', null, _m('Tag remote profile'));
297 $action->hidden('token', common_session_token());
299 $user = common_current_user();
301 $action->elementStart('ul', 'form_data');
302 $action->elementStart('li');
304 // TRANS: Field label.
305 $action->input('uri', _m('LABEL','Remote profile'), $action->trimmed('uri'),
306 // TRANS: Field title.
307 _m('OStatus user\'s address, like nickname@example.com or http://example.net/nickname.'));
308 $action->elementEnd('li');
309 $action->elementEnd('ul');
310 // TRANS: Button text to fetch remote profile.
311 $action->submit('fetch', _m('BUTTON','Fetch'));
312 $action->elementEnd('fieldset');
313 $action->elementEnd('form');
316 function onStartTagProfileAction($action, $profile)
319 $uri = $action->trimmed('uri');
321 if (!$profile && $uri) {
323 if (Validate::email($uri)) {
324 $oprofile = Ostatus_profile::ensureWebfinger($uri);
325 } else if (Validate::uri($uri)) {
326 $oprofile = Ostatus_profile::ensureProfileURL($uri);
328 // TRANS: Exception in OStatus when invalid URI was entered.
329 throw new Exception(_m('Invalid URI.'));
332 // redirect to the new profile.
333 common_redirect(common_local_url('tagprofile', array('id' => $oprofile->profile_id)), 303);
336 } catch (Exception $e) {
337 // TRANS: Error message in OStatus plugin. Do not translate the domain names example.com
338 // TRANS: and example.net, as these are official standard domain names for use in examples.
339 $err = _m("Sorry, we could not reach that address. Please make sure that the OStatus address is like nickname@example.com or http://example.net/nickname.");
342 $action->showForm($err);
349 * If the field being looked for is URI look for the profile
351 function onStartProfileCompletionSearch($action, $profile, $search_engine) {
352 if ($action->field == 'uri') {
354 $profile->joinAdd($user);
355 $profile->whereAdd('uri LIKE "%' . $profile->escape($q) . '%"');
358 if ($profile->N == 0) {
360 if (Validate::email($q)) {
361 $oprofile = Ostatus_profile::ensureWebfinger($q);
362 } else if (Validate::uri($q)) {
363 $oprofile = Ostatus_profile::ensureProfileURL($q);
365 // TRANS: Exception in OStatus when invalid URI was entered.
366 throw new Exception(_m('Invalid URI.'));
368 return $this->filter(array($oprofile->localProfile()));
370 } catch (Exception $e) {
371 // TRANS: Error message in OStatus plugin. Do not translate the domain names example.com
372 // TRANS: and example.net, as these are official standard domain names for use in examples.
373 $this->msg = _m("Sorry, we could not reach that address. Please make sure that the OStatus address is like nickname@example.com or http://example.net/nickname.");
383 * Find any explicit remote mentions. Accepted forms:
384 * Webfinger: @user@example.com
385 * Profile link: @example.com/mublog/user
386 * @param Profile $sender (os user?)
387 * @param string $text input markup text
388 * @param array &$mention in/out param: set of found mentions
389 * @return boolean hook return value
391 function onEndFindMentions($sender, $text, &$mentions)
395 // Webfinger matches: @user@example.com
396 if (preg_match_all('!(?:^|\s+)@((?:\w+\.)*\w+@(?:\w+\-?\w+\.)*\w+(?:\w+\-\w+)*\.\w+)!',
399 PREG_OFFSET_CAPTURE)) {
400 foreach ($wmatches[1] as $wmatch) {
401 list($target, $pos) = $wmatch;
402 $this->log(LOG_INFO, "Checking webfinger '$target'");
404 $oprofile = Ostatus_profile::ensureWebfinger($target);
405 if ($oprofile && !$oprofile->isGroup()) {
406 $profile = $oprofile->localProfile();
407 $matches[$pos] = array('mentioned' => array($profile),
410 'url' => $profile->profileurl);
412 } catch (Exception $e) {
413 $this->log(LOG_ERR, "Webfinger check failed: " . $e->getMessage());
418 // Profile matches: @example.com/mublog/user
419 if (preg_match_all('!(?:^|\s+)@((?:\w+\.)*\w+(?:\w+\-\w+)*\.\w+(?:/\w+)+)!',
422 PREG_OFFSET_CAPTURE)) {
423 foreach ($wmatches[1] as $wmatch) {
424 list($target, $pos) = $wmatch;
425 $schemes = array('http', 'https');
426 foreach ($schemes as $scheme) {
427 $url = "$scheme://$target";
428 $this->log(LOG_INFO, "Checking profile address '$url'");
430 $oprofile = Ostatus_profile::ensureProfileURL($url);
431 if ($oprofile && !$oprofile->isGroup()) {
432 $profile = $oprofile->localProfile();
433 $matches[$pos] = array('mentioned' => array($profile),
436 'url' => $profile->profileurl);
439 } catch (Exception $e) {
440 $this->log(LOG_ERR, "Profile check failed: " . $e->getMessage());
446 foreach ($mentions as $i => $other) {
447 // If we share a common prefix with a local user, override it!
448 $pos = $other['position'];
449 if (isset($matches[$pos])) {
450 $mentions[$i] = $matches[$pos];
451 unset($matches[$pos]);
454 foreach ($matches as $mention) {
455 $mentions[] = $mention;
462 * Allow remote profile references to be used in commands:
463 * sub update@status.net
464 * whois evan@identi.ca
465 * reply http://identi.ca/evan hey what's up
467 * @param Command $command
469 * @param Profile &$profile
470 * @return hook return code
472 function onStartCommandGetProfile($command, $arg, &$profile)
474 $oprofile = $this->pullRemoteProfile($arg);
475 if ($oprofile && !$oprofile->isGroup()) {
476 $profile = $oprofile->localProfile();
484 * Allow remote group references to be used in commands:
485 * join group+statusnet@identi.ca
486 * join http://identi.ca/group/statusnet
487 * drop identi.ca/group/statusnet
489 * @param Command $command
491 * @param User_group &$group
492 * @return hook return code
494 function onStartCommandGetGroup($command, $arg, &$group)
496 $oprofile = $this->pullRemoteProfile($arg);
497 if ($oprofile && $oprofile->isGroup()) {
498 $group = $oprofile->localGroup();
505 protected function pullRemoteProfile($arg)
508 if (preg_match('!^((?:\w+\.)*\w+@(?:\w+\.)*\w+(?:\w+\-\w+)*\.\w+)$!', $arg)) {
511 return Ostatus_profile::ensureWebfinger($arg);
512 } catch (Exception $e) {
513 common_log(LOG_ERR, 'Webfinger lookup failed for ' .
514 $arg . ': ' . $e->getMessage());
518 // Look for profile URLs, with or without scheme:
520 if (preg_match('!^https?://((?:\w+\.)*\w+(?:\w+\-\w+)*\.\w+(?:/\w+)+)$!', $arg)) {
523 if (preg_match('!^((?:\w+\.)*\w+(?:\w+\-\w+)*\.\w+(?:/\w+)+)$!', $arg)) {
524 $schemes = array('http', 'https');
525 foreach ($schemes as $scheme) {
526 $urls[] = "$scheme://$arg";
530 foreach ($urls as $url) {
532 return Ostatus_profile::ensureProfileURL($url);
533 } catch (Exception $e) {
534 common_log(LOG_ERR, 'Profile lookup failed for ' .
535 $arg . ': ' . $e->getMessage());
542 * Make sure necessary tables are filled out.
544 function onCheckSchema() {
545 $schema = Schema::get();
546 $schema->ensureTable('ostatus_profile', Ostatus_profile::schemaDef());
547 $schema->ensureTable('ostatus_source', Ostatus_source::schemaDef());
548 $schema->ensureTable('feedsub', FeedSub::schemaDef());
549 $schema->ensureTable('hubsub', HubSub::schemaDef());
550 $schema->ensureTable('magicsig', Magicsig::schemaDef());
554 function onEndShowStatusNetStyles($action) {
555 $action->cssLink($this->path('theme/base/css/ostatus.css'));
559 function onEndShowStatusNetScripts($action) {
560 $action->script($this->path('js/ostatus.js'));
565 * Override the "from ostatus" bit in notice lists to link to the
566 * original post and show the domain it came from.
568 * @param Notice in $notice
569 * @param string out &$name
570 * @param string out &$url
571 * @param string out &$title
572 * @return mixed hook return code
574 function onStartNoticeSourceLink($notice, &$name, &$url, &$title)
576 if ($notice->source == 'ostatus') {
578 $bits = parse_url($notice->url);
579 $domain = $bits['host'];
580 if (substr($domain, 0, 4) == 'www.') {
581 $name = substr($domain, 4);
587 // TRANS: Title. %s is a domain name.
588 $title = sprintf(_m('Sent from %s via OStatus'), $domain);
596 * Send incoming PuSH feeds for OStatus endpoints in for processing.
598 * @param FeedSub $feedsub
599 * @param DOMDocument $feed
600 * @return mixed hook return code
602 function onStartFeedSubReceive($feedsub, $feed)
604 $oprofile = Ostatus_profile::staticGet('feeduri', $feedsub->uri);
606 $oprofile->processFeed($feed, 'push');
608 common_log(LOG_DEBUG, "No ostatus profile for incoming feed $feedsub->uri");
613 * Tell the FeedSub infrastructure whether we have any active OStatus
614 * usage for the feed; if not it'll be able to garbage-collect the
617 * @param FeedSub $feedsub
618 * @param integer $count in/out
619 * @return mixed hook return code
621 function onFeedSubSubscriberCount($feedsub, &$count)
623 $oprofile = Ostatus_profile::staticGet('feeduri', $feedsub->uri);
625 $count += $oprofile->subscriberCount();
631 * When about to subscribe to a remote user, start a server-to-server
632 * PuSH subscription if needed. If we can't establish that, abort.
634 * @fixme If something else aborts later, we could end up with a stray
635 * PuSH subscription. This is relatively harmless, though.
637 * @param Profile $subscriber
638 * @param Profile $other
640 * @return hook return code
644 function onStartSubscribe($subscriber, $other)
646 $user = User::staticGet('id', $subscriber->id);
652 $oprofile = Ostatus_profile::staticGet('profile_id', $other->id);
654 if (empty($oprofile)) {
658 if (!$oprofile->subscribe()) {
659 // TRANS: Exception thrown when setup of remote subscription fails.
660 throw new Exception(_m('Could not set up remote subscription.'));
665 * Having established a remote subscription, send a notification to the
666 * remote OStatus profile's endpoint.
668 * @param Profile $subscriber
669 * @param Profile $other
671 * @return hook return code
675 function onEndSubscribe($subscriber, $other)
677 $user = User::staticGet('id', $subscriber->id);
683 $oprofile = Ostatus_profile::staticGet('profile_id', $other->id);
685 if (empty($oprofile)) {
689 $sub = Subscription::pkeyGet(array('subscriber' => $subscriber->id,
690 'subscribed' => $other->id));
692 $act = $sub->asActivity();
694 $oprofile->notifyActivity($act, $subscriber);
700 * Notify remote server and garbage collect unused feeds on unsubscribe.
701 * @todo FIXME: Send these operations to background queues
704 * @param Profile $other
705 * @return hook return value
707 function onEndUnsubscribe($profile, $other)
709 $user = User::staticGet('id', $profile->id);
715 $oprofile = Ostatus_profile::staticGet('profile_id', $other->id);
717 if (empty($oprofile)) {
721 // Drop the PuSH subscription if there are no other subscribers.
722 $oprofile->garbageCollect();
724 $act = new Activity();
726 $act->verb = ActivityVerb::UNFOLLOW;
728 $act->id = TagURI::mint('unfollow:%d:%d:%s',
731 common_date_iso8601(time()));
734 // TRANS: Title for unfollowing a remote profile.
735 $act->title = _m('TITLE','Unfollow');
736 // TRANS: Success message for unsubscribe from user attempt through OStatus.
737 // TRANS: %1$s is the unsubscriber's name, %2$s is the unsubscribed user's name.
738 $act->content = sprintf(_m('%1$s stopped following %2$s.'),
739 $profile->getBestName(),
740 $other->getBestName());
742 $act->actor = ActivityObject::fromProfile($profile);
743 $act->object = ActivityObject::fromProfile($other);
745 $oprofile->notifyActivity($act, $profile);
751 * When one of our local users tries to join a remote group,
752 * notify the remote server. If the notification is rejected,
755 * @param User_group $group
758 * @return mixed hook return value
760 function onStartJoinGroup($group, $user)
762 $oprofile = Ostatus_profile::staticGet('group_id', $group->id);
764 if (!$oprofile->subscribe()) {
765 // TRANS: Exception thrown when setup of remote group membership fails.
766 throw new Exception(_m('Could not set up remote group membership.'));
769 // NOTE: we don't use Group_member::asActivity() since that record
770 // has not yet been created.
772 $member = Profile::staticGet($user->id);
774 $act = new Activity();
775 $act->id = TagURI::mint('join:%d:%d:%s',
778 common_date_iso8601(time()));
780 $act->actor = ActivityObject::fromProfile($member);
781 $act->verb = ActivityVerb::JOIN;
782 $act->object = $oprofile->asActivityObject();
785 // TRANS: Title for joining a remote groep.
786 $act->title = _m('TITLE','Join');
787 // TRANS: Success message for subscribe to group attempt through OStatus.
788 // TRANS: %1$s is the member name, %2$s is the subscribed group's name.
789 $act->content = sprintf(_m('%1$s has joined group %2$s.'),
790 $member->getBestName(),
791 $oprofile->getBestName());
793 if ($oprofile->notifyActivity($act, $member)) {
796 $oprofile->garbageCollect();
797 // TRANS: Exception thrown when joining a remote group fails.
798 throw new Exception(_m('Failed joining remote group.'));
804 * When one of our local users leaves a remote group, notify the remote
807 * @fixme Might be good to schedule a resend of the leave notification
808 * if it failed due to a transitory error. We've canceled the local
809 * membership already anyway, but if the remote server comes back up
810 * it'll be left with a stray membership record.
812 * @param User_group $group
813 * @param Profile $user
815 * @return mixed hook return value
817 function onEndLeaveGroup($group, $user)
819 $oprofile = Ostatus_profile::staticGet('group_id', $group->id);
821 // Drop the PuSH subscription if there are no other subscribers.
822 $oprofile->garbageCollect();
824 $member = Profile::staticGet($user->id);
826 $act = new Activity();
827 $act->id = TagURI::mint('leave:%d:%d:%s',
830 common_date_iso8601(time()));
832 $act->actor = ActivityObject::fromProfile($member);
833 $act->verb = ActivityVerb::LEAVE;
834 $act->object = $oprofile->asActivityObject();
837 // TRANS: Title for leaving a remote group.
838 $act->title = _m('TITLE','Leave');
839 // TRANS: Success message for unsubscribe from group attempt through OStatus.
840 // TRANS: %1$s is the member name, %2$s is the unsubscribed group's name.
841 $act->content = sprintf(_m('%1$s has left group %2$s.'),
842 $member->getBestName(),
843 $oprofile->getBestName());
845 $oprofile->notifyActivity($act, $member);
850 * When one of our local users tries to subscribe to a remote peopletag,
851 * notify the remote server. If the notification is rejected,
852 * deny the subscription.
854 * @param Profile_list $peopletag
857 * @return mixed hook return value
860 function onStartSubscribePeopletag($peopletag, $user)
862 $oprofile = Ostatus_profile::staticGet('peopletag_id', $peopletag->id);
864 if (!$oprofile->subscribe()) {
865 // TRANS: Exception thrown when setup of remote list subscription fails.
866 throw new Exception(_m('Could not set up remote list subscription.'));
869 $sub = $user->getProfile();
870 $tagger = Profile::staticGet($peopletag->tagger);
872 $act = new Activity();
873 $act->id = TagURI::mint('subscribe_peopletag:%d:%d:%s',
876 common_date_iso8601(time()));
878 $act->actor = ActivityObject::fromProfile($sub);
879 $act->verb = ActivityVerb::FOLLOW;
880 $act->object = $oprofile->asActivityObject();
883 // TRANS: Title for following a remote list.
884 $act->title = _m('TITLE','Follow list');
885 // TRANS: Success message for remote list follow through OStatus.
886 // TRANS: %1$s is the subscriber name, %2$s is the list, %3$s is the tagger's name.
887 $act->content = sprintf(_m('%1$s is now following people listed in %2$s by %3$s.'),
889 $oprofile->getBestName(),
890 $tagger->getBestName());
892 if ($oprofile->notifyActivity($act, $sub)) {
895 $oprofile->garbageCollect();
896 // TRANS: Exception thrown when subscription to remote list fails.
897 throw new Exception(_m('Failed subscribing to remote list.'));
903 * When one of our local users unsubscribes to a remote peopletag, notify the remote
906 * @param Profile_list $peopletag
909 * @return mixed hook return value
912 function onEndUnsubscribePeopletag($peopletag, $user)
914 $oprofile = Ostatus_profile::staticGet('peopletag_id', $peopletag->id);
916 // Drop the PuSH subscription if there are no other subscribers.
917 $oprofile->garbageCollect();
919 $sub = Profile::staticGet($user->id);
920 $tagger = Profile::staticGet($peopletag->tagger);
922 $act = new Activity();
923 $act->id = TagURI::mint('unsubscribe_peopletag:%d:%d:%s',
926 common_date_iso8601(time()));
928 $act->actor = ActivityObject::fromProfile($member);
929 $act->verb = ActivityVerb::UNFOLLOW;
930 $act->object = $oprofile->asActivityObject();
933 // TRANS: Title for unfollowing a remote list.
934 $act->title = _m('Unfollow list');
935 // TRANS: Success message for remote list unfollow through OStatus.
936 // TRANS: %1$s is the subscriber name, %2$s is the list, %3$s is the tagger's name.
937 $act->content = sprintf(_m('%1$s stopped following the list %2$s by %3$s.'),
939 $oprofile->getBestName(),
940 $tagger->getBestName());
942 $oprofile->notifyActivity($act, $user);
947 * Notify remote users when their notices get favorited.
949 * @param Profile or User $profile of local user doing the faving
950 * @param Notice $notice being favored
951 * @return hook return value
953 function onEndFavorNotice(Profile $profile, Notice $notice)
955 $user = User::staticGet('id', $profile->id);
961 $oprofile = Ostatus_profile::staticGet('profile_id', $notice->profile_id);
963 if (empty($oprofile)) {
967 $fav = Fave::pkeyGet(array('user_id' => $user->id,
968 'notice_id' => $notice->id));
975 $act = $fav->asActivity();
977 $oprofile->notifyActivity($act, $profile);
983 * Notify remote user it has got a new people tag
984 * - tag verb is queued
985 * - the subscription is done immediately if not present
987 * @param Profile_tag $ptag the people tag that was created
988 * @return hook return value
990 function onEndTagProfile($ptag)
992 $oprofile = Ostatus_profile::staticGet('profile_id', $ptag->tagged);
994 if (empty($oprofile)) {
998 $plist = $ptag->getMeta();
999 if ($plist->private) {
1003 $act = new Activity();
1005 $tagger = $plist->getTagger();
1006 $tagged = Profile::staticGet('id', $ptag->tagged);
1008 $act->verb = ActivityVerb::TAG;
1009 $act->id = TagURI::mint('tag_profile:%d:%d:%s',
1010 $plist->tagger, $plist->id,
1011 common_date_iso8601(time()));
1012 $act->time = time();
1013 // TRANS: Title for listing a remote profile.
1014 $act->title = _m('TITLE','List');
1015 // TRANS: Success message for remote list addition through OStatus.
1016 // TRANS: %1$s is the list creator's name, %2$s is the added list member, %3$s is the list name.
1017 $act->content = sprintf(_m('%1$s listed %2$s in the list %3$s.'),
1018 $tagger->getBestName(),
1019 $tagged->getBestName(),
1020 $plist->getBestName());
1022 $act->actor = ActivityObject::fromProfile($tagger);
1023 $act->objects = array(ActivityObject::fromProfile($tagged));
1024 $act->target = ActivityObject::fromPeopletag($plist);
1026 $oprofile->notifyDeferred($act, $tagger);
1028 // initiate a PuSH subscription for the person being tagged
1029 if (!$oprofile->subscribe()) {
1030 // TRANS: Exception thrown when subscribing to a remote list fails.
1031 throw new Exception(sprintf(_m('Could not complete subscription to remote '.
1032 'profile\'s feed. List %s could not be saved.'), $ptag->tag));
1039 * Notify remote user that a people tag has been removed
1040 * - untag verb is queued
1041 * - the subscription is undone immediately if not required
1042 * i.e garbageCollect()'d
1044 * @param Profile_tag $ptag the people tag that was deleted
1045 * @return hook return value
1047 function onEndUntagProfile($ptag)
1049 $oprofile = Ostatus_profile::staticGet('profile_id', $ptag->tagged);
1051 if (empty($oprofile)) {
1055 $plist = $ptag->getMeta();
1056 if ($plist->private) {
1060 $act = new Activity();
1062 $tagger = $plist->getTagger();
1063 $tagged = Profile::staticGet('id', $ptag->tagged);
1065 $act->verb = ActivityVerb::UNTAG;
1066 $act->id = TagURI::mint('untag_profile:%d:%d:%s',
1067 $plist->tagger, $plist->id,
1068 common_date_iso8601(time()));
1069 $act->time = time();
1070 // TRANS: Title for unlisting a remote profile.
1071 $act->title = _m('TITLE','Unlist');
1072 // TRANS: Success message for remote list removal through OStatus.
1073 // TRANS: %1$s is the list creator's name, %2$s is the removed list member, %3$s is the list name.
1074 $act->content = sprintf(_m('%1$s removed %2$s from the list %3$s.'),
1075 $tagger->getBestName(),
1076 $tagged->getBestName(),
1077 $plist->getBestName());
1079 $act->actor = ActivityObject::fromProfile($tagger);
1080 $act->objects = array(ActivityObject::fromProfile($tagged));
1081 $act->target = ActivityObject::fromPeopletag($plist);
1083 $oprofile->notifyDeferred($act, $tagger);
1085 // unsubscribe to PuSH feed if no more required
1086 $oprofile->garbageCollect();
1092 * Notify remote users when their notices get de-favorited.
1094 * @param Profile $profile Profile person doing the de-faving
1095 * @param Notice $notice Notice being favored
1097 * @return hook return value
1099 function onEndDisfavorNotice(Profile $profile, Notice $notice)
1101 $user = User::staticGet('id', $profile->id);
1107 $oprofile = Ostatus_profile::staticGet('profile_id', $notice->profile_id);
1109 if (empty($oprofile)) {
1113 $act = new Activity();
1115 $act->verb = ActivityVerb::UNFAVORITE;
1116 $act->id = TagURI::mint('disfavor:%d:%d:%s',
1119 common_date_iso8601(time()));
1120 $act->time = time();
1121 // TRANS: Title for unliking a remote notice.
1122 $act->title = _m('Unlike');
1123 // TRANS: Success message for remove a favorite notice through OStatus.
1124 // TRANS: %1$s is the unfavoring user's name, %2$s is URI to the no longer favored notice.
1125 $act->content = sprintf(_m('%1$s no longer likes %2$s.'),
1126 $profile->getBestName(),
1129 $act->actor = ActivityObject::fromProfile($profile);
1130 $act->object = ActivityObject::fromNotice($notice);
1132 $oprofile->notifyActivity($act, $profile);
1137 function onStartGetProfileUri($profile, &$uri)
1139 $oprofile = Ostatus_profile::staticGet('profile_id', $profile->id);
1140 if (!empty($oprofile)) {
1141 $uri = $oprofile->uri;
1147 function onStartUserGroupHomeUrl($group, &$url)
1149 return $this->onStartUserGroupPermalink($group, $url);
1152 function onStartUserGroupPermalink($group, &$url)
1154 $oprofile = Ostatus_profile::staticGet('group_id', $group->id);
1156 // @fixme this should probably be in the user_group table
1157 // @fixme this uri not guaranteed to be a profile page
1158 $url = $oprofile->uri;
1163 function onStartShowSubscriptionsContent($action)
1165 $this->showEntityRemoteSubscribe($action);
1170 function onStartShowUserGroupsContent($action)
1172 $this->showEntityRemoteSubscribe($action, 'ostatusgroup');
1177 function onEndShowSubscriptionsMiniList($action)
1179 $this->showEntityRemoteSubscribe($action);
1184 function onEndShowGroupsMiniList($action)
1186 $this->showEntityRemoteSubscribe($action, 'ostatusgroup');
1191 function showEntityRemoteSubscribe($action, $target='ostatussub')
1193 $user = common_current_user();
1194 if ($user && ($user->id == $action->profile->id)) {
1195 $action->elementStart('div', 'entity_actions');
1196 $action->elementStart('p', array('id' => 'entity_remote_subscribe',
1197 'class' => 'entity_subscribe'));
1198 $action->element('a', array('href' => common_local_url($target),
1199 'class' => 'entity_remote_subscribe'),
1200 // TRANS: Link text for link to remote subscribe.
1202 $action->elementEnd('p');
1203 $action->elementEnd('div');
1208 * Ping remote profiles with updates to this profile.
1209 * Salmon pings are queued for background processing.
1211 function onEndBroadcastProfile(Profile $profile)
1213 $user = User::staticGet('id', $profile->id);
1215 // Find foreign accounts I'm subscribed to that support Salmon pings.
1217 // @fixme we could run updates through the PuSH feed too,
1218 // in which case we can skip Salmon pings to folks who
1219 // are also subscribed to me.
1220 $sql = "SELECT * FROM ostatus_profile " .
1221 "WHERE profile_id IN " .
1222 "(SELECT subscribed FROM subscription WHERE subscriber=%d) " .
1224 "(SELECT group_id FROM group_member WHERE profile_id=%d)";
1225 $oprofile = new Ostatus_profile();
1226 $oprofile->query(sprintf($sql, $profile->id, $profile->id));
1228 if ($oprofile->N == 0) {
1229 common_log(LOG_DEBUG, "No OStatus remote subscribees for $profile->nickname");
1233 $act = new Activity();
1235 $act->verb = ActivityVerb::UPDATE_PROFILE;
1236 $act->id = TagURI::mint('update-profile:%d:%s',
1238 common_date_iso8601(time()));
1239 $act->time = time();
1240 // TRANS: Title for activity.
1241 $act->title = _m('Profile update');
1242 // TRANS: Ping text for remote profile update through OStatus.
1243 // TRANS: %s is user that updated their profile.
1244 $act->content = sprintf(_m('%s has updated their profile page.'),
1245 $profile->getBestName());
1247 $act->actor = ActivityObject::fromProfile($profile);
1248 $act->object = $act->actor;
1250 while ($oprofile->fetch()) {
1251 $oprofile->notifyDeferred($act, $profile);
1257 function onStartProfileListItemActionElements($item, $profile=null)
1259 if (!common_logged_in()) {
1261 $profileUser = User::staticGet('id', $item->profile->id);
1263 if (!empty($profileUser)) {
1265 if ($item instanceof Action) {
1267 $profile = $item->profile;
1269 $output = $item->out;
1272 // Add an OStatus subscribe
1273 $output->elementStart('li', 'entity_subscribe');
1274 $url = common_local_url('ostatusinit',
1275 array('nickname' => $profileUser->nickname));
1276 $output->element('a', array('href' => $url,
1277 'class' => 'entity_remote_subscribe'),
1278 // TRANS: Link text for a user to subscribe to an OStatus user.
1280 $output->elementEnd('li');
1282 $output->elementStart('li', 'entity_tag');
1283 $url = common_local_url('ostatustag',
1284 array('nickname' => $profileUser->nickname));
1285 $output->element('a', array('href' => $url,
1286 'class' => 'entity_remote_tag'),
1287 // TRANS: Link text for a user to tag an OStatus user.
1289 $output->elementEnd('li');
1296 function onPluginVersion(&$versions)
1298 $versions[] = array('name' => 'OStatus',
1299 'version' => STATUSNET_VERSION,
1300 'author' => 'Evan Prodromou, James Walker, Brion Vibber, Zach Copley',
1301 'homepage' => 'http://status.net/wiki/Plugin:OStatus',
1302 // TRANS: Plugin description.
1303 'rawdescription' => _m('Follow people across social networks that implement '.
1304 '<a href="http://ostatus.org/">OStatus</a>.'));
1310 * Utility function to check if the given URI is a canonical group profile
1311 * page, and if so return the ID number.
1313 * @param string $url
1314 * @return mixed int or false
1316 public static function localGroupFromUrl($url)
1318 $group = User_group::staticGet('uri', $url);
1320 $local = Local_group::staticGet('group_id', $group->id);
1325 // To find local groups which haven't had their uri fields filled out...
1326 // If the domain has changed since a subscriber got the URI, it'll
1328 $template = common_local_url('groupbyid', array('id' => '31337'));
1329 $template = preg_quote($template, '/');
1330 $template = str_replace('31337', '(\d+)', $template);
1331 if (preg_match("/$template/", $url, $matches)) {
1332 return intval($matches[1]);
1338 public function onStartProfileGetAtomFeed($profile, &$feed)
1340 $oprofile = Ostatus_profile::staticGet('profile_id', $profile->id);
1342 if (empty($oprofile)) {
1346 $feed = $oprofile->feeduri;
1350 function onStartGetProfileFromURI($uri, &$profile)
1352 // Don't want to do Web-based discovery on our own server,
1353 // so we check locally first.
1355 $user = User::staticGet('uri', $uri);
1357 if (!empty($user)) {
1358 $profile = $user->getProfile();
1362 // Now, check remotely
1364 $oprofile = Ostatus_profile::ensureProfileURI($uri);
1366 if (!empty($oprofile)) {
1367 $profile = $oprofile->localProfile();
1371 // Still not a hit, so give up.
1376 function onEndXrdActionLinks(&$xrd, $user)
1378 $xrd->links[] = array('rel' => Discovery::UPDATESFROM,
1379 'href' => common_local_url('ApiTimelineUser',
1380 array('id' => $user->id,
1381 'format' => 'atom')),
1382 'type' => 'application/atom+xml');
1385 $salmon_url = common_local_url('usersalmon',
1386 array('id' => $user->id));
1388 $xrd->links[] = array('rel' => Salmon::REL_SALMON,
1389 'href' => $salmon_url);
1390 // XXX : Deprecated - to be removed.
1391 $xrd->links[] = array('rel' => Salmon::NS_REPLIES,
1392 'href' => $salmon_url);
1394 $xrd->links[] = array('rel' => Salmon::NS_MENTIONS,
1395 'href' => $salmon_url);
1397 // Get this user's keypair
1398 $magickey = Magicsig::staticGet('user_id', $user->id);
1400 // No keypair yet, let's generate one.
1401 $magickey = new Magicsig();
1402 $magickey->generate($user->id);
1405 $xrd->links[] = array('rel' => Magicsig::PUBLICKEYREL,
1406 'href' => 'data:application/magic-public-key,'. $magickey->toString(false));
1408 // TODO - finalize where the redirect should go on the publisher
1409 $url = common_local_url('ostatussub') . '?profile={uri}';
1410 $xrd->links[] = array('rel' => 'http://ostatus.org/schema/1.0/subscribe',
1411 'template' => $url );