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 * OStatusPlugin implementation for GNU Social
23 * Depends on: WebFinger plugin
25 * @package OStatusPlugin
26 * @maintainer Brion Vibber <brion@status.net>
29 if (!defined('GNUSOCIAL')) { exit(1); }
31 class OStatusPlugin extends Plugin
34 * Hook for RouterInitialized event.
36 * @param URLMapper $m path-to-action mapper
37 * @return boolean hook return
39 public function onRouterInitialized(URLMapper $m)
42 $m->connect('main/ostatustag',
43 array('action' => 'ostatustag'));
44 $m->connect('main/ostatustag?nickname=:nickname',
45 array('action' => 'ostatustag'), array('nickname' => '[A-Za-z0-9_-]+'));
46 $m->connect('main/ostatus/nickname/:nickname',
47 array('action' => 'ostatusinit'), array('nickname' => '[A-Za-z0-9_-]+'));
48 $m->connect('main/ostatus/group/:group',
49 array('action' => 'ostatusinit'), array('group' => '[A-Za-z0-9_-]+'));
50 $m->connect('main/ostatus/peopletag/:peopletag/tagger/:tagger',
51 array('action' => 'ostatusinit'), array('tagger' => '[A-Za-z0-9_-]+',
52 'peopletag' => '[A-Za-z0-9_-]+'));
53 $m->connect('main/ostatus',
54 array('action' => 'ostatusinit'));
56 // Remote subscription actions
57 $m->connect('main/ostatussub',
58 array('action' => 'ostatussub'));
59 $m->connect('main/ostatusgroup',
60 array('action' => 'ostatusgroup'));
61 $m->connect('main/ostatuspeopletag',
62 array('action' => 'ostatuspeopletag'));
65 $m->connect('main/push/hub', array('action' => 'pushhub'));
67 $m->connect('main/push/callback/:feed',
68 array('action' => 'pushcallback'),
69 array('feed' => '[0-9]+'));
72 $m->connect('main/salmon/user/:id',
73 array('action' => 'usersalmon'),
74 array('id' => '[0-9]+'));
75 $m->connect('main/salmon/group/:id',
76 array('action' => 'groupsalmon'),
77 array('id' => '[0-9]+'));
78 $m->connect('main/salmon/peopletag/:id',
79 array('action' => 'peopletagsalmon'),
80 array('id' => '[0-9]+'));
85 * Set up queue handlers for outgoing hub pushes
86 * @param QueueManager $qm
87 * @return boolean hook return
89 function onEndInitializeQueueManager(QueueManager $qm)
91 // Prepare outgoing distributions after notice save.
92 $qm->connect('ostatus', 'OStatusQueueHandler');
94 // Outgoing from our internal PuSH hub
95 $qm->connect('hubconf', 'HubConfQueueHandler');
96 $qm->connect('hubprep', 'HubPrepQueueHandler');
98 $qm->connect('hubout', 'HubOutQueueHandler');
100 // Outgoing Salmon replies (when we don't need a return value)
101 $qm->connect('salmon', 'SalmonQueueHandler');
103 // Incoming from a foreign PuSH hub
104 $qm->connect('pushin', 'PushInQueueHandler');
106 // Re-subscribe feeds that need renewal
107 $qm->connect('pushrenew', 'PushRenewQueueHandler');
112 * Put saved notices into the queue for pubsub distribution.
114 function onStartEnqueueNotice($notice, &$transports)
116 if ($notice->inScope(null) && $notice->getProfile()->hasRight(Right::PUBLICNOTICE)) {
117 // put our transport first, in case there's any conflict (like OMB)
118 array_unshift($transports, 'ostatus');
119 $this->log(LOG_INFO, "OSTATUS [{$notice->getID()}]: queued for OStatus processing");
121 // FIXME: we don't do privacy-controlled OStatus updates yet.
122 // once that happens, finer grain of control here.
123 $this->log(LOG_NOTICE, "OSTATUS [{$notice->getID()}]: Not queueing because of privacy; scope = {$notice->scope}");
129 * Set up a PuSH hub link to our internal link for canonical timeline
130 * Atom feeds for users and groups.
132 function onStartApiAtom($feed)
136 if ($feed instanceof AtomUserNoticeFeed) {
137 $salmonAction = 'usersalmon';
138 $user = $feed->getUser();
140 $profile = $user->getProfile();
141 } else if ($feed instanceof AtomGroupNoticeFeed) {
142 $salmonAction = 'groupsalmon';
143 $group = $feed->getGroup();
145 } else if ($feed instanceof AtomListNoticeFeed) {
146 $salmonAction = 'peopletagsalmon';
147 $peopletag = $feed->getList();
148 $id = $peopletag->id;
154 $hub = common_config('ostatus', 'hub');
156 // Updates will be handled through our internal PuSH hub.
157 $hub = common_local_url('pushhub');
159 $feed->addLink($hub, array('rel' => 'hub'));
161 // Also, we'll add in the salmon link
162 $salmon = common_local_url($salmonAction, array('id' => $id));
163 $feed->addLink($salmon, array('rel' => Salmon::REL_SALMON));
165 // XXX: these are deprecated, but StatusNet only looks for NS_REPLIES
166 $feed->addLink($salmon, array('rel' => Salmon::NS_REPLIES));
167 $feed->addLink($salmon, array('rel' => Salmon::NS_MENTIONS));
174 * Add in an OStatus subscribe button
176 function onStartProfileRemoteSubscribe($output, $profile)
178 $this->onStartProfileListItemActionElements($output, $profile);
182 function onStartGroupSubscribe($widget, $group)
184 $cur = common_current_user();
187 $widget->out->elementStart('li', 'entity_subscribe');
189 $url = common_local_url('ostatusinit',
190 array('group' => $group->nickname));
191 $widget->out->element('a', array('href' => $url,
192 'class' => 'entity_remote_subscribe'),
193 // TRANS: Link to subscribe to a remote entity.
196 $widget->out->elementEnd('li');
203 function onStartSubscribePeopletagForm($output, $peopletag)
205 $cur = common_current_user();
208 $output->elementStart('li', 'entity_subscribe');
209 $profile = $peopletag->getTagger();
210 $url = common_local_url('ostatusinit',
211 array('tagger' => $profile->nickname, 'peopletag' => $peopletag->tag));
212 $output->element('a', array('href' => $url,
213 'class' => 'entity_remote_subscribe'),
214 // TRANS: Link to subscribe to a remote entity.
217 $output->elementEnd('li');
225 * If the field being looked for is URI look for the profile
227 function onStartProfileCompletionSearch($action, $profile, $search_engine) {
228 if ($action->field == 'uri') {
229 $profile->joinAdd(array('id', 'user:id'));
230 $profile->whereAdd('uri LIKE "%' . $profile->escape($q) . '%"');
233 $validate = new Validate();
235 if ($profile->N == 0) {
237 if ($validate->email($q)) {
238 $oprofile = Ostatus_profile::ensureWebfinger($q);
239 } else if ($validate->uri($q)) {
240 $oprofile = Ostatus_profile::ensureProfileURL($q);
242 // TRANS: Exception in OStatus when invalid URI was entered.
243 throw new Exception(_m('Invalid URI.'));
245 return $this->filter(array($oprofile->localProfile()));
247 } catch (Exception $e) {
248 // TRANS: Error message in OStatus plugin. Do not translate the domain names example.com
249 // TRANS: and example.net, as these are official standard domain names for use in examples.
250 $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.");
260 * Webfinger matches: @user@example.com or even @user--one.george_orwell@1984.biz
262 * @return array The matching IDs (without @ or acct:) and each respective position in the given string.
264 static function extractWebfingerIds($text)
267 $result = preg_match_all('/(?:^|\s+)@((?:\w+[\w\-\_\.]?)*(?:[\w\-\_\.]*\w+)@'.URL_REGEX_DOMAIN_NAME.')/',
270 PREG_OFFSET_CAPTURE);
271 if ($result === false) {
272 common_log(LOG_ERR, __METHOD__ . ': Error parsing webfinger IDs from text (preg_last_error=='.preg_last_error().').');
274 common_debug(sprintf('Found %i matches for WebFinger IDs: %s', count($wmatches), _ve($wmatches)));
280 * Profile URL matches: @example.com/mublog/user
282 * @return array The matching URLs (without @ or acct:) and each respective position in the given string.
284 static function extractUrlMentions($text)
287 // In the regexp below we need to match / _before_ URL_REGEX_VALID_PATH_CHARS because it otherwise gets merged
288 // with the TLD before (but / is in URL_REGEX_VALID_PATH_CHARS anyway, it's just its positioning that is important)
289 $result = preg_match_all('/(?:^|\s+)@('.URL_REGEX_DOMAIN_NAME.'(?:\/['.URL_REGEX_VALID_PATH_CHARS.']*)*)/',
292 PREG_OFFSET_CAPTURE);
293 if ($result === false) {
294 common_log(LOG_ERR, __METHOD__ . ': Error parsing profile URL mentions from text (preg_last_error=='.preg_last_error().').');
296 common_debug(sprintf('Found %i matches for profile URL mentions: %s', count($wmatches), _ve($wmatches)));
302 * Find any explicit remote mentions. Accepted forms:
303 * Webfinger: @user@example.com
304 * Profile link: @example.com/mublog/user
305 * @param Profile $sender
306 * @param string $text input markup text
307 * @param array &$mention in/out param: set of found mentions
308 * @return boolean hook return value
310 function onEndFindMentions(Profile $sender, $text, &$mentions)
314 foreach (self::extractWebfingerIds($text) as $wmatch) {
315 list($target, $pos) = $wmatch;
316 $this->log(LOG_INFO, "Checking webfinger '$target'");
319 $oprofile = Ostatus_profile::ensureWebfinger($target);
320 if (!$oprofile instanceof Ostatus_profile || !$oprofile->isPerson()) {
323 $profile = $oprofile->localProfile();
324 } catch (OStatusShadowException $e) {
325 // This means we got a local user in the webfinger lookup
326 $profile = $e->profile;
327 } catch (Exception $e) {
328 $this->log(LOG_ERR, "Webfinger check failed: " . $e->getMessage());
332 assert($profile instanceof Profile);
334 $text = !empty($profile->nickname) && mb_strlen($profile->nickname) < mb_strlen($target)
335 ? $profile->getNickname() // TODO: we could do getBestName() or getFullname() here
337 $url = $profile->getUri();
338 if (!common_valid_http_url($url)) {
339 $url = $profile->getUrl();
341 $matches[$pos] = array('mentioned' => array($profile),
345 'length' => mb_strlen($target),
349 foreach (self::extractUrlMentions($text) as $wmatch) {
350 list($target, $pos) = $wmatch;
351 $schemes = array('http', 'https');
352 foreach ($schemes as $scheme) {
353 $url = "$scheme://$target";
354 $this->log(LOG_INFO, "Checking profile address '$url'");
356 $oprofile = Ostatus_profile::ensureProfileURL($url);
357 if ($oprofile instanceof Ostatus_profile && !$oprofile->isGroup()) {
358 $profile = $oprofile->localProfile();
359 $text = !empty($profile->nickname) && mb_strlen($profile->nickname) < mb_strlen($target) ?
360 $profile->nickname : $target;
361 $matches[$pos] = array('mentioned' => array($profile),
365 'length' => mb_strlen($target),
366 'url' => $profile->getUrl());
369 } catch (Exception $e) {
370 $this->log(LOG_ERR, "Profile check failed: " . $e->getMessage());
375 foreach ($mentions as $i => $other) {
376 // If we share a common prefix with a local user, override it!
377 $pos = $other['position'];
378 if (isset($matches[$pos])) {
379 $mentions[$i] = $matches[$pos];
380 unset($matches[$pos]);
383 foreach ($matches as $mention) {
384 $mentions[] = $mention;
391 * Allow remote profile references to be used in commands:
392 * sub update@status.net
393 * whois evan@identi.ca
394 * reply http://identi.ca/evan hey what's up
396 * @param Command $command
398 * @param Profile &$profile
399 * @return hook return code
401 function onStartCommandGetProfile($command, $arg, &$profile)
403 $oprofile = $this->pullRemoteProfile($arg);
404 if ($oprofile instanceof Ostatus_profile && !$oprofile->isGroup()) {
406 $profile = $oprofile->localProfile();
407 } catch (NoProfileException $e) {
408 // No locally stored profile found for remote profile
418 * Allow remote group references to be used in commands:
419 * join group+statusnet@identi.ca
420 * join http://identi.ca/group/statusnet
421 * drop identi.ca/group/statusnet
423 * @param Command $command
425 * @param User_group &$group
426 * @return hook return code
428 function onStartCommandGetGroup($command, $arg, &$group)
430 $oprofile = $this->pullRemoteProfile($arg);
431 if ($oprofile instanceof Ostatus_profile && $oprofile->isGroup()) {
432 $group = $oprofile->localGroup();
439 protected function pullRemoteProfile($arg)
442 if (preg_match('!^((?:\w+\.)*\w+@(?:\w+\.)*\w+(?:\w+\-\w+)*\.\w+)$!', $arg)) {
445 return Ostatus_profile::ensureWebfinger($arg);
446 } catch (Exception $e) {
447 common_log(LOG_ERR, 'Webfinger lookup failed for ' .
448 $arg . ': ' . $e->getMessage());
452 // Look for profile URLs, with or without scheme:
454 if (preg_match('!^https?://((?:\w+\.)*\w+(?:\w+\-\w+)*\.\w+(?:/\w+)+)$!', $arg)) {
457 if (preg_match('!^((?:\w+\.)*\w+(?:\w+\-\w+)*\.\w+(?:/\w+)+)$!', $arg)) {
458 $schemes = array('http', 'https');
459 foreach ($schemes as $scheme) {
460 $urls[] = "$scheme://$arg";
464 foreach ($urls as $url) {
466 return Ostatus_profile::ensureProfileURL($url);
467 } catch (Exception $e) {
468 common_log(LOG_ERR, 'Profile lookup failed for ' .
469 $arg . ': ' . $e->getMessage());
475 function onEndProfileSettingsActions($out) {
476 $siteName = common_config('site', 'name');
477 $js = 'navigator.registerContentHandler("application/vnd.mozilla.maybe.feed", "'.addslashes(common_local_url('ostatussub', null, array('profile' => '%s'))).'", "'.addslashes($siteName).'")';
478 $out->elementStart('li');
480 array('href' => 'javascript:'.$js),
481 // TRANS: Option in profile settings to add this instance to Firefox as a feedreader
482 _('Add to Firefox as feedreader'));
483 $out->elementEnd('li');
487 * Make sure necessary tables are filled out.
489 function onCheckSchema() {
490 $schema = Schema::get();
491 $schema->ensureTable('ostatus_profile', Ostatus_profile::schemaDef());
492 $schema->ensureTable('feedsub', FeedSub::schemaDef());
493 $schema->ensureTable('hubsub', HubSub::schemaDef());
494 $schema->ensureTable('magicsig', Magicsig::schemaDef());
498 public function onEndShowStylesheets(Action $action) {
499 $action->cssLink($this->path('theme/base/css/ostatus.css'));
503 function onEndShowStatusNetScripts($action) {
504 $action->script($this->path('js/ostatus.js'));
509 * Override the "from ostatus" bit in notice lists to link to the
510 * original post and show the domain it came from.
512 * @param Notice in $notice
513 * @param string out &$name
514 * @param string out &$url
515 * @param string out &$title
516 * @return mixed hook return code
518 function onStartNoticeSourceLink($notice, &$name, &$url, &$title)
520 // If we don't handle this, keep the event handler going
521 if (!in_array($notice->source, array('ostatus', 'share'))) {
526 $url = $notice->getUrl();
527 // If getUrl() throws exception, $url is never set
529 $bits = parse_url($url);
530 $domain = $bits['host'];
531 if (substr($domain, 0, 4) == 'www.') {
532 $name = substr($domain, 4);
537 // TRANS: Title. %s is a domain name.
538 $title = sprintf(_m('Sent from %s via OStatus'), $domain);
540 // Abort event handler, we have a name and URL!
542 } catch (InvalidUrlException $e) {
543 // This just means we don't have the notice source data
549 * Send incoming PuSH feeds for OStatus endpoints in for processing.
551 * @param FeedSub $feedsub
552 * @param DOMDocument $feed
553 * @return mixed hook return code
555 function onStartFeedSubReceive($feedsub, $feed)
557 $oprofile = Ostatus_profile::getKV('feeduri', $feedsub->uri);
558 if ($oprofile instanceof Ostatus_profile) {
559 $oprofile->processFeed($feed, 'push');
561 common_log(LOG_DEBUG, "No ostatus profile for incoming feed $feedsub->uri");
566 * Tell the FeedSub infrastructure whether we have any active OStatus
567 * usage for the feed; if not it'll be able to garbage-collect the
570 * @param FeedSub $feedsub
571 * @param integer $count in/out
572 * @return mixed hook return code
574 function onFeedSubSubscriberCount($feedsub, &$count)
576 $oprofile = Ostatus_profile::getKV('feeduri', $feedsub->uri);
577 if ($oprofile instanceof Ostatus_profile) {
578 $count += $oprofile->subscriberCount();
584 * When about to subscribe to a remote user, start a server-to-server
585 * PuSH subscription if needed. If we can't establish that, abort.
587 * @fixme If something else aborts later, we could end up with a stray
588 * PuSH subscription. This is relatively harmless, though.
590 * @param Profile $profile subscriber
591 * @param Profile $other subscribee
593 * @return hook return code
597 function onStartSubscribe(Profile $profile, Profile $other)
599 if (!$profile->isLocal()) {
603 $oprofile = Ostatus_profile::getKV('profile_id', $other->id);
604 if (!$oprofile instanceof Ostatus_profile) {
608 $oprofile->subscribe();
612 * Having established a remote subscription, send a notification to the
613 * remote OStatus profile's endpoint.
615 * @param Profile $profile subscriber
616 * @param Profile $other subscribee
618 * @return hook return code
622 function onEndSubscribe(Profile $profile, Profile $other)
624 if (!$profile->isLocal()) {
628 $oprofile = Ostatus_profile::getKV('profile_id', $other->id);
629 if (!$oprofile instanceof Ostatus_profile) {
633 $sub = Subscription::pkeyGet(array('subscriber' => $profile->id,
634 'subscribed' => $other->id));
636 $act = $sub->asActivity();
638 $oprofile->notifyActivity($act, $profile);
644 * Notify remote server and garbage collect unused feeds on unsubscribe.
645 * @todo FIXME: Send these operations to background queues
648 * @param Profile $other
649 * @return hook return value
651 function onEndUnsubscribe(Profile $profile, Profile $other)
653 if (!$profile->isLocal()) {
657 $oprofile = Ostatus_profile::getKV('profile_id', $other->id);
658 if (!$oprofile instanceof Ostatus_profile) {
662 // Drop the PuSH subscription if there are no other subscribers.
663 $oprofile->garbageCollect();
665 $act = new Activity();
667 $act->verb = ActivityVerb::UNFOLLOW;
669 $act->id = TagURI::mint('unfollow:%d:%d:%s',
672 common_date_iso8601(time()));
675 // TRANS: Title for unfollowing a remote profile.
676 $act->title = _m('TITLE','Unfollow');
677 // TRANS: Success message for unsubscribe from user attempt through OStatus.
678 // TRANS: %1$s is the unsubscriber's name, %2$s is the unsubscribed user's name.
679 $act->content = sprintf(_m('%1$s stopped following %2$s.'),
680 $profile->getBestName(),
681 $other->getBestName());
683 $act->actor = $profile->asActivityObject();
684 $act->objects[] = $other->asActivityObject();
686 $oprofile->notifyActivity($act, $profile);
692 * When one of our local users tries to join a remote group,
693 * notify the remote server. If the notification is rejected,
696 * @param User_group $group
697 * @param Profile $profile
699 * @return mixed hook return value
700 * @throws Exception of various kinds, some from $oprofile->subscribe();
702 function onStartJoinGroup($group, $profile)
704 $oprofile = Ostatus_profile::getKV('group_id', $group->id);
705 if (!$oprofile instanceof Ostatus_profile) {
709 $oprofile->subscribe();
711 // NOTE: we don't use Group_member::asActivity() since that record
712 // has not yet been created.
714 $act = new Activity();
715 $act->id = TagURI::mint('join:%d:%d:%s',
718 common_date_iso8601(time()));
720 $act->actor = $profile->asActivityObject();
721 $act->verb = ActivityVerb::JOIN;
722 $act->objects[] = $oprofile->asActivityObject();
725 // TRANS: Title for joining a remote groep.
726 $act->title = _m('TITLE','Join');
727 // TRANS: Success message for subscribe to group attempt through OStatus.
728 // TRANS: %1$s is the member name, %2$s is the subscribed group's name.
729 $act->content = sprintf(_m('%1$s has joined group %2$s.'),
730 $profile->getBestName(),
731 $oprofile->getBestName());
733 if ($oprofile->notifyActivity($act, $profile)) {
736 $oprofile->garbageCollect();
737 // TRANS: Exception thrown when joining a remote group fails.
738 throw new Exception(_m('Failed joining remote group.'));
743 * When one of our local users leaves a remote group, notify the remote
746 * @fixme Might be good to schedule a resend of the leave notification
747 * if it failed due to a transitory error. We've canceled the local
748 * membership already anyway, but if the remote server comes back up
749 * it'll be left with a stray membership record.
751 * @param User_group $group
752 * @param Profile $profile
754 * @return mixed hook return value
756 function onEndLeaveGroup($group, $profile)
758 $oprofile = Ostatus_profile::getKV('group_id', $group->id);
759 if (!$oprofile instanceof Ostatus_profile) {
763 // Drop the PuSH subscription if there are no other subscribers.
764 $oprofile->garbageCollect();
768 $act = new Activity();
769 $act->id = TagURI::mint('leave:%d:%d:%s',
772 common_date_iso8601(time()));
774 $act->actor = $member->asActivityObject();
775 $act->verb = ActivityVerb::LEAVE;
776 $act->objects[] = $oprofile->asActivityObject();
779 // TRANS: Title for leaving a remote group.
780 $act->title = _m('TITLE','Leave');
781 // TRANS: Success message for unsubscribe from group attempt through OStatus.
782 // TRANS: %1$s is the member name, %2$s is the unsubscribed group's name.
783 $act->content = sprintf(_m('%1$s has left group %2$s.'),
784 $member->getBestName(),
785 $oprofile->getBestName());
787 $oprofile->notifyActivity($act, $member);
791 * When one of our local users tries to subscribe to a remote peopletag,
792 * notify the remote server. If the notification is rejected,
793 * deny the subscription.
795 * @param Profile_list $peopletag
798 * @return mixed hook return value
799 * @throws Exception of various kinds, some from $oprofile->subscribe();
802 function onStartSubscribePeopletag($peopletag, $user)
804 $oprofile = Ostatus_profile::getKV('peopletag_id', $peopletag->id);
805 if (!$oprofile instanceof Ostatus_profile) {
809 $oprofile->subscribe();
811 $sub = $user->getProfile();
812 $tagger = Profile::getKV($peopletag->tagger);
814 $act = new Activity();
815 $act->id = TagURI::mint('subscribe_peopletag:%d:%d:%s',
818 common_date_iso8601(time()));
820 $act->actor = $sub->asActivityObject();
821 $act->verb = ActivityVerb::FOLLOW;
822 $act->objects[] = $oprofile->asActivityObject();
825 // TRANS: Title for following a remote list.
826 $act->title = _m('TITLE','Follow list');
827 // TRANS: Success message for remote list follow through OStatus.
828 // TRANS: %1$s is the subscriber name, %2$s is the list, %3$s is the lister's name.
829 $act->content = sprintf(_m('%1$s is now following people listed in %2$s by %3$s.'),
831 $oprofile->getBestName(),
832 $tagger->getBestName());
834 if ($oprofile->notifyActivity($act, $sub)) {
837 $oprofile->garbageCollect();
838 // TRANS: Exception thrown when subscription to remote list fails.
839 throw new Exception(_m('Failed subscribing to remote list.'));
844 * When one of our local users unsubscribes to a remote peopletag, notify the remote
847 * @param Profile_list $peopletag
850 * @return mixed hook return value
853 function onEndUnsubscribePeopletag($peopletag, $user)
855 $oprofile = Ostatus_profile::getKV('peopletag_id', $peopletag->id);
856 if (!$oprofile instanceof Ostatus_profile) {
860 // Drop the PuSH subscription if there are no other subscribers.
861 $oprofile->garbageCollect();
863 $sub = Profile::getKV($user->id);
864 $tagger = Profile::getKV($peopletag->tagger);
866 $act = new Activity();
867 $act->id = TagURI::mint('unsubscribe_peopletag:%d:%d:%s',
870 common_date_iso8601(time()));
872 $act->actor = $member->asActivityObject();
873 $act->verb = ActivityVerb::UNFOLLOW;
874 $act->objects[] = $oprofile->asActivityObject();
877 // TRANS: Title for unfollowing a remote list.
878 $act->title = _m('Unfollow list');
879 // TRANS: Success message for remote list unfollow through OStatus.
880 // TRANS: %1$s is the subscriber name, %2$s is the list, %3$s is the lister's name.
881 $act->content = sprintf(_m('%1$s stopped following the list %2$s by %3$s.'),
883 $oprofile->getBestName(),
884 $tagger->getBestName());
886 $oprofile->notifyActivity($act, $user);
890 * Notify remote users when their notices get favorited.
892 * @param Profile or User $profile of local user doing the faving
893 * @param Notice $notice being favored
894 * @return hook return value
896 function onEndFavorNotice(Profile $profile, Notice $notice)
898 // Only distribute local users' favor actions, remote users
899 // will have already distributed theirs.
900 if (!$profile->isLocal()) {
904 $oprofile = Ostatus_profile::getKV('profile_id', $notice->profile_id);
905 if (!$oprofile instanceof Ostatus_profile) {
909 $fav = Fave::pkeyGet(array('user_id' => $profile->id,
910 'notice_id' => $notice->id));
912 if (!$fav instanceof Fave) {
914 // TODO: Make pkeyGet throw exception, since this is a critical failure.
918 $act = $fav->asActivity();
920 $oprofile->notifyActivity($act, $profile);
926 * Notify remote user it has got a new people tag
927 * - tag verb is queued
928 * - the subscription is done immediately if not present
930 * @param Profile_tag $ptag the people tag that was created
931 * @return hook return value
932 * @throws Exception of various kinds, some from $oprofile->subscribe();
934 function onEndTagProfile($ptag)
936 $oprofile = Ostatus_profile::getKV('profile_id', $ptag->tagged);
937 if (!$oprofile instanceof Ostatus_profile) {
941 $plist = $ptag->getMeta();
942 if ($plist->private) {
946 $act = new Activity();
948 $tagger = $plist->getTagger();
949 $tagged = Profile::getKV('id', $ptag->tagged);
951 $act->verb = ActivityVerb::TAG;
952 $act->id = TagURI::mint('tag_profile:%d:%d:%s',
953 $plist->tagger, $plist->id,
954 common_date_iso8601(time()));
956 // TRANS: Title for listing a remote profile.
957 $act->title = _m('TITLE','List');
958 // TRANS: Success message for remote list addition through OStatus.
959 // TRANS: %1$s is the list creator's name, %2$s is the added list member, %3$s is the list name.
960 $act->content = sprintf(_m('%1$s listed %2$s in the list %3$s.'),
961 $tagger->getBestName(),
962 $tagged->getBestName(),
963 $plist->getBestName());
965 $act->actor = $tagger->asActivityObject();
966 $act->objects = array($tagged->asActivityObject());
967 $act->target = ActivityObject::fromPeopletag($plist);
969 $oprofile->notifyDeferred($act, $tagger);
971 // initiate a PuSH subscription for the person being tagged
972 $oprofile->subscribe();
977 * Notify remote user that a people tag has been removed
978 * - untag verb is queued
979 * - the subscription is undone immediately if not required
980 * i.e garbageCollect()'d
982 * @param Profile_tag $ptag the people tag that was deleted
983 * @return hook return value
985 function onEndUntagProfile($ptag)
987 $oprofile = Ostatus_profile::getKV('profile_id', $ptag->tagged);
988 if (!$oprofile instanceof Ostatus_profile) {
992 $plist = $ptag->getMeta();
993 if ($plist->private) {
997 $act = new Activity();
999 $tagger = $plist->getTagger();
1000 $tagged = Profile::getKV('id', $ptag->tagged);
1002 $act->verb = ActivityVerb::UNTAG;
1003 $act->id = TagURI::mint('untag_profile:%d:%d:%s',
1004 $plist->tagger, $plist->id,
1005 common_date_iso8601(time()));
1006 $act->time = time();
1007 // TRANS: Title for unlisting a remote profile.
1008 $act->title = _m('TITLE','Unlist');
1009 // TRANS: Success message for remote list removal through OStatus.
1010 // TRANS: %1$s is the list creator's name, %2$s is the removed list member, %3$s is the list name.
1011 $act->content = sprintf(_m('%1$s removed %2$s from the list %3$s.'),
1012 $tagger->getBestName(),
1013 $tagged->getBestName(),
1014 $plist->getBestName());
1016 $act->actor = $tagger->asActivityObject();
1017 $act->objects = array($tagged->asActivityObject());
1018 $act->target = ActivityObject::fromPeopletag($plist);
1020 $oprofile->notifyDeferred($act, $tagger);
1022 // unsubscribe to PuSH feed if no more required
1023 $oprofile->garbageCollect();
1029 * Notify remote users when their notices get de-favorited.
1031 * @param Profile $profile Profile person doing the de-faving
1032 * @param Notice $notice Notice being favored
1034 * @return hook return value
1036 function onEndDisfavorNotice(Profile $profile, Notice $notice)
1038 // Only distribute local users' disfavor actions, remote users
1039 // will have already distributed theirs.
1040 if (!$profile->isLocal()) {
1044 $oprofile = Ostatus_profile::getKV('profile_id', $notice->profile_id);
1045 if (!$oprofile instanceof Ostatus_profile) {
1049 $act = new Activity();
1051 $act->verb = ActivityVerb::UNFAVORITE;
1052 $act->id = TagURI::mint('disfavor:%d:%d:%s',
1055 common_date_iso8601(time()));
1056 $act->time = time();
1057 // TRANS: Title for unliking a remote notice.
1058 $act->title = _m('Unlike');
1059 // TRANS: Success message for remove a favorite notice through OStatus.
1060 // TRANS: %1$s is the unfavoring user's name, %2$s is URI to the no longer favored notice.
1061 $act->content = sprintf(_m('%1$s no longer likes %2$s.'),
1062 $profile->getBestName(),
1065 $act->actor = $profile->asActivityObject();
1066 $act->objects[] = $notice->asActivityObject();
1068 $oprofile->notifyActivity($act, $profile);
1073 function onStartGetProfileUri($profile, &$uri)
1075 $oprofile = Ostatus_profile::getKV('profile_id', $profile->id);
1076 if ($oprofile instanceof Ostatus_profile) {
1077 $uri = $oprofile->uri;
1083 function onStartUserGroupHomeUrl($group, &$url)
1085 return $this->onStartUserGroupPermalink($group, $url);
1088 function onStartUserGroupPermalink($group, &$url)
1090 $oprofile = Ostatus_profile::getKV('group_id', $group->id);
1091 if ($oprofile instanceof Ostatus_profile) {
1092 // @fixme this should probably be in the user_group table
1093 // @fixme this uri not guaranteed to be a profile page
1094 $url = $oprofile->uri;
1099 function onStartShowSubscriptionsContent($action)
1101 $this->showEntityRemoteSubscribe($action);
1106 function onStartShowUserGroupsContent($action)
1108 $this->showEntityRemoteSubscribe($action, 'ostatusgroup');
1113 function onEndShowSubscriptionsMiniList($action)
1115 $this->showEntityRemoteSubscribe($action);
1120 function onEndShowGroupsMiniList($action)
1122 $this->showEntityRemoteSubscribe($action, 'ostatusgroup');
1127 function showEntityRemoteSubscribe($action, $target='ostatussub')
1129 if (!$action->getScoped() instanceof Profile) {
1130 // early return if we're not logged in
1134 if ($action->getScoped()->sameAs($action->getTarget())) {
1135 $action->elementStart('div', 'entity_actions');
1136 $action->elementStart('p', array('id' => 'entity_remote_subscribe',
1137 'class' => 'entity_subscribe'));
1138 $action->element('a', array('href' => common_local_url($target),
1139 'class' => 'entity_remote_subscribe'),
1140 // TRANS: Link text for link to remote subscribe.
1142 $action->elementEnd('p');
1143 $action->elementEnd('div');
1148 * Ping remote profiles with updates to this profile.
1149 * Salmon pings are queued for background processing.
1151 function onEndBroadcastProfile(Profile $profile)
1153 $user = User::getKV('id', $profile->id);
1155 // Find foreign accounts I'm subscribed to that support Salmon pings.
1157 // @fixme we could run updates through the PuSH feed too,
1158 // in which case we can skip Salmon pings to folks who
1159 // are also subscribed to me.
1160 $sql = "SELECT * FROM ostatus_profile " .
1161 "WHERE profile_id IN " .
1162 "(SELECT subscribed FROM subscription WHERE subscriber=%d) " .
1164 "(SELECT group_id FROM group_member WHERE profile_id=%d)";
1165 $oprofile = new Ostatus_profile();
1166 $oprofile->query(sprintf($sql, $profile->id, $profile->id));
1168 if ($oprofile->N == 0) {
1169 common_log(LOG_DEBUG, "No OStatus remote subscribees for $profile->nickname");
1173 $act = new Activity();
1175 $act->verb = ActivityVerb::UPDATE_PROFILE;
1176 $act->id = TagURI::mint('update-profile:%d:%s',
1178 common_date_iso8601(time()));
1179 $act->time = time();
1180 // TRANS: Title for activity.
1181 $act->title = _m('Profile update');
1182 // TRANS: Ping text for remote profile update through OStatus.
1183 // TRANS: %s is user that updated their profile.
1184 $act->content = sprintf(_m('%s has updated their profile page.'),
1185 $profile->getBestName());
1187 $act->actor = $profile->asActivityObject();
1188 $act->objects[] = $act->actor;
1190 while ($oprofile->fetch()) {
1191 $oprofile->notifyDeferred($act, $profile);
1197 // FIXME: This one can accept both an Action and a Widget. Confusing! Refactor to (HTMLOutputter $out, Profile $target)!
1198 function onStartProfileListItemActionElements($item)
1200 if (common_logged_in()) {
1201 // only non-logged in users get to see the "remote subscribe" form
1203 } elseif (!$item->getTarget()->isLocal()) {
1204 // we can (for now) only provide remote subscribe forms for local users
1208 if ($item instanceof ProfileAction) {
1210 } elseif ($item instanceof Widget) {
1211 $output = $item->out;
1213 // Bad $item class, don't know how to use this for outputting!
1214 throw new ServerException('Bad item type for onStartProfileListItemActionElements');
1217 // Add an OStatus subscribe
1218 $output->elementStart('li', 'entity_subscribe');
1219 $url = common_local_url('ostatusinit',
1220 array('nickname' => $item->getTarget()->getNickname()));
1221 $output->element('a', array('href' => $url,
1222 'class' => 'entity_remote_subscribe'),
1223 // TRANS: Link text for a user to subscribe to an OStatus user.
1225 $output->elementEnd('li');
1227 $output->elementStart('li', 'entity_tag');
1228 $url = common_local_url('ostatustag',
1229 array('nickname' => $item->getTarget()->getNickname()));
1230 $output->element('a', array('href' => $url,
1231 'class' => 'entity_remote_tag'),
1232 // TRANS: Link text for a user to list an OStatus user.
1234 $output->elementEnd('li');
1239 function onPluginVersion(array &$versions)
1241 $versions[] = array('name' => 'OStatus',
1242 'version' => GNUSOCIAL_VERSION,
1243 'author' => 'Evan Prodromou, James Walker, Brion Vibber, Zach Copley',
1244 'homepage' => 'https://git.gnu.io/gnu/gnu-social/tree/master/plugins/OStatus',
1245 // TRANS: Plugin description.
1246 'rawdescription' => _m('Follow people across social networks that implement '.
1247 '<a href="http://ostatus.org/">OStatus</a>.'));
1253 * Utility function to check if the given URI is a canonical group profile
1254 * page, and if so return the ID number.
1256 * @param string $url
1257 * @return mixed int or false
1259 public static function localGroupFromUrl($url)
1261 $group = User_group::getKV('uri', $url);
1262 if ($group instanceof User_group) {
1263 if ($group->isLocal()) {
1267 // To find local groups which haven't had their uri fields filled out...
1268 // If the domain has changed since a subscriber got the URI, it'll
1270 $template = common_local_url('groupbyid', array('id' => '31337'));
1271 $template = preg_quote($template, '/');
1272 $template = str_replace('31337', '(\d+)', $template);
1273 if (preg_match("/$template/", $url, $matches)) {
1274 return intval($matches[1]);
1280 public function onStartProfileGetAtomFeed($profile, &$feed)
1282 $oprofile = Ostatus_profile::getKV('profile_id', $profile->id);
1284 if (!$oprofile instanceof Ostatus_profile) {
1288 $feed = $oprofile->feeduri;
1292 function onStartGetProfileFromURI($uri, &$profile)
1294 // Don't want to do Web-based discovery on our own server,
1295 // so we check locally first. This duplicates the functionality
1296 // in the Profile class, since the plugin always runs before
1297 // that local lookup, but since we return false it won't run double.
1299 $user = User::getKV('uri', $uri);
1300 if ($user instanceof User) {
1301 $profile = $user->getProfile();
1304 $group = User_group::getKV('uri', $uri);
1305 if ($group instanceof User_group) {
1306 $profile = $group->getProfile();
1311 // Now, check remotely
1313 $oprofile = Ostatus_profile::ensureProfileURI($uri);
1314 $profile = $oprofile->localProfile();
1315 return !($profile instanceof Profile); // localProfile won't throw exception but can return null
1316 } catch (Exception $e) {
1317 return true; // It's not an OStatus profile as far as we know, continue event handling
1321 function onEndWebFingerNoticeLinks(XML_XRD $xrd, Notice $target)
1324 $actor = $target->getProfile();
1325 if ($actor->isLocal()) {
1326 $profiletype = $this->profileTypeString($actor);
1327 $salmon_url = common_local_url("{$profiletype}salmon", array('id' => $actor->getID()));
1330 $oprofile = Ostatus_profile::fromProfile($actor);
1331 $salmon_url = $oprofile->salmonuri;
1332 } catch (Exception $e) {
1333 // Even though it's not a local user, we couldn't get an Ostatus_profile?!
1336 // Ostatus_profile salmon URL may be empty
1337 if (!empty($salmon_url)) {
1338 $xrd->links[] = new XML_XRD_Element_Link(Salmon::REL_SALMON, $salmon_url);
1343 function onEndWebFingerProfileLinks(XML_XRD $xrd, Profile $target)
1345 if ($target->getObjectType() === ActivityObject::PERSON) {
1346 $this->addWebFingerPersonLinks($xrd, $target);
1347 } elseif ($target->getObjectType() === ActivityObject::GROUP) {
1348 $xrd->links[] = new XML_XRD_Element_Link(Discovery::UPDATESFROM,
1349 common_local_url('ApiTimelineGroup',
1350 array('id' => $target->getGroup()->getID(), 'format' => 'atom')),
1351 'application/atom+xml');
1356 $profiletype = $this->profileTypeString($target);
1357 $salmon_url = common_local_url("{$profiletype}salmon", array('id' => $target->id));
1359 $xrd->links[] = new XML_XRD_Element_Link(Salmon::REL_SALMON, $salmon_url);
1361 // XXX: these are deprecated, but StatusNet only looks for NS_REPLIES
1362 $xrd->links[] = new XML_XRD_Element_Link(Salmon::NS_REPLIES, $salmon_url);
1363 $xrd->links[] = new XML_XRD_Element_Link(Salmon::NS_MENTIONS, $salmon_url);
1365 // TODO - finalize where the redirect should go on the publisher
1366 $xrd->links[] = new XML_XRD_Element_Link('http://ostatus.org/schema/1.0/subscribe',
1367 common_local_url('ostatussub') . '?profile={uri}',
1368 null, // type not set
1369 true); // isTemplate
1374 protected function profileTypeString(Profile $target)
1376 // This is just used to have a definitive string response to "USERsalmon" or "GROUPsalmon"
1377 switch ($target->getObjectType()) {
1378 case ActivityObject::PERSON:
1380 case ActivityObject::GROUP:
1383 throw new ServerException('Unknown profile type for WebFinger profile links');
1387 protected function addWebFingerPersonLinks(XML_XRD $xrd, Profile $target)
1389 $xrd->links[] = new XML_XRD_Element_Link(Discovery::UPDATESFROM,
1390 common_local_url('ApiTimelineUser',
1391 array('id' => $target->id, 'format' => 'atom')),
1392 'application/atom+xml');
1394 // Get this profile's keypair
1395 $magicsig = Magicsig::getKV('user_id', $target->id);
1396 if (!$magicsig instanceof Magicsig && $target->isLocal()) {
1397 $magicsig = Magicsig::generate($target->getUser());
1400 if (!$magicsig instanceof Magicsig) {
1401 return false; // value doesn't mean anything, just figured I'd indicate this function didn't do anything
1403 if (Event::handle('StartAttachPubkeyToUserXRD', array($magicsig, $xrd, $target))) {
1404 $xrd->links[] = new XML_XRD_Element_Link(Magicsig::PUBLICKEYREL,
1405 'data:application/magic-public-key,'. $magicsig->toString());
1406 // The following event handles plugins like Diaspora which add their own version of the Magicsig pubkey
1407 Event::handle('EndAttachPubkeyToUserXRD', array($magicsig, $xrd, $target));
1411 public function onGetLocalAttentions(Profile $actor, array $attention_uris, array &$mentions, array &$groups)
1413 list($groups, $mentions) = Ostatus_profile::filterAttention($actor, $attention_uris);
1416 // FIXME: Maybe this shouldn't be so authoritative that it breaks other remote profile lookups?
1417 static public function onCheckActivityAuthorship(Activity $activity, Profile &$profile)
1420 $oprofile = Ostatus_profile::ensureProfileURL($profile->getUrl());
1421 $profile = $oprofile->checkAuthorship($activity);
1422 } catch (Exception $e) {
1423 common_log(LOG_ERR, 'Could not get a profile or check authorship ('.get_class($e).': "'.$e->getMessage().'") for activity ID: '.$activity->id);
1430 public function onProfileDeleteRelated($profile, &$related)
1432 // Ostatus_profile has a 'profile_id' property, which will be used to find the object
1433 $related[] = 'Ostatus_profile';
1435 // Magicsig has a "user_id" column instead, so we have to delete it more manually:
1436 $magicsig = Magicsig::getKV('user_id', $profile->id);
1437 if ($magicsig instanceof Magicsig) {
1438 $magicsig->delete();
1443 public function onSalmonSlap($endpoint_uri, MagicEnvelope $magic_env, Profile $target=null)
1446 $envxml = $magic_env->toXML($target);
1447 } catch (Exception $e) {
1448 common_log(LOG_ERR, sprintf('Could not generate Magic Envelope XML for profile id=='.$target->getID().': '.$e->getMessage()));
1452 $headers = array('Content-Type: application/magic-envelope+xml');
1455 $client = new HTTPClient();
1456 $client->setBody($envxml);
1457 $response = $client->post($endpoint_uri, $headers);
1458 } catch (Exception $e) {
1459 common_log(LOG_ERR, "Salmon post to $endpoint_uri failed: " . $e->getMessage());
1462 if ($response->getStatus() === 422) {
1463 common_debug(sprintf('Salmon (from profile %d) endpoint %s returned status %s. We assume it is a Diaspora seed; will adapt and try again if that plugin is enabled!', $magic_env->getActor()->getID(), $endpoint_uri, $response->getStatus()));
1467 // 200 OK is the best response
1468 // 202 Accepted is what we get from Diaspora for example
1469 if (!in_array($response->getStatus(), array(200, 202))) {
1470 common_log(LOG_ERR, sprintf('Salmon (from profile %d) endpoint %s returned status %s: %s',
1471 $magic_env->getActor()->getID(), $endpoint_uri, $response->getStatus(), $response->getBody()));
1475 // Since we completed the salmon slap, we discontinue the event
1479 public function onCronDaily()
1482 $sub = FeedSub::renewalCheck();
1483 } catch (NoResultException $e) {
1484 common_log(LOG_INFO, "There were no expiring feeds.");
1488 $qm = QueueManager::get();
1489 while ($sub->fetch()) {
1490 $item = array('feedsub_id' => $sub->id);
1491 $qm->enqueue($item, 'pushrenew');