if (!defined('GNUSOCIAL')) { exit(1); }
-set_include_path(get_include_path() . PATH_SEPARATOR . dirname(__FILE__) . '/extlib/phpseclib');
-
-class FeedSubException extends Exception
-{
- function __construct($msg=null)
- {
- $type = get_class($this);
- if ($msg) {
- parent::__construct("$type: $msg");
- } else {
- parent::__construct($type);
- }
- }
-}
-
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/ostatustag',
// Incoming from a foreign PuSH hub
$qm->connect('pushin', 'PushInQueueHandler');
+
+ // Re-subscribe feeds that need renewal
+ $qm->connect('pushrenew', 'PushRenewQueueHandler');
return true;
}
*/
function onStartEnqueueNotice($notice, &$transports)
{
- if ($notice->inScope(null)) {
+ if ($notice->inScope(null) && $notice->getProfile()->hasRight(Right::PUBLICNOTICE)) {
// 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");
+ $this->log(LOG_INFO, "OSTATUS [{$notice->getID()}]: 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}");
+ $this->log(LOG_NOTICE, "OSTATUS [{$notice->getID()}]: Not queueing because of privacy; scope = {$notice->scope}");
}
return true;
}
$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));
}
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
*/
$profile->whereAdd('uri LIKE "%' . $profile->escape($q) . '%"');
$profile->query();
+ $validate = new Validate();
+
if ($profile->N == 0) {
try {
- if (Validate::email($q)) {
+ if ($validate->email($q)) {
$oprofile = Ostatus_profile::ensureWebfinger($q);
- } else if (Validate::uri($q)) {
+ } else if ($validate->uri($q)) {
$oprofile = Ostatus_profile::ensureProfileURL($q);
} else {
// TRANS: Exception in OStatus when invalid URI was entered.
return true;
}
+ /**
+ * Webfinger matches: @user@example.com or even @user--one.george_orwell@1984.biz
+ *
+ * @return array The matching IDs (without @ or acct:) and each respective position in the given string.
+ */
+ static function extractWebfingerIds($text)
+ {
+ $wmatches = array();
+ // Maybe this should harmonize with lib/nickname.php and Nickname::WEBFINGER_FMT
+ $result = preg_match_all('/(?<!\S)@((?:\w+[\w\-\_\.]*)?\w+@'.URL_REGEX_DOMAIN_NAME.')/',
+ $text,
+ $wmatches,
+ PREG_OFFSET_CAPTURE);
+ if ($result === false) {
+ common_log(LOG_ERR, __METHOD__ . ': Error parsing webfinger IDs from text (preg_last_error=='.preg_last_error().').');
+ } elseif (count($wmatches)) {
+ common_debug(sprintf('Found %d matches for WebFinger IDs: %s', count($wmatches), _ve($wmatches)));
+ }
+ return $wmatches[1];
+ }
+
+ /**
+ * Profile URL matches: @example.com/mublog/user
+ *
+ * @return array The matching URLs (without @ or acct:) and each respective position in the given string.
+ */
+ static function extractUrlMentions($text)
+ {
+ $wmatches = array();
+ // In the regexp below we need to match / _before_ URL_REGEX_VALID_PATH_CHARS because it otherwise gets merged
+ // with the TLD before (but / is in URL_REGEX_VALID_PATH_CHARS anyway, it's just its positioning that is important)
+ $result = preg_match_all('/(?:^|\s+)@('.URL_REGEX_DOMAIN_NAME.'(?:\/['.URL_REGEX_VALID_PATH_CHARS.']*)*)/',
+ $text,
+ $wmatches,
+ PREG_OFFSET_CAPTURE);
+ if ($result === false) {
+ common_log(LOG_ERR, __METHOD__ . ': Error parsing profile URL mentions from text (preg_last_error=='.preg_last_error().').');
+ } elseif (count($wmatches)) {
+ common_debug(sprintf('Found %d matches for profile URL mentions: %s', count($wmatches), _ve($wmatches)));
+ }
+ return $wmatches[1];
+ }
+
/**
* 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();
- // Webfinger matches: @user@example.com
- if (preg_match_all('!(?:^|\s+)@((?:\w+\.)*\w+@(?:\w+\-?\w+\.)*\w+(?:\w+\-\w+)*\.\w+)!',
- $text,
- $wmatches,
- PREG_OFFSET_CAPTURE)) {
- foreach ($wmatches[1] as $wmatch) {
- list($target, $pos) = $wmatch;
- $this->log(LOG_INFO, "Checking webfinger '$target'");
+ foreach (self::extractWebfingerIds($text) as $wmatch) {
+ list($target, $pos) = $wmatch;
+ $this->log(LOG_INFO, "Checking webfinger '$target'");
+ $profile = null;
+ try {
+ $oprofile = Ostatus_profile::ensureWebfinger($target);
+ if (!$oprofile instanceof Ostatus_profile || !$oprofile->isPerson()) {
+ continue;
+ }
+ $profile = $oprofile->localProfile();
+ } catch (OStatusShadowException $e) {
+ // This means we got a local user in the webfinger lookup
+ $profile = $e->profile;
+ } catch (Exception $e) {
+ $this->log(LOG_ERR, "Webfinger check failed: " . $e->getMessage());
+ continue;
+ }
+
+ assert($profile instanceof Profile);
+
+ $text = !empty($profile->nickname) && mb_strlen($profile->nickname) < mb_strlen($target)
+ ? $profile->getNickname() // TODO: we could do getBestName() or getFullname() here
+ : $target;
+ $url = $profile->getUri();
+ if (!common_valid_http_url($url)) {
+ $url = $profile->getUrl();
+ }
+ $matches[$pos] = array('mentioned' => array($profile),
+ 'type' => 'mention',
+ 'text' => $text,
+ 'position' => $pos,
+ 'length' => mb_strlen($target),
+ 'url' => $url);
+ }
+
+ foreach (self::extractUrlMentions($text) as $wmatch) {
+ list($target, $pos) = $wmatch;
+ $schemes = array('https', 'http');
+ foreach ($schemes as $scheme) {
+ $url = "$scheme://$target";
+ $this->log(LOG_INFO, "Checking profile address '$url'");
try {
- $oprofile = Ostatus_profile::ensureWebfinger($target);
- if ($oprofile && !$oprofile->isGroup()) {
+ $oprofile = Ostatus_profile::ensureProfileURL($url);
+ if ($oprofile instanceof Ostatus_profile && !$oprofile->isGroup()) {
$profile = $oprofile->localProfile();
+ $text = !empty($profile->nickname) && mb_strlen($profile->nickname) < mb_strlen($target) ?
+ $profile->nickname : $target;
$matches[$pos] = array('mentioned' => array($profile),
- 'text' => $target,
+ 'type' => 'mention',
+ 'text' => $text,
'position' => $pos,
- 'url' => $profile->profileurl);
+ 'length' => mb_strlen($target),
+ 'url' => $profile->getUrl());
+ break;
}
} catch (Exception $e) {
- $this->log(LOG_ERR, "Webfinger check failed: " . $e->getMessage());
- }
- }
- }
-
- // Profile matches: @example.com/mublog/user
- if (preg_match_all('!(?:^|\s+)@((?:\w+\.)*\w+(?:\w+\-\w+)*\.\w+(?:/\w+)+)!',
- $text,
- $wmatches,
- PREG_OFFSET_CAPTURE)) {
- foreach ($wmatches[1] as $wmatch) {
- list($target, $pos) = $wmatch;
- $schemes = array('http', 'https');
- foreach ($schemes as $scheme) {
- $url = "$scheme://$target";
- $this->log(LOG_INFO, "Checking profile address '$url'");
- try {
- $oprofile = Ostatus_profile::ensureProfileURL($url);
- if ($oprofile && !$oprofile->isGroup()) {
- $profile = $oprofile->localProfile();
- $matches[$pos] = array('mentioned' => array($profile),
- 'text' => $target,
- 'position' => $pos,
- 'url' => $profile->profileurl);
- break;
- }
- } catch (Exception $e) {
- $this->log(LOG_ERR, "Profile check failed: " . $e->getMessage());
- }
+ $this->log(LOG_ERR, "Profile check failed: " . $e->getMessage());
}
}
}
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;
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 {
return null;
}
+ function onEndProfileSettingsActions($out) {
+ $siteName = common_config('site', 'name');
+ $js = 'navigator.registerContentHandler("application/vnd.mozilla.maybe.feed", "'.addslashes(common_local_url('ostatussub', null, array('profile' => '%s'))).'", "'.addslashes($siteName).'")';
+ $out->elementStart('li');
+ $out->element('a',
+ array('href' => 'javascript:'.$js),
+ // TRANS: Option in profile settings to add this instance to Firefox as a feedreader
+ _('Add to Firefox as feedreader'));
+ $out->elementEnd('li');
+ }
+
/**
* Make sure necessary tables are filled out.
*/
function onCheckSchema() {
$schema = Schema::get();
$schema->ensureTable('ostatus_profile', Ostatus_profile::schemaDef());
- $schema->ensureTable('ostatus_source', Ostatus_source::schemaDef());
$schema->ensureTable('feedsub', FeedSub::schemaDef());
$schema->ensureTable('hubsub', HubSub::schemaDef());
$schema->ensureTable('magicsig', Magicsig::schemaDef());
*/
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;
}
/**
function onStartFeedSubReceive($feedsub, $feed)
{
$oprofile = Ostatus_profile::getKV('feeduri', $feedsub->uri);
- if ($oprofile) {
+ if ($oprofile instanceof Ostatus_profile) {
$oprofile->processFeed($feed, 'push');
} else {
common_log(LOG_DEBUG, "No ostatus profile for incoming feed $feedsub->uri");
function onFeedSubSubscriberCount($feedsub, &$count)
{
$oprofile = Ostatus_profile::getKV('feeduri', $feedsub->uri);
- if ($oprofile) {
+ if ($oprofile instanceof Ostatus_profile) {
$count += $oprofile->subscriberCount();
}
return true;
}
$oprofile = Ostatus_profile::getKV('profile_id', $other->id);
-
- if (empty($oprofile)) {
+ 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();
}
/**
}
$oprofile = Ostatus_profile::getKV('profile_id', $other->id);
-
- if (empty($oprofile)) {
+ if (!$oprofile instanceof Ostatus_profile) {
return true;
}
}
$oprofile = Ostatus_profile::getKV('profile_id', $other->id);
-
- if (empty($oprofile)) {
+ if (!$oprofile instanceof Ostatus_profile) {
return true;
}
$profile->getBestName(),
$other->getBestName());
- $act->actor = ActivityObject::fromProfile($profile);
- $act->object = ActivityObject::fromProfile($other);
+ $act->actor = $profile->asActivityObject();
+ $act->objects[] = $other->asActivityObject();
$oprofile->notifyActivity($act, $profile);
* @param Profile $profile
*
* @return mixed hook return value
+ * @throws Exception of various kinds, some from $oprofile->subscribe();
*/
function onStartJoinGroup($group, $profile)
{
$oprofile = Ostatus_profile::getKV('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.'));
- }
+ 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->objects[] = $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.'));
}
}
function onEndLeaveGroup($group, $profile)
{
$oprofile = Ostatus_profile::getKV('group_id', $group->id);
- if ($oprofile) {
- // Drop the PuSH subscription if there are no other subscribers.
- $oprofile->garbageCollect();
+ 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->objects[] = $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);
}
/**
* @param User $user
*
* @return mixed hook return value
+ * @throws Exception of various kinds, some from $oprofile->subscribe();
*/
function onStartSubscribePeopletag($peopletag, $user)
{
$oprofile = Ostatus_profile::getKV('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.'));
- }
+ if (!$oprofile instanceof Ostatus_profile) {
+ return true;
+ }
- $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 = 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->objects[] = $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.'));
}
}
function onEndUnsubscribePeopletag($peopletag, $user)
{
$oprofile = Ostatus_profile::getKV('peopletag_id', $peopletag->id);
- if ($oprofile) {
- // Drop the PuSH subscription if there are no other subscribers.
- $oprofile->garbageCollect();
+ if (!$oprofile instanceof Ostatus_profile) {
+ return true;
+ }
- $sub = Profile::getKV($user->id);
- $tagger = Profile::getKV($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->objects[] = $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);
}
/**
*/
function onEndFavorNotice(Profile $profile, Notice $notice)
{
- $user = User::getKV('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::getKV('profile_id', $notice->profile_id);
-
- if (empty($oprofile)) {
+ 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;
}
*
* @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 (empty($oprofile)) {
+ if (!$oprofile instanceof Ostatus_profile) {
return true;
}
$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;
}
function onEndUntagProfile($ptag)
{
$oprofile = Ostatus_profile::getKV('profile_id', $ptag->tagged);
-
- if (empty($oprofile)) {
+ if (!$oprofile instanceof Ostatus_profile) {
return true;
}
$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);
*/
function onEndDisfavorNotice(Profile $profile, Notice $notice)
{
- $user = User::getKV('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::getKV('profile_id', $notice->profile_id);
-
- if (empty($oprofile)) {
+ if (!$oprofile instanceof Ostatus_profile) {
return true;
}
// 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->objects[] = $notice->asActivityObject();
$oprofile->notifyActivity($act, $profile);
function onStartGetProfileUri($profile, &$uri)
{
$oprofile = Ostatus_profile::getKV('profile_id', $profile->id);
- if (!empty($oprofile)) {
+ if ($oprofile instanceof Ostatus_profile) {
$uri = $oprofile->uri;
return false;
}
function onStartUserGroupPermalink($group, &$url)
{
$oprofile = Ostatus_profile::getKV('group_id', $group->id);
- if ($oprofile) {
+ 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;
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'));
$act->content = sprintf(_m('%s has updated their profile page.'),
$profile->getBestName());
- $act->actor = ActivityObject::fromProfile($profile);
- $act->object = $act->actor;
+ $act->actor = $profile->asActivityObject();
+ $act->objects[] = $act->actor;
while ($oprofile->fetch()) {
$oprofile->notifyDeferred($act, $profile);
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::getKV('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',
+ 'homepage' => 'https://git.gnu.io/gnu/gnu-social/tree/master/plugins/OStatus',
// TRANS: Plugin description.
'rawdescription' => _m('Follow people across social networks that implement '.
'<a href="http://ostatus.org/">OStatus</a>.'));
public static function localGroupFromUrl($url)
{
$group = User_group::getKV('uri', $url);
- if ($group) {
- $local = Local_group::getKV('group_id', $group->id);
- if ($local) {
+ if ($group instanceof User_group) {
+ if ($group->isLocal()) {
return $group->id;
}
} else {
{
$oprofile = Ostatus_profile::getKV('profile_id', $profile->id);
- if (empty($oprofile)) {
+ if (!$oprofile instanceof Ostatus_profile) {
return true;
}
function onStartGetProfileFromURI($uri, &$profile)
{
// Don't want to do Web-based discovery on our own server,
- // so we check locally first.
+ // so we check locally first. This duplicates the functionality
+ // in the Profile class, since the plugin always runs before
+ // that local lookup, but since we return false it won't run double.
$user = User::getKV('uri', $uri);
-
- if (!empty($user)) {
+ if ($user instanceof User) {
$profile = $user->getProfile();
return false;
+ } else {
+ $group = User_group::getKV('uri', $uri);
+ if ($group instanceof User_group) {
+ $profile = $group->getProfile();
+ return false;
+ }
}
// 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)
+ {
+ $salmon_url = null;
+ $actor = $target->getProfile();
+ if ($actor->isLocal()) {
+ $profiletype = $this->profileTypeString($actor);
+ $salmon_url = common_local_url("{$profiletype}salmon", array('id' => $actor->getID()));
+ } else {
+ try {
+ $oprofile = Ostatus_profile::fromProfile($actor);
+ $salmon_url = $oprofile->salmonuri;
+ } catch (Exception $e) {
+ // Even though it's not a local user, we couldn't get an Ostatus_profile?!
+ }
+ }
+ // Ostatus_profile salmon URL may be empty
+ if (!empty($salmon_url)) {
+ $xrd->links[] = new XML_XRD_Element_Link(Salmon::REL_SALMON, $salmon_url);
+ }
return true;
}
- function onEndXrdActionLinks(XML_XRD $xrd, Profile $target)
+ function onEndWebFingerProfileLinks(XML_XRD $xrd, Profile $target)
{
- $xrd->links[] = new XML_XRD_Element_Link(Discovery::UPDATESFROM,
- common_local_url('ApiTimelineUser',
- array('id' => $target->id, 'format' => 'atom')),
+ if ($target->getObjectType() === ActivityObject::PERSON) {
+ $this->addWebFingerPersonLinks($xrd, $target);
+ } elseif ($target->getObjectType() === ActivityObject::GROUP) {
+ $xrd->links[] = new XML_XRD_Element_Link(Discovery::UPDATESFROM,
+ common_local_url('ApiTimelineGroup',
+ array('id' => $target->getGroup()->getID(), 'format' => 'atom')),
'application/atom+xml');
- // Salmon
- $salmon_url = common_local_url('usersalmon',
- array('id' => $target->id));
+ }
+
+ // Salmon
+ $profiletype = $this->profileTypeString($target);
+ $salmon_url = common_local_url("{$profiletype}salmon", array('id' => $target->id));
$xrd->links[] = new XML_XRD_Element_Link(Salmon::REL_SALMON, $salmon_url);
- // XXX : Deprecated - to be removed.
+
+ // 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 user's keypair
- $magickey = Magicsig::getKV('user_id', $target->id);
- if (!($magickey instanceof Magicsig)) {
- // No keypair yet, let's generate one.
- $magickey = new Magicsig();
- $magickey->generate($target->id);
- }
-
- $xrd->links[] = new XML_XRD_Element_Link(Magicsig::PUBLICKEYREL,
- 'data:application/magic-public-key,'. $magickey->toString(false));
-
// 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}',
return true;
}
+
+ 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');
+ }
+ }
+
+ 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());
+ }
+
+ 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));
+ }
+ }
+
+ public function onGetLocalAttentions(Profile $actor, array $attention_uris, array &$mentions, array &$groups)
+ {
+ list($groups, $mentions) = 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)
+ {
+ try {
+ $envxml = $magic_env->toXML($target);
+ } catch (Exception $e) {
+ common_log(LOG_ERR, sprintf('Could not generate Magic Envelope XML for profile id=='.$target->getID().': '.$e->getMessage()));
+ return false;
+ }
+
+ $headers = array('Content-Type: application/magic-envelope+xml');
+
+ try {
+ $client = new HTTPClient();
+ $client->setBody($envxml);
+ $response = $client->post($endpoint_uri, $headers);
+ } catch (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;
+ }
+
+ public function onCronDaily()
+ {
+ try {
+ $sub = FeedSub::renewalCheck();
+ } catch (NoResultException $e) {
+ common_log(LOG_INFO, "There were no expiring feeds.");
+ return;
+ }
+
+ $qm = QueueManager::get();
+ while ($sub->fetch()) {
+ $item = array('feedsub_id' => $sub->id);
+ $qm->enqueue($item, 'pushrenew');
+ }
+ }
}