X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=plugins%2FOStatus%2FOStatusPlugin.php;h=6652647771f97631c2593e84ba7e9b266bf05ae7;hb=b8506d775833fa7ea53e08c58fdf23a4d1257727;hp=59c18746f0d6892398d34d34d1798892307db64f;hpb=99db745f9d8746e3170bf779746d855c44f0b951;p=quix0rs-gnu-social.git diff --git a/plugins/OStatus/OStatusPlugin.php b/plugins/OStatus/OStatusPlugin.php index 59c18746f0..6652647771 100644 --- a/plugins/OStatus/OStatusPlugin.php +++ b/plugins/OStatus/OStatusPlugin.php @@ -18,15 +18,17 @@ */ /** + * OStatusPlugin implementation for GNU Social + * + * Depends on: WebFinger plugin + * * @package OStatusPlugin * @maintainer Brion Vibber */ -if (!defined('STATUSNET')) { - exit(1); -} +if (!defined('GNUSOCIAL')) { exit(1); } -set_include_path(get_include_path() . PATH_SEPARATOR . dirname(__FILE__) . '/extlib/'); +set_include_path(get_include_path() . PATH_SEPARATOR . dirname(__FILE__) . '/extlib/phpseclib'); class FeedSubException extends Exception { @@ -46,24 +48,33 @@ class OStatusPlugin extends Plugin /** * Hook for RouterInitialized event. * - * @param Net_URL_Mapper $m path-to-action mapper + * @param URLMapper $m path-to-action mapper * @return boolean hook return */ - function onRouterInitialized($m) + function onRouterInitialized(URLMapper $m) { // Discovery actions - $m->connect('main/ownerxrd', - array('action' => 'ownerxrd')); - $m->connect('main/ostatus', - array('action' => 'ostatusinit')); - $m->connect('main/ostatus?nickname=:nickname', + $m->connect('main/ostatustag', + array('action' => 'ostatustag')); + $m->connect('main/ostatustag?nickname=:nickname', + array('action' => 'ostatustag'), array('nickname' => '[A-Za-z0-9_-]+')); + $m->connect('main/ostatus/nickname/:nickname', array('action' => 'ostatusinit'), array('nickname' => '[A-Za-z0-9_-]+')); - $m->connect('main/ostatus?group=:group', + $m->connect('main/ostatus/group/:group', array('action' => 'ostatusinit'), array('group' => '[A-Za-z0-9_-]+')); + $m->connect('main/ostatus/peopletag/:peopletag/tagger/:tagger', + array('action' => 'ostatusinit'), array('tagger' => '[A-Za-z0-9_-]+', + 'peopletag' => '[A-Za-z0-9_-]+')); + $m->connect('main/ostatus', + array('action' => 'ostatusinit')); + + // Remote subscription actions $m->connect('main/ostatussub', array('action' => 'ostatussub')); $m->connect('main/ostatusgroup', array('action' => 'ostatusgroup')); + $m->connect('main/ostatuspeopletag', + array('action' => 'ostatuspeopletag')); // PuSH actions $m->connect('main/push/hub', array('action' => 'pushhub')); @@ -79,6 +90,9 @@ class OStatusPlugin extends Plugin $m->connect('main/salmon/group/:id', array('action' => 'groupsalmon'), array('id' => '[0-9]+')); + $m->connect('main/salmon/peopletag/:id', + array('action' => 'peopletagsalmon'), + array('id' => '[0-9]+')); return true; } @@ -109,29 +123,20 @@ class OStatusPlugin extends Plugin /** * Put saved notices into the queue for pubsub distribution. */ - function onStartEnqueueNotice($notice, &$transports) + function onStartEnqueueNotice(Notice $notice, array &$transports) { - if ($notice->isLocal()) { + if ($notice->inScope(null)) { // put our transport first, in case there's any conflict (like OMB) array_unshift($transports, 'ostatus'); + $this->log(LOG_INFO, "Notice {$notice->id} queued for OStatus processing"); + } else { + // FIXME: we don't do privacy-controlled OStatus updates yet. + // once that happens, finer grain of control here. + $this->log(LOG_NOTICE, "Not queueing notice {$notice->id} for OStatus because of privacy; scope = {$notice->scope}"); } return true; } - /** - * Add a link header for LRDD Discovery - */ - function onStartShowHTML($action) - { - if ($action instanceof ShowstreamAction) { - $acct = 'acct:'. $action->profile->nickname .'@'. common_config('site', 'server'); - $url = common_local_url('userxrd'); - $url.= '?uri='. $acct; - - header('Link: <'.$url.'>; rel="'. Discovery::LRDD_REL.'"; type="application/xrd+xml"'); - } - } - /** * Set up a PuSH hub link to our internal link for canonical timeline * Atom feeds for users and groups. @@ -149,6 +154,10 @@ class OStatusPlugin extends Plugin $salmonAction = 'groupsalmon'; $group = $feed->getGroup(); $id = $group->id; + } else if ($feed instanceof AtomListNoticeFeed) { + $salmonAction = 'peopletagsalmon'; + $peopletag = $feed->getList(); + $id = $peopletag->id; } else { return true; } @@ -165,7 +174,7 @@ class OStatusPlugin extends Plugin $salmon = common_local_url($salmonAction, array('id' => $id)); $feed->addLink($salmon, array('rel' => Salmon::REL_SALMON)); - // XXX: these are deprecated + // XXX: these are deprecated, but StatusNet only looks for NS_REPLIES $feed->addLink($salmon, array('rel' => Salmon::NS_REPLIES)); $feed->addLink($salmon, array('rel' => Salmon::NS_MENTIONS)); } @@ -174,74 +183,117 @@ class OStatusPlugin extends Plugin } /** - * Automatically load the actions and libraries used by the plugin - * - * @param Class $cls the class - * - * @return boolean hook return - * + * Add in an OStatus subscribe button */ - function onAutoload($cls) + function onStartProfileRemoteSubscribe($output, $profile) { - $base = dirname(__FILE__); - $lower = strtolower($cls); - $map = array('activityverb' => 'activity', - 'activityobject' => 'activity', - 'activityutils' => 'activity'); - if (isset($map[$lower])) { - $lower = $map[$lower]; - } - $files = array("$base/classes/$cls.php", - "$base/lib/$lower.php"); - if (substr($lower, -6) == 'action') { - $files[] = "$base/actions/" . substr($lower, 0, -6) . ".php"; - } - foreach ($files as $file) { - if (file_exists($file)) { - include_once $file; - return false; - } + $this->onStartProfileListItemActionElements($output, $profile); + return false; + } + + function onStartGroupSubscribe($widget, $group) + { + $cur = common_current_user(); + + if (empty($cur)) { + $widget->out->elementStart('li', 'entity_subscribe'); + + $url = common_local_url('ostatusinit', + array('group' => $group->nickname)); + $widget->out->element('a', array('href' => $url, + 'class' => 'entity_remote_subscribe'), + // TRANS: Link to subscribe to a remote entity. + _m('Subscribe')); + + $widget->out->elementEnd('li'); + return false; } + return true; } - /** - * Add in an OStatus subscribe button - */ - function onStartProfileRemoteSubscribe($output, $profile) + function onStartSubscribePeopletagForm($output, $peopletag) { $cur = common_current_user(); if (empty($cur)) { - // Add an OStatus subscribe $output->elementStart('li', 'entity_subscribe'); + $profile = $peopletag->getTagger(); $url = common_local_url('ostatusinit', - array('nickname' => $profile->nickname)); + array('tagger' => $profile->nickname, 'peopletag' => $peopletag->tag)); $output->element('a', array('href' => $url, 'class' => 'entity_remote_subscribe'), - // TRANS: Link description for link to subscribe to a remote user. + // TRANS: Link to subscribe to a remote entity. _m('Subscribe')); $output->elementEnd('li'); + return false; } - return false; + return true; } - function onStartGroupSubscribe($output, $group) + function onStartTagProfileAction($action, $profile) { - $cur = common_current_user(); + $err = null; + $uri = $action->trimmed('uri'); - if (empty($cur)) { - // Add an OStatus subscribe - $url = common_local_url('ostatusinit', - array('group' => $group->nickname)); - $output->element('a', array('href' => $url, - 'class' => 'entity_remote_subscribe'), - // TRANS: Link description for link to join a remote group. - _m('Join')); + if (!$profile && $uri) { + try { + if (Validate::email($uri)) { + $oprofile = Ostatus_profile::ensureWebfinger($uri); + } else if (Validate::uri($uri)) { + $oprofile = Ostatus_profile::ensureProfileURL($uri); + } else { + // TRANS: Exception in OStatus when invalid URI was entered. + throw new Exception(_m('Invalid URI.')); + } + + // redirect to the new profile. + common_redirect(common_local_url('tagprofile', array('id' => $oprofile->profile_id)), 303); + + } catch (Exception $e) { + // TRANS: Error message in OStatus plugin. Do not translate the domain names example.com + // TRANS: and example.net, as these are official standard domain names for use in examples. + $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."); + } + + $action->showForm($err); + return false; } + return true; + } + + /* + * If the field being looked for is URI look for the profile + */ + function onStartProfileCompletionSearch($action, $profile, $search_engine) { + if ($action->field == 'uri') { + $profile->joinAdd(array('id', 'user:id')); + $profile->whereAdd('uri LIKE "%' . $profile->escape($q) . '%"'); + $profile->query(); + if ($profile->N == 0) { + try { + if (Validate::email($q)) { + $oprofile = Ostatus_profile::ensureWebfinger($q); + } else if (Validate::uri($q)) { + $oprofile = Ostatus_profile::ensureProfileURL($q); + } else { + // TRANS: Exception in OStatus when invalid URI was entered. + throw new Exception(_m('Invalid URI.')); + } + return $this->filter(array($oprofile->localProfile())); + + } catch (Exception $e) { + // TRANS: Error message in OStatus plugin. Do not translate the domain names example.com + // TRANS: and example.net, as these are official standard domain names for use in examples. + $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."); + return array(); + } + } + return false; + } return true; } @@ -249,13 +301,12 @@ class OStatusPlugin extends Plugin * Find any explicit remote mentions. Accepted forms: * Webfinger: @user@example.com * Profile link: @example.com/mublog/user - * @param Profile $sender (os user?) + * @param Profile $sender * @param string $text input markup text * @param array &$mention in/out param: set of found mentions * @return boolean hook return value */ - - function onEndFindMentions($sender, $text, &$mentions) + function onEndFindMentions(Profile $sender, $text, &$mentions) { $matches = array(); @@ -269,12 +320,13 @@ class OStatusPlugin extends Plugin $this->log(LOG_INFO, "Checking webfinger '$target'"); try { $oprofile = Ostatus_profile::ensureWebfinger($target); - if ($oprofile && !$oprofile->isGroup()) { + if ($oprofile instanceof Ostatus_profile && !$oprofile->isGroup()) { $profile = $oprofile->localProfile(); $matches[$pos] = array('mentioned' => array($profile), + 'type' => 'mention', 'text' => $target, 'position' => $pos, - 'url' => $profile->profileurl); + 'url' => $profile->getUrl()); } } catch (Exception $e) { $this->log(LOG_ERR, "Webfinger check failed: " . $e->getMessage()); @@ -295,12 +347,13 @@ class OStatusPlugin extends Plugin $this->log(LOG_INFO, "Checking profile address '$url'"); try { $oprofile = Ostatus_profile::ensureProfileURL($url); - if ($oprofile && !$oprofile->isGroup()) { + if ($oprofile instanceof Ostatus_profile && !$oprofile->isGroup()) { $profile = $oprofile->localProfile(); $matches[$pos] = array('mentioned' => array($profile), + 'type' => 'mention', 'text' => $target, 'position' => $pos, - 'url' => $profile->profileurl); + 'url' => $profile->getUrl()); break; } } catch (Exception $e) { @@ -339,8 +392,13 @@ class OStatusPlugin extends Plugin function onStartCommandGetProfile($command, $arg, &$profile) { $oprofile = $this->pullRemoteProfile($arg); - if ($oprofile && !$oprofile->isGroup()) { - $profile = $oprofile->localProfile(); + if ($oprofile instanceof Ostatus_profile && !$oprofile->isGroup()) { + try { + $profile = $oprofile->localProfile(); + } catch (NoProfileException $e) { + // No locally stored profile found for remote profile + return true; + } return false; } else { return true; @@ -361,7 +419,7 @@ class OStatusPlugin extends Plugin function onStartCommandGetGroup($command, $arg, &$group) { $oprofile = $this->pullRemoteProfile($arg); - if ($oprofile && $oprofile->isGroup()) { + if ($oprofile instanceof Ostatus_profile && $oprofile->isGroup()) { $group = $oprofile->localGroup(); return false; } else { @@ -418,13 +476,13 @@ class OStatusPlugin extends Plugin return true; } - function onEndShowStatusNetStyles($action) { - $action->cssLink('plugins/OStatus/theme/base/css/ostatus.css'); + public function onEndShowStylesheets(Action $action) { + $action->cssLink($this->path('theme/base/css/ostatus.css')); return true; } function onEndShowStatusNetScripts($action) { - $action->script('plugins/OStatus/js/ostatus.js'); + $action->script($this->path('js/ostatus.js')); return true; } @@ -440,23 +498,32 @@ class OStatusPlugin extends Plugin */ function onStartNoticeSourceLink($notice, &$name, &$url, &$title) { - if ($notice->source == 'ostatus') { - if ($notice->url) { - $bits = parse_url($notice->url); - $domain = $bits['host']; - if (substr($domain, 0, 4) == 'www.') { - $name = substr($domain, 4); - } else { - $name = $domain; - } + // If we don't handle this, keep the event handler going + if ($notice->source != 'ostatus') { + return true; + } - $url = $notice->url; - // TRANSLATE: %s is a domain. - $title = sprintf(_m("Sent from %s via OStatus"), $domain); - return false; + try { + $url = $notice->getUrl(); + // If getUrl() throws exception, $url is never set + + $bits = parse_url($url); + $domain = $bits['host']; + if (substr($domain, 0, 4) == 'www.') { + $name = substr($domain, 4); + } else { + $name = $domain; } + + // TRANS: Title. %s is a domain name. + $title = sprintf(_m('Sent from %s via OStatus'), $domain); + + // Abort event handler, we have a name and URL! + return false; + } catch (InvalidUrlException $e) { + // This just means we don't have the notice source data + return true; } - return true; } /** @@ -468,11 +535,11 @@ class OStatusPlugin extends Plugin */ function onStartFeedSubReceive($feedsub, $feed) { - $oprofile = Ostatus_profile::staticGet('feeduri', $feedsub->uri); - if ($oprofile) { + $oprofile = Ostatus_profile::getKV('feeduri', $feedsub->uri); + if ($oprofile instanceof Ostatus_profile) { $oprofile->processFeed($feed, 'push'); } else { - common_log(LOG_DEBUG, "No ostatus profile for incoming feed $feedsub->uri"); + common_debug("No ostatus profile for incoming feed $feedsub->uri"); } } @@ -487,8 +554,8 @@ class OStatusPlugin extends Plugin */ function onFeedSubSubscriberCount($feedsub, &$count) { - $oprofile = Ostatus_profile::staticGet('feeduri', $feedsub->uri); - if ($oprofile) { + $oprofile = Ostatus_profile::getKV('feeduri', $feedsub->uri); + if ($oprofile instanceof Ostatus_profile) { $count += $oprofile->subscriberCount(); } return true; @@ -501,87 +568,75 @@ class OStatusPlugin extends Plugin * @fixme If something else aborts later, we could end up with a stray * PuSH subscription. This is relatively harmless, though. * - * @param Profile $subscriber - * @param Profile $other + * @param Profile $profile subscriber + * @param Profile $other subscribee * * @return hook return code * * @throws Exception */ - function onStartSubscribe($subscriber, $other) + function onStartSubscribe(Profile $profile, Profile $other) { - $user = User::staticGet('id', $subscriber->id); - - if (empty($user)) { + if (!$profile->isLocal()) { return true; } - $oprofile = Ostatus_profile::staticGet('profile_id', $other->id); - - if (empty($oprofile)) { + $oprofile = Ostatus_profile::getKV('profile_id', $other->id); + if (!$oprofile instanceof Ostatus_profile) { return true; } - if (!$oprofile->subscribe()) { - // TRANS: Exception. - throw new Exception(_m('Could not set up remote subscription.')); - } + $oprofile->subscribe(); } /** * Having established a remote subscription, send a notification to the * remote OStatus profile's endpoint. * - * @param Profile $subscriber - * @param Profile $other + * @param Profile $profile subscriber + * @param Profile $other subscribee * * @return hook return code * * @throws Exception */ - function onEndSubscribe($subscriber, $other) + function onEndSubscribe(Profile $profile, Profile $other) { - $user = User::staticGet('id', $subscriber->id); - - if (empty($user)) { + if (!$profile->isLocal()) { return true; } - $oprofile = Ostatus_profile::staticGet('profile_id', $other->id); - - if (empty($oprofile)) { + $oprofile = Ostatus_profile::getKV('profile_id', $other->id); + if (!$oprofile instanceof Ostatus_profile) { return true; } - $sub = Subscription::pkeyGet(array('subscriber' => $subscriber->id, + $sub = Subscription::pkeyGet(array('subscriber' => $profile->id, 'subscribed' => $other->id)); $act = $sub->asActivity(); - $oprofile->notifyActivity($act, $subscriber); + $oprofile->notifyActivity($act, $profile); return true; } /** * Notify remote server and garbage collect unused feeds on unsubscribe. - * @fixme send these operations to background queues + * @todo FIXME: Send these operations to background queues * * @param User $user * @param Profile $other * @return hook return value */ - function onEndUnsubscribe($profile, $other) + function onEndUnsubscribe(Profile $profile, Profile $other) { - $user = User::staticGet('id', $profile->id); - - if (empty($user)) { + if (!$profile->isLocal()) { return true; } - $oprofile = Ostatus_profile::staticGet('profile_id', $other->id); - - if (empty($oprofile)) { + $oprofile = Ostatus_profile::getKV('profile_id', $other->id); + if (!$oprofile instanceof Ostatus_profile) { return true; } @@ -598,15 +653,16 @@ class OStatusPlugin extends Plugin common_date_iso8601(time())); $act->time = time(); - $act->title = _m('Unfollow'); + // TRANS: Title for unfollowing a remote profile. + $act->title = _m('TITLE','Unfollow'); // TRANS: Success message for unsubscribe from user attempt through OStatus. // TRANS: %1$s is the unsubscriber's name, %2$s is the unsubscribed user's name. $act->content = sprintf(_m('%1$s stopped following %2$s.'), $profile->getBestName(), $other->getBestName()); - $act->actor = ActivityObject::fromProfile($profile); - $act->object = ActivityObject::fromProfile($other); + $act->actor = $profile->asActivityObject(); + $act->object = $other->asActivityObject(); $oprofile->notifyActivity($act, $profile); @@ -619,49 +675,48 @@ class OStatusPlugin extends Plugin * deny the join. * * @param User_group $group - * @param User $user + * @param Profile $profile * * @return mixed hook return value + * @throws Exception of various kinds, some from $oprofile->subscribe(); */ - - function onStartJoinGroup($group, $user) + function onStartJoinGroup($group, $profile) { - $oprofile = Ostatus_profile::staticGet('group_id', $group->id); - if ($oprofile) { - if (!$oprofile->subscribe()) { - throw new Exception(_m('Could not set up remote group membership.')); - } - - // NOTE: we don't use Group_member::asActivity() since that record - // has not yet been created. - - $member = Profile::staticGet($user->id); - - $act = new Activity(); - $act->id = TagURI::mint('join:%d:%d:%s', - $member->id, - $group->id, - common_date_iso8601(time())); + $oprofile = Ostatus_profile::getKV('group_id', $group->id); + if (!$oprofile instanceof Ostatus_profile) { + return true; + } - $act->actor = ActivityObject::fromProfile($member); - $act->verb = ActivityVerb::JOIN; - $act->object = $oprofile->asActivityObject(); + $oprofile->subscribe(); - $act->time = time(); - $act->title = _m("Join"); - // TRANS: Success message for subscribe to group attempt through OStatus. - // TRANS: %1$s is the member name, %2$s is the subscribed group's name. - $act->content = sprintf(_m('%1$s has joined group %2$s.'), - $member->getBestName(), - $oprofile->getBestName()); + // NOTE: we don't use Group_member::asActivity() since that record + // has not yet been created. - if ($oprofile->notifyActivity($act, $member)) { - return true; - } else { - $oprofile->garbageCollect(); - // TRANS: Exception. - throw new Exception(_m("Failed joining remote group.")); - } + $act = new Activity(); + $act->id = TagURI::mint('join:%d:%d:%s', + $profile->id, + $group->id, + common_date_iso8601(time())); + + $act->actor = $profile->asActivityObject(); + $act->verb = ActivityVerb::JOIN; + $act->object = $oprofile->asActivityObject(); + + $act->time = time(); + // TRANS: Title for joining a remote groep. + $act->title = _m('TITLE','Join'); + // TRANS: Success message for subscribe to group attempt through OStatus. + // TRANS: %1$s is the member name, %2$s is the subscribed group's name. + $act->content = sprintf(_m('%1$s has joined group %2$s.'), + $profile->getBestName(), + $oprofile->getBestName()); + + if ($oprofile->notifyActivity($act, $profile)) { + return true; + } else { + $oprofile->garbageCollect(); + // TRANS: Exception thrown when joining a remote group fails. + throw new Exception(_m('Failed joining remote group.')); } } @@ -675,40 +730,141 @@ class OStatusPlugin extends Plugin * it'll be left with a stray membership record. * * @param User_group $group - * @param User $user + * @param Profile $profile + * + * @return mixed hook return value + */ + function onEndLeaveGroup($group, $profile) + { + $oprofile = Ostatus_profile::getKV('group_id', $group->id); + if (!$oprofile instanceof Ostatus_profile) { + return true; + } + + // Drop the PuSH subscription if there are no other subscribers. + $oprofile->garbageCollect(); + + $member = $profile; + + $act = new Activity(); + $act->id = TagURI::mint('leave:%d:%d:%s', + $member->id, + $group->id, + common_date_iso8601(time())); + + $act->actor = $member->asActivityObject(); + $act->verb = ActivityVerb::LEAVE; + $act->object = $oprofile->asActivityObject(); + + $act->time = time(); + // TRANS: Title for leaving a remote group. + $act->title = _m('TITLE','Leave'); + // TRANS: Success message for unsubscribe from group attempt through OStatus. + // TRANS: %1$s is the member name, %2$s is the unsubscribed group's name. + $act->content = sprintf(_m('%1$s has left group %2$s.'), + $member->getBestName(), + $oprofile->getBestName()); + + $oprofile->notifyActivity($act, $member); + } + + /** + * When one of our local users tries to subscribe to a remote peopletag, + * notify the remote server. If the notification is rejected, + * deny the subscription. + * + * @param Profile_list $peopletag + * @param User $user * * @return mixed hook return value + * @throws Exception of various kinds, some from $oprofile->subscribe(); */ - function onEndLeaveGroup($group, $user) + function onStartSubscribePeopletag($peopletag, $user) { - $oprofile = Ostatus_profile::staticGet('group_id', $group->id); - if ($oprofile) { - // Drop the PuSH subscription if there are no other subscribers. - $oprofile->garbageCollect(); + $oprofile = Ostatus_profile::getKV('peopletag_id', $peopletag->id); + if (!$oprofile instanceof Ostatus_profile) { + return true; + } - $member = Profile::staticGet($user->id); + $oprofile->subscribe(); - $act = new Activity(); - $act->id = TagURI::mint('leave:%d:%d:%s', - $member->id, - $group->id, - common_date_iso8601(time())); + $sub = $user->getProfile(); + $tagger = Profile::getKV($peopletag->tagger); - $act->actor = ActivityObject::fromProfile($member); - $act->verb = ActivityVerb::LEAVE; - $act->object = $oprofile->asActivityObject(); + $act = new Activity(); + $act->id = TagURI::mint('subscribe_peopletag:%d:%d:%s', + $sub->id, + $peopletag->id, + common_date_iso8601(time())); + + $act->actor = $sub->asActivityObject(); + $act->verb = ActivityVerb::FOLLOW; + $act->object = $oprofile->asActivityObject(); + + $act->time = time(); + // TRANS: Title for following a remote list. + $act->title = _m('TITLE','Follow list'); + // TRANS: Success message for remote list follow through OStatus. + // TRANS: %1$s is the subscriber name, %2$s is the list, %3$s is the lister's name. + $act->content = sprintf(_m('%1$s is now following people listed in %2$s by %3$s.'), + $sub->getBestName(), + $oprofile->getBestName(), + $tagger->getBestName()); + + if ($oprofile->notifyActivity($act, $sub)) { + return true; + } else { + $oprofile->garbageCollect(); + // TRANS: Exception thrown when subscription to remote list fails. + throw new Exception(_m('Failed subscribing to remote list.')); + } + } - $act->time = time(); - $act->title = _m("Leave"); - // TRANS: Success message for unsubscribe from group attempt through OStatus. - // TRANS: %1$s is the member name, %2$s is the unsubscribed group's name. - $act->content = sprintf(_m('%1$s has left group %2$s.'), - $member->getBestName(), - $oprofile->getBestName()); + /** + * When one of our local users unsubscribes to a remote peopletag, notify the remote + * server. + * + * @param Profile_list $peopletag + * @param User $user + * + * @return mixed hook return value + */ - $oprofile->notifyActivity($act, $member); + function onEndUnsubscribePeopletag($peopletag, $user) + { + $oprofile = Ostatus_profile::getKV('peopletag_id', $peopletag->id); + if (!$oprofile instanceof Ostatus_profile) { + return true; } + + // Drop the PuSH subscription if there are no other subscribers. + $oprofile->garbageCollect(); + + $sub = Profile::getKV($user->id); + $tagger = Profile::getKV($peopletag->tagger); + + $act = new Activity(); + $act->id = TagURI::mint('unsubscribe_peopletag:%d:%d:%s', + $sub->id, + $peopletag->id, + common_date_iso8601(time())); + + $act->actor = $member->asActivityObject(); + $act->verb = ActivityVerb::UNFOLLOW; + $act->object = $oprofile->asActivityObject(); + + $act->time = time(); + // TRANS: Title for unfollowing a remote list. + $act->title = _m('Unfollow list'); + // TRANS: Success message for remote list unfollow through OStatus. + // TRANS: %1$s is the subscriber name, %2$s is the list, %3$s is the lister's name. + $act->content = sprintf(_m('%1$s stopped following the list %2$s by %3$s.'), + $sub->getBestName(), + $oprofile->getBestName(), + $tagger->getBestName()); + + $oprofile->notifyActivity($act, $user); } /** @@ -720,23 +876,23 @@ class OStatusPlugin extends Plugin */ function onEndFavorNotice(Profile $profile, Notice $notice) { - $user = User::staticGet('id', $profile->id); - - if (empty($user)) { + // Only distribute local users' favor actions, remote users + // will have already distributed theirs. + if (!$profile->isLocal()) { return true; } - $oprofile = Ostatus_profile::staticGet('profile_id', $notice->profile_id); - - if (empty($oprofile)) { + $oprofile = Ostatus_profile::getKV('profile_id', $notice->profile_id); + if (!$oprofile instanceof Ostatus_profile) { return true; } - $fav = Fave::pkeyGet(array('user_id' => $user->id, + $fav = Fave::pkeyGet(array('user_id' => $profile->id, 'notice_id' => $notice->id)); - if (empty($fav)) { + if (!$fav instanceof Fave) { // That's weird. + // TODO: Make pkeyGet throw exception, since this is a critical failure. return true; } @@ -747,6 +903,109 @@ class OStatusPlugin extends Plugin return true; } + /** + * Notify remote user it has got a new people tag + * - tag verb is queued + * - the subscription is done immediately if not present + * + * @param Profile_tag $ptag the people tag that was created + * @return hook return value + * @throws Exception of various kinds, some from $oprofile->subscribe(); + */ + function onEndTagProfile($ptag) + { + $oprofile = Ostatus_profile::getKV('profile_id', $ptag->tagged); + if (!$oprofile instanceof Ostatus_profile) { + return true; + } + + $plist = $ptag->getMeta(); + if ($plist->private) { + return true; + } + + $act = new Activity(); + + $tagger = $plist->getTagger(); + $tagged = Profile::getKV('id', $ptag->tagged); + + $act->verb = ActivityVerb::TAG; + $act->id = TagURI::mint('tag_profile:%d:%d:%s', + $plist->tagger, $plist->id, + common_date_iso8601(time())); + $act->time = time(); + // TRANS: Title for listing a remote profile. + $act->title = _m('TITLE','List'); + // TRANS: Success message for remote list addition through OStatus. + // TRANS: %1$s is the list creator's name, %2$s is the added list member, %3$s is the list name. + $act->content = sprintf(_m('%1$s listed %2$s in the list %3$s.'), + $tagger->getBestName(), + $tagged->getBestName(), + $plist->getBestName()); + + $act->actor = $tagger->asActivityObject(); + $act->objects = array($tagged->asActivityObject()); + $act->target = ActivityObject::fromPeopletag($plist); + + $oprofile->notifyDeferred($act, $tagger); + + // initiate a PuSH subscription for the person being tagged + $oprofile->subscribe(); + return true; + } + + /** + * Notify remote user that a people tag has been removed + * - untag verb is queued + * - the subscription is undone immediately if not required + * i.e garbageCollect()'d + * + * @param Profile_tag $ptag the people tag that was deleted + * @return hook return value + */ + function onEndUntagProfile($ptag) + { + $oprofile = Ostatus_profile::getKV('profile_id', $ptag->tagged); + if (!$oprofile instanceof Ostatus_profile) { + return true; + } + + $plist = $ptag->getMeta(); + if ($plist->private) { + return true; + } + + $act = new Activity(); + + $tagger = $plist->getTagger(); + $tagged = Profile::getKV('id', $ptag->tagged); + + $act->verb = ActivityVerb::UNTAG; + $act->id = TagURI::mint('untag_profile:%d:%d:%s', + $plist->tagger, $plist->id, + common_date_iso8601(time())); + $act->time = time(); + // TRANS: Title for unlisting a remote profile. + $act->title = _m('TITLE','Unlist'); + // TRANS: Success message for remote list removal through OStatus. + // TRANS: %1$s is the list creator's name, %2$s is the removed list member, %3$s is the list name. + $act->content = sprintf(_m('%1$s removed %2$s from the list %3$s.'), + $tagger->getBestName(), + $tagged->getBestName(), + $plist->getBestName()); + + $act->actor = $tagger->asActivityObject(); + $act->objects = array($tagged->asActivityObject()); + $act->target = ActivityObject::fromPeopletag($plist); + + $oprofile->notifyDeferred($act, $tagger); + + // unsubscribe to PuSH feed if no more required + $oprofile->garbageCollect(); + + return true; + } + /** * Notify remote users when their notices get de-favorited. * @@ -755,18 +1014,16 @@ class OStatusPlugin extends Plugin * * @return hook return value */ - function onEndDisfavorNotice(Profile $profile, Notice $notice) { - $user = User::staticGet('id', $profile->id); - - if (empty($user)) { + // Only distribute local users' disfavor actions, remote users + // will have already distributed theirs. + if (!$profile->isLocal()) { return true; } - $oprofile = Ostatus_profile::staticGet('profile_id', $notice->profile_id); - - if (empty($oprofile)) { + $oprofile = Ostatus_profile::getKV('profile_id', $notice->profile_id); + if (!$oprofile instanceof Ostatus_profile) { return true; } @@ -778,15 +1035,16 @@ class OStatusPlugin extends Plugin $notice->id, common_date_iso8601(time())); $act->time = time(); - $act->title = _m('Disfavor'); + // TRANS: Title for unliking a remote notice. + $act->title = _m('Unlike'); // TRANS: Success message for remove a favorite notice through OStatus. // TRANS: %1$s is the unfavoring user's name, %2$s is URI to the no longer favored notice. - $act->content = sprintf(_m('%1$s marked notice %2$s as no longer a favorite.'), + $act->content = sprintf(_m('%1$s no longer likes %2$s.'), $profile->getBestName(), - $notice->uri); + $notice->getUrl()); - $act->actor = ActivityObject::fromProfile($profile); - $act->object = ActivityObject::fromNotice($notice); + $act->actor = $profile->asActivityObject(); + $act->object = $notice->asActivityObject(); $oprofile->notifyActivity($act, $profile); @@ -795,8 +1053,8 @@ class OStatusPlugin extends Plugin function onStartGetProfileUri($profile, &$uri) { - $oprofile = Ostatus_profile::staticGet('profile_id', $profile->id); - if (!empty($oprofile)) { + $oprofile = Ostatus_profile::getKV('profile_id', $profile->id); + if ($oprofile instanceof Ostatus_profile) { $uri = $oprofile->uri; return false; } @@ -810,8 +1068,8 @@ class OStatusPlugin extends Plugin function onStartUserGroupPermalink($group, &$url) { - $oprofile = Ostatus_profile::staticGet('group_id', $group->id); - if ($oprofile) { + $oprofile = Ostatus_profile::getKV('group_id', $group->id); + if ($oprofile instanceof Ostatus_profile) { // @fixme this should probably be in the user_group table // @fixme this uri not guaranteed to be a profile page $url = $oprofile->uri; @@ -869,7 +1127,7 @@ class OStatusPlugin extends Plugin */ function onEndBroadcastProfile(Profile $profile) { - $user = User::staticGet('id', $profile->id); + $user = User::getKV('id', $profile->id); // Find foreign accounts I'm subscribed to that support Salmon pings. // @@ -885,7 +1143,7 @@ class OStatusPlugin extends Plugin $oprofile->query(sprintf($sql, $profile->id, $profile->id)); if ($oprofile->N == 0) { - common_log(LOG_DEBUG, "No OStatus remote subscribees for $profile->nickname"); + common_debug("No OStatus remote subscribees for $profile->nickname"); return true; } @@ -897,13 +1155,13 @@ class OStatusPlugin extends Plugin common_date_iso8601(time())); $act->time = time(); // TRANS: Title for activity. - $act->title = _m("Profile update"); + $act->title = _m('Profile update'); // TRANS: Ping text for remote profile update through OStatus. // TRANS: %s is user that updated their profile. - $act->content = sprintf(_m("%s has updated their profile page."), + $act->content = sprintf(_m('%s has updated their profile page.'), $profile->getBestName()); - $act->actor = ActivityObject::fromProfile($profile); + $act->actor = $profile->asActivityObject(); $act->object = $act->actor; while ($oprofile->fetch()) { @@ -913,15 +1171,20 @@ class OStatusPlugin extends Plugin return true; } - function onStartProfileListItemActionElements($item) + function onStartProfileListItemActionElements($item, $profile=null) { if (!common_logged_in()) { - $profileUser = User::staticGet('id', $item->profile->id); + $profileUser = User::getKV('id', $item->profile->id); if (!empty($profileUser)) { - $output = $item->out; + if ($item instanceof Action) { + $output = $item; + $profile = $item->profile; + } else { + $output = $item->out; + } // Add an OStatus subscribe $output->elementStart('li', 'entity_subscribe'); @@ -932,16 +1195,25 @@ class OStatusPlugin extends Plugin // TRANS: Link text for a user to subscribe to an OStatus user. _m('Subscribe')); $output->elementEnd('li'); + + $output->elementStart('li', 'entity_tag'); + $url = common_local_url('ostatustag', + array('nickname' => $profileUser->nickname)); + $output->element('a', array('href' => $url, + 'class' => 'entity_remote_tag'), + // TRANS: Link text for a user to list an OStatus user. + _m('List')); + $output->elementEnd('li'); } } return true; } - function onPluginVersion(&$versions) + function onPluginVersion(array &$versions) { $versions[] = array('name' => 'OStatus', - 'version' => STATUSNET_VERSION, + 'version' => GNUSOCIAL_VERSION, 'author' => 'Evan Prodromou, James Walker, Brion Vibber, Zach Copley', 'homepage' => 'http://status.net/wiki/Plugin:OStatus', // TRANS: Plugin description. @@ -960,10 +1232,9 @@ class OStatusPlugin extends Plugin */ public static function localGroupFromUrl($url) { - $group = User_group::staticGet('uri', $url); - if ($group) { - $local = Local_group::staticGet('group_id', $group->id); - if ($local) { + $group = User_group::getKV('uri', $url); + if ($group instanceof User_group) { + if ($group->isLocal()) { return $group->id; } } else { @@ -982,9 +1253,9 @@ class OStatusPlugin extends Plugin public function onStartProfileGetAtomFeed($profile, &$feed) { - $oprofile = Ostatus_profile::staticGet('profile_id', $profile->id); + $oprofile = Ostatus_profile::getKV('profile_id', $profile->id); - if (empty($oprofile)) { + if (!$oprofile instanceof Ostatus_profile) { return true; } @@ -997,8 +1268,8 @@ class OStatusPlugin extends Plugin // Don't want to do Web-based discovery on our own server, // so we check locally first. - $user = User::staticGet('uri', $uri); - + $user = User::getKV('uri', $uri); + if (!empty($user)) { $profile = $user->getProfile(); return false; @@ -1006,55 +1277,84 @@ class OStatusPlugin extends Plugin // Now, check remotely - $oprofile = Ostatus_profile::ensureProfileURI($uri); - - if (!empty($oprofile)) { + try { + $oprofile = Ostatus_profile::ensureProfileURI($uri); $profile = $oprofile->localProfile(); - return false; + return !($profile instanceof Profile); // localProfile won't throw exception but can return null + } catch (Exception $e) { + return true; // It's not an OStatus profile as far as we know, continue event handling } + } - // Still not a hit, so give up. - + function onEndWebFingerNoticeLinks(XML_XRD $xrd, Notice $target) + { + $author = $target->getProfile(); + $salmon_url = common_local_url('usersalmon', array('id' => $author->id)); + $xrd->links[] = new XML_XRD_Element_Link(Salmon::REL_SALMON, $salmon_url); return true; } - function onEndXrdActionLinks(&$xrd, $user) + function onEndWebFingerProfileLinks(XML_XRD $xrd, Profile $target) { - $xrd->links[] = array('rel' => Discovery::UPDATESFROM, - 'href' => common_local_url('ApiTimelineUser', - array('id' => $user->id, - 'format' => 'atom')), - 'type' => 'application/atom+xml'); - - // Salmon + $xrd->links[] = new XML_XRD_Element_Link(Discovery::UPDATESFROM, + common_local_url('ApiTimelineUser', + array('id' => $target->id, 'format' => 'atom')), + 'application/atom+xml'); + + // Salmon $salmon_url = common_local_url('usersalmon', - array('id' => $user->id)); - - $xrd->links[] = array('rel' => Salmon::REL_SALMON, - 'href' => $salmon_url); - // XXX : Deprecated - to be removed. - $xrd->links[] = array('rel' => Salmon::NS_REPLIES, - 'href' => $salmon_url); - - $xrd->links[] = array('rel' => Salmon::NS_MENTIONS, - 'href' => $salmon_url); - - // Get this user's keypair - $magickey = Magicsig::staticGet('user_id', $user->id); - if (!$magickey) { - // No keypair yet, let's generate one. - $magickey = new Magicsig(); - $magickey->generate($user->id); + array('id' => $target->id)); + + $xrd->links[] = new XML_XRD_Element_Link(Salmon::REL_SALMON, $salmon_url); + + // XXX: these are deprecated, but StatusNet only looks for NS_REPLIES + $xrd->links[] = new XML_XRD_Element_Link(Salmon::NS_REPLIES, $salmon_url); + $xrd->links[] = new XML_XRD_Element_Link(Salmon::NS_MENTIONS, $salmon_url); + + // Get this profile's keypair + $magicsig = Magicsig::getKV('user_id', $target->id); + if (!$magicsig instanceof Magicsig && $target->isLocal()) { + $magicsig = Magicsig::generate($target->getUser()); } - $xrd->links[] = array('rel' => Magicsig::PUBLICKEYREL, - 'href' => 'data:application/magic-public-key,'. $magickey->toString(false)); + if ($magicsig instanceof Magicsig) { + $xrd->links[] = new XML_XRD_Element_Link(Magicsig::PUBLICKEYREL, + 'data:application/magic-public-key,'. $magicsig->toString()); + } // TODO - finalize where the redirect should go on the publisher - $url = common_local_url('ostatussub') . '?profile={uri}'; - $xrd->links[] = array('rel' => 'http://ostatus.org/schema/1.0/subscribe', - 'template' => $url ); - - return true; + $xrd->links[] = new XML_XRD_Element_Link('http://ostatus.org/schema/1.0/subscribe', + common_local_url('ostatussub') . '?profile={uri}', + null, // type not set + true); // isTemplate + + return true; + } + + public function onGetLocalAttentions(Profile $actor, array $attention_uris, array &$mentions, array &$groups) + { + list($mentions, $groups) = Ostatus_profile::filterAttention($actor, $attention_uris); + } + + // FIXME: Maybe this shouldn't be so authoritative that it breaks other remote profile lookups? + static public function onCheckActivityAuthorship(Activity $activity, Profile &$profile) + { + try { + $oprofile = Ostatus_profile::getFromProfile($profile); + $oprofile = $oprofile->checkAuthorship($activity); + $profile = $oprofile->localProfile(); + } catch (Exception $e) { + common_log(LOG_ERR, 'Could not get a profile or check authorship ('.get_class($e).': "'.$e->getMessage().'")'); + $profile = null; + return false; + } + return true; + } + + public function onProfileDeleteRelated($profile, &$related) + { + // Ostatus_profile has a 'profile_id' property, which will be used to find the object + $related[] = 'Ostatus_profile'; + return true; } }