X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=plugins%2FOStatus%2FOStatusPlugin.php;h=5a871f322b1ac27cdb5b9beb722f7397e0b1e627;hb=2c8536dbf0ef8955987138a4c108bd83cd2ca0a2;hp=43b90cfbf7db7ef706b14cf7d469ecb7b3842459;hpb=c48cdc7d50cc2920e3f41e34e9b5e19638331dd9;p=quix0rs-gnu-social.git diff --git a/plugins/OStatus/OStatusPlugin.php b/plugins/OStatus/OStatusPlugin.php index 43b90cfbf7..5a871f322b 100644 --- a/plugins/OStatus/OStatusPlugin.php +++ b/plugins/OStatus/OStatusPlugin.php @@ -18,42 +18,29 @@ */ /** + * OStatusPlugin implementation for GNU Social + * + * Depends on: WebFinger plugin + * * @package OStatusPlugin * @maintainer Brion Vibber */ -if (!defined('STATUSNET')) { - exit(1); -} - -set_include_path(get_include_path() . PATH_SEPARATOR . dirname(__FILE__) . '/extlib/'); +if (!defined('GNUSOCIAL')) { exit(1); } -class FeedSubException extends Exception -{ - function __construct($msg=null) - { - $type = get_class($this); - if ($msg) { - parent::__construct("$type: $msg"); - } else { - parent::__construct($type); - } - } -} +set_include_path(get_include_path() . PATH_SEPARATOR . dirname(__FILE__) . '/extlib/phpseclib'); 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) + public function onRouterInitialized(URLMapper $m) { // Discovery actions - $m->connect('main/ownerxrd', - array('action' => 'ownerxrd')); $m->connect('main/ostatustag', array('action' => 'ostatustag')); $m->connect('main/ostatustag?nickname=:nickname', @@ -96,6 +83,20 @@ class OStatusPlugin extends Plugin return true; } + public function onAutoload($cls) + { + switch ($cls) { + case 'Crypt_AES': + case 'Crypt_RSA': + // Crypt_AES becomes Crypt/AES.php which is found in extlib/phpseclib/ + // which has been added to our include_path before + require_once str_replace('_', '/', $cls) . '.php'; + return false; + } + + return parent::onAutoload($cls); + } + /** * Set up queue handlers for outgoing hub pushes * @param QueueManager $qm @@ -125,36 +126,18 @@ class OStatusPlugin extends Plugin */ function onStartEnqueueNotice($notice, &$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}"); - } + 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 { - $this->log(LOG_NOTICE, "Not queueing notice {$notice->id} for OStatus because it's not local."); + // 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. @@ -192,7 +175,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)); } @@ -200,38 +183,6 @@ class OStatusPlugin extends Plugin return true; } - /** - * Automatically load the actions and libraries used by the plugin - * - * @param Class $cls the class - * - * @return boolean hook return - * - */ - function onAutoload($cls) - { - $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; - } - } - return true; - } - /** * Add in an OStatus subscribe button */ @@ -283,68 +234,6 @@ class OStatusPlugin extends Plugin return true; } - function onStartShowTagProfileForm($action, $profile) - { - $action->elementStart('form', array('method' => 'post', - 'id' => 'form_tag_user', - 'class' => 'form_settings', - 'name' => 'tagprofile', - 'action' => common_local_url('tagprofile', array('id' => @$profile->id)))); - - $action->elementStart('fieldset'); - // TRANS: Fieldset legend. - $action->element('legend', null, _m('List remote profile')); - $action->hidden('token', common_session_token()); - - $user = common_current_user(); - - $action->elementStart('ul', 'form_data'); - $action->elementStart('li'); - - // TRANS: Field label. - $action->input('uri', _m('LABEL','Remote profile'), $action->trimmed('uri'), - // TRANS: Field title. - _m('OStatus user\'s address, like nickname@example.com or http://example.net/nickname.')); - $action->elementEnd('li'); - $action->elementEnd('ul'); - // TRANS: Button text to fetch remote profile. - $action->submit('fetch', _m('BUTTON','Fetch')); - $action->elementEnd('fieldset'); - $action->elementEnd('form'); - } - - function onStartTagProfileAction($action, $profile) - { - $err = null; - $uri = $action->trimmed('uri'); - - 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); - return false; - - } 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 */ @@ -382,12 +271,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(); @@ -401,12 +290,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()); @@ -427,12 +317,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) { @@ -471,8 +362,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; @@ -493,7 +389,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 { @@ -550,7 +446,7 @@ class OStatusPlugin extends Plugin return true; } - function onEndShowStatusNetStyles($action) { + public function onEndShowStylesheets(Action $action) { $action->cssLink($this->path('theme/base/css/ostatus.css')); return true; } @@ -572,23 +468,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 (!in_array($notice->source, array('ostatus', 'share'))) { + return true; + } - $url = $notice->url; - // TRANS: Title. %s is a domain name. - $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; } /** @@ -600,8 +505,8 @@ 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"); @@ -619,8 +524,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; @@ -633,64 +538,55 @@ 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 thrown when setup of remote subscription fails. - 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; } @@ -703,17 +599,14 @@ class OStatusPlugin extends Plugin * @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; } @@ -738,8 +631,8 @@ class OStatusPlugin extends Plugin $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); @@ -755,45 +648,45 @@ class OStatusPlugin extends Plugin * @param Profile $profile * * @return mixed hook return value + * @throws Exception of various kinds, some from $oprofile->subscribe(); */ function onStartJoinGroup($group, $profile) { - $oprofile = Ostatus_profile::staticGet('group_id', $group->id); - if ($oprofile) { - if (!$oprofile->subscribe()) { - // TRANS: Exception thrown when setup of remote group membership fails. - throw new Exception(_m('Could not set up remote group membership.')); - } + $oprofile = Ostatus_profile::getKV('group_id', $group->id); + if (!$oprofile instanceof Ostatus_profile) { + return true; + } - // NOTE: we don't use Group_member::asActivity() since that record - // has not yet been created. - - $act = new Activity(); - $act->id = TagURI::mint('join:%d:%d:%s', - $profile->id, - $group->id, - common_date_iso8601(time())); - - $act->actor = ActivityObject::fromProfile($profile); - $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.')); - } + $oprofile->subscribe(); + + // NOTE: we don't use Group_member::asActivity() since that record + // has not yet been created. + + $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.')); } } @@ -813,34 +706,36 @@ class OStatusPlugin extends Plugin */ function onEndLeaveGroup($group, $profile) { - $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('group_id', $group->id); + if (!$oprofile instanceof Ostatus_profile) { + return true; + } - $member = $profile; + // Drop the PuSH subscription if there are no other subscribers. + $oprofile->garbageCollect(); - $act = new Activity(); - $act->id = TagURI::mint('leave:%d:%d:%s', - $member->id, - $group->id, - common_date_iso8601(time())); + $member = $profile; - $act->actor = ActivityObject::fromProfile($member); - $act->verb = ActivityVerb::LEAVE; - $act->object = $oprofile->asActivityObject(); + $act = new Activity(); + $act->id = TagURI::mint('leave:%d:%d:%s', + $member->id, + $group->id, + common_date_iso8601(time())); - $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()); + $act->actor = $member->asActivityObject(); + $act->verb = ActivityVerb::LEAVE; + $act->object = $oprofile->asActivityObject(); - $oprofile->notifyActivity($act, $member); - } + $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); } /** @@ -852,47 +747,47 @@ class OStatusPlugin extends Plugin * @param User $user * * @return mixed hook return value + * @throws Exception of various kinds, some from $oprofile->subscribe(); */ function onStartSubscribePeopletag($peopletag, $user) { - $oprofile = Ostatus_profile::staticGet('peopletag_id', $peopletag->id); - if ($oprofile) { - if (!$oprofile->subscribe()) { - // TRANS: Exception thrown when setup of remote list subscription fails. - throw new Exception(_m('Could not set up remote list subscription.')); - } + $oprofile = Ostatus_profile::getKV('peopletag_id', $peopletag->id); + if (!$oprofile instanceof Ostatus_profile) { + return true; + } - $sub = $user->getProfile(); - $tagger = Profile::staticGet($peopletag->tagger); - - $act = new Activity(); - $act->id = TagURI::mint('subscribe_peopletag:%d:%d:%s', - $sub->id, - $peopletag->id, - common_date_iso8601(time())); - - $act->actor = ActivityObject::fromProfile($sub); - $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.')); - } + $oprofile->subscribe(); + + $sub = $user->getProfile(); + $tagger = Profile::getKV($peopletag->tagger); + + $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.')); } } @@ -908,36 +803,38 @@ class OStatusPlugin extends Plugin function onEndUnsubscribePeopletag($peopletag, $user) { - $oprofile = Ostatus_profile::staticGet('peopletag_id', $peopletag->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; + } - $sub = Profile::staticGet($user->id); - $tagger = Profile::staticGet($peopletag->tagger); + // Drop the PuSH subscription if there are no other subscribers. + $oprofile->garbageCollect(); - $act = new Activity(); - $act->id = TagURI::mint('unsubscribe_peopletag:%d:%d:%s', - $sub->id, - $peopletag->id, - common_date_iso8601(time())); + $sub = Profile::getKV($user->id); + $tagger = Profile::getKV($peopletag->tagger); - $act->actor = ActivityObject::fromProfile($member); - $act->verb = ActivityVerb::UNFOLLOW; - $act->object = $oprofile->asActivityObject(); + $act = new Activity(); + $act->id = TagURI::mint('unsubscribe_peopletag:%d:%d:%s', + $sub->id, + $peopletag->id, + common_date_iso8601(time())); - $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()); + $act->actor = $member->asActivityObject(); + $act->verb = ActivityVerb::UNFOLLOW; + $act->object = $oprofile->asActivityObject(); - $oprofile->notifyActivity($act, $user); - } + $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); } /** @@ -949,23 +846,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; } @@ -983,12 +880,12 @@ class OStatusPlugin extends Plugin * * @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::staticGet('profile_id', $ptag->tagged); - - if (empty($oprofile)) { + $oprofile = Ostatus_profile::getKV('profile_id', $ptag->tagged); + if (!$oprofile instanceof Ostatus_profile) { return true; } @@ -1000,7 +897,7 @@ class OStatusPlugin extends Plugin $act = new Activity(); $tagger = $plist->getTagger(); - $tagged = Profile::staticGet('id', $ptag->tagged); + $tagged = Profile::getKV('id', $ptag->tagged); $act->verb = ActivityVerb::TAG; $act->id = TagURI::mint('tag_profile:%d:%d:%s', @@ -1016,19 +913,14 @@ class OStatusPlugin extends Plugin $tagged->getBestName(), $plist->getBestName()); - $act->actor = ActivityObject::fromProfile($tagger); - $act->objects = array(ActivityObject::fromProfile($tagged)); + $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 - if (!$oprofile->subscribe()) { - // TRANS: Exception thrown when subscribing to a remote list fails. - throw new Exception(sprintf(_m('Could not complete subscription to remote '. - 'profile\'s feed. List %s could not be saved.'), $ptag->tag)); - return false; - } + $oprofile->subscribe(); return true; } @@ -1043,9 +935,8 @@ class OStatusPlugin extends Plugin */ function onEndUntagProfile($ptag) { - $oprofile = Ostatus_profile::staticGet('profile_id', $ptag->tagged); - - if (empty($oprofile)) { + $oprofile = Ostatus_profile::getKV('profile_id', $ptag->tagged); + if (!$oprofile instanceof Ostatus_profile) { return true; } @@ -1057,7 +948,7 @@ class OStatusPlugin extends Plugin $act = new Activity(); $tagger = $plist->getTagger(); - $tagged = Profile::staticGet('id', $ptag->tagged); + $tagged = Profile::getKV('id', $ptag->tagged); $act->verb = ActivityVerb::UNTAG; $act->id = TagURI::mint('untag_profile:%d:%d:%s', @@ -1073,8 +964,8 @@ class OStatusPlugin extends Plugin $tagged->getBestName(), $plist->getBestName()); - $act->actor = ActivityObject::fromProfile($tagger); - $act->objects = array(ActivityObject::fromProfile($tagged)); + $act->actor = $tagger->asActivityObject(); + $act->objects = array($tagged->asActivityObject()); $act->target = ActivityObject::fromPeopletag($plist); $oprofile->notifyDeferred($act, $tagger); @@ -1095,15 +986,14 @@ class OStatusPlugin extends Plugin */ 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; } @@ -1121,10 +1011,10 @@ class OStatusPlugin extends Plugin // 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 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); @@ -1133,8 +1023,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; } @@ -1148,8 +1038,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; @@ -1187,8 +1077,12 @@ class OStatusPlugin extends Plugin function showEntityRemoteSubscribe($action, $target='ostatussub') { - $user = common_current_user(); - if ($user && ($user->id == $action->profile->id)) { + if (!$action->getScoped() instanceof Profile) { + // early return if we're not logged in + return true; + } + + if ($action->getScoped()->sameAs($action->getTarget())) { $action->elementStart('div', 'entity_actions'); $action->elementStart('p', array('id' => 'entity_remote_subscribe', 'class' => 'entity_subscribe')); @@ -1207,7 +1101,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. // @@ -1241,7 +1135,7 @@ class OStatusPlugin extends Plugin $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()) { @@ -1251,49 +1145,52 @@ class OStatusPlugin extends Plugin return true; } - function onStartProfileListItemActionElements($item, $profile=null) + // FIXME: This one can accept both an Action and a Widget. Confusing! Refactor to (HTMLOutputter $out, Profile $target)! + function onStartProfileListItemActionElements($item) { - if (!common_logged_in()) { - - $profileUser = User::staticGet('id', $item->profile->id); - - if (!empty($profileUser)) { - - if ($item instanceof Action) { - $output = $item; - $profile = $item->profile; - } else { - $output = $item->out; - } + if (common_logged_in()) { + // only non-logged in users get to see the "remote subscribe" form + return true; + } elseif (!$item->getTarget()->isLocal()) { + // we can (for now) only provide remote subscribe forms for local users + return true; + } - // Add an OStatus subscribe - $output->elementStart('li', 'entity_subscribe'); - $url = common_local_url('ostatusinit', - array('nickname' => $profileUser->nickname)); - $output->element('a', array('href' => $url, - 'class' => 'entity_remote_subscribe'), - // 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'); - } + if ($item instanceof ProfileAction) { + $output = $item; + } elseif ($item instanceof Widget) { + $output = $item->out; + } else { + // Bad $item class, don't know how to use this for outputting! + throw new ServerException('Bad item type for onStartProfileListItemActionElements'); } + // Add an OStatus subscribe + $output->elementStart('li', 'entity_subscribe'); + $url = common_local_url('ostatusinit', + array('nickname' => $item->getTarget()->getNickname())); + $output->element('a', array('href' => $url, + 'class' => 'entity_remote_subscribe'), + // 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' => $item->getTarget()->getNickname())); + $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. @@ -1312,10 +1209,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 { @@ -1334,9 +1230,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; } @@ -1349,7 +1245,7 @@ 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(); @@ -1358,55 +1254,146 @@ 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(); + $profiletype = $this->profileTypeString($author); + $salmon_url = common_local_url("{$profiletype}salmon", 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'); + if ($target->getObjectType() === ActivityObject::PERSON) { + $this->addWebFingerPersonLinks($xrd, $target); + } + + // Salmon + $profiletype = $this->profileTypeString($target); + $salmon_url = common_local_url("{$profiletype}salmon", array('id' => $target->id)); - // Salmon - $salmon_url = common_local_url('usersalmon', - array('id' => $user->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); + + // TODO - finalize where the redirect should go on the publisher + $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 - $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); + return true; + } - $xrd->links[] = array('rel' => Salmon::NS_MENTIONS, - 'href' => $salmon_url); + protected function profileTypeString(Profile $target) + { + // This is just used to have a definitive string response to "USERsalmon" or "GROUPsalmon" + switch ($target->getObjectType()) { + case ActivityObject::PERSON: + return 'user'; + case ActivityObject::GROUP: + return 'group'; + default: + throw new ServerException('Unknown profile type for WebFinger profile links'); + } + } - // 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); + protected function addWebFingerPersonLinks(XML_XRD $xrd, Profile $target) + { + $xrd->links[] = new XML_XRD_Element_Link(Discovery::UPDATESFROM, + common_local_url('ApiTimelineUser', + array('id' => $target->id, 'format' => 'atom')), + 'application/atom+xml'); + + // 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) { + return false; // value doesn't mean anything, just figured I'd indicate this function didn't do anything + } + if (Event::handle('StartAttachPubkeyToUserXRD', array($magicsig, $xrd, $target))) { + $xrd->links[] = new XML_XRD_Element_Link(Magicsig::PUBLICKEYREL, + 'data:application/magic-public-key,'. $magicsig->toString()); + // The following event handles plugins like Diaspora which add their own version of the Magicsig pubkey + Event::handle('EndAttachPubkeyToUserXRD', array($magicsig, $xrd, $target)); + } + } - // 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 ); + 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::ensureProfileURL($profile->getUrl()); + $profile = $oprofile->checkAuthorship($activity); + } catch (Exception $e) { + common_log(LOG_ERR, 'Could not get a profile or check authorship ('.get_class($e).': "'.$e->getMessage().'") for activity ID: '.$activity->id); + $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'; + + // Magicsig has a "user_id" column instead, so we have to delete it more manually: + $magicsig = Magicsig::getKV('user_id', $profile->id); + if ($magicsig instanceof Magicsig) { + $magicsig->delete(); + } return true; } + + public function onSalmonSlap($endpoint_uri, MagicEnvelope $magic_env, Profile $target=null) + { + $envxml = $magic_env->toXML($target); + + $headers = array('Content-Type: application/magic-envelope+xml'); + + try { + $client = new HTTPClient(); + $client->setBody($envxml); + $response = $client->post($endpoint_uri, $headers); + } catch (HTTP_Request2_Exception $e) { + common_log(LOG_ERR, "Salmon post to $endpoint_uri failed: " . $e->getMessage()); + return false; + } + if ($response->getStatus() === 422) { + 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())); + return true; + } + + // 200 OK is the best response + // 202 Accepted is what we get from Diaspora for example + if (!in_array($response->getStatus(), array(200, 202))) { + common_log(LOG_ERR, sprintf('Salmon (from profile %d) endpoint %s returned status %s: %s', + $magic_env->getActor()->getID(), $endpoint_uri, $response->getStatus(), $response->getBody())); + return true; + } + + // Since we completed the salmon slap, we discontinue the event + return false; + } }