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',
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
// Incoming from a foreign PuSH hub
$qm->connect('pushin', 'PushInQueueHandler');
+
+ // Re-subscribe feeds that need renewal
+ $qm->connect('pushrenew', 'PushRenewQueueHandler');
return true;
}
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);
-
- } 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.
{
$matches = array();
- // Webfinger matches: @user@example.com
- if (preg_match_all('!(?:^|\s+)@((?:\w+\.)*\w+@(?:\w+\-?\w+\.)*\w+(?:\w+\-\w+)*\.\w+)!',
+ $wmatches = array();
+ // Webfinger matches: @user@example.com or even @user--one.george_orwell@1984.biz
+ if (preg_match_all('!(?:^|\s+)@((?:\w+[\w\-\_\.]?)*(?:[\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'");
+ $profile = null;
try {
$oprofile = Ostatus_profile::ensureWebfinger($target);
- 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);
+ 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 getFancyName() 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);
}
}
// Profile matches: @example.com/mublog/user
- if (preg_match_all('!(?:^|\s+)@((?:\w+\.)*\w+(?:\w+\-\w+)*\.\w+(?:/\w+)+)!',
+ if (preg_match_all('!(?:^|\s+)@((?:\w+\.)*\w+(?:\w+\-\w+)*\.\w+(?:/\w+)*)!',
$text,
$wmatches,
PREG_OFFSET_CAPTURE)) {
$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),
'type' => 'mention',
- 'text' => $target,
+ 'text' => $text,
'position' => $pos,
- 'url' => $profile->profileurl);
+ 'length' => mb_strlen($target),
+ 'url' => $profile->getUrl());
break;
}
} catch (Exception $e) {
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 onStartNoticeSourceLink($notice, &$name, &$url, &$title)
{
// If we don't handle this, keep the event handler going
- if ($notice->source != 'ostatus') {
+ if (!in_array($notice->source, array('ostatus', 'share'))) {
return true;
}
$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);
$group->id,
common_date_iso8601(time()));
- $act->actor = ActivityObject::fromProfile($profile);
+ $act->actor = $profile->asActivityObject();
$act->verb = ActivityVerb::JOIN;
$act->object = $oprofile->asActivityObject();
$group->id,
common_date_iso8601(time()));
- $act->actor = ActivityObject::fromProfile($member);
+ $act->actor = $member->asActivityObject();
$act->verb = ActivityVerb::LEAVE;
$act->object = $oprofile->asActivityObject();
$peopletag->id,
common_date_iso8601(time()));
- $act->actor = ActivityObject::fromProfile($sub);
+ $act->actor = $sub->asActivityObject();
$act->verb = ActivityVerb::FOLLOW;
$act->object = $oprofile->asActivityObject();
$peopletag->id,
common_date_iso8601(time()));
- $act->actor = ActivityObject::fromProfile($member);
+ $act->actor = $member->asActivityObject();
$act->verb = ActivityVerb::UNFOLLOW;
$act->object = $oprofile->asActivityObject();
$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);
$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);
$profile->getBestName(),
$notice->getUrl());
- $act->actor = ActivityObject::fromProfile($profile);
- $act->object = ActivityObject::fromNotice($notice);
+ $act->actor = $profile->asActivityObject();
+ $act->object = $notice->asActivityObject();
$oprofile->notifyActivity($act, $profile);
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->actor = $profile->asActivityObject();
$act->object = $act->actor;
while ($oprofile->fetch()) {
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' => GNUSOCIAL_VERSION,
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
-
try {
$oprofile = Ostatus_profile::ensureProfileURI($uri);
$profile = $oprofile->localProfile();
function onEndWebFingerNoticeLinks(XML_XRD $xrd, Notice $target)
{
$author = $target->getProfile();
- $salmon_url = common_local_url('usersalmon', array('id' => $author->id));
+ $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 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')),
- 'application/atom+xml');
+ if ($target->getObjectType() === ActivityObject::PERSON) {
+ $this->addWebFingerPersonLinks($xrd, $target);
+ }
- // 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);
$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
+
+ 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) {
+ 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
- $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);
+ 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::getFromProfile($profile);
- $oprofile = $oprofile->checkAuthorship($activity);
- $profile = $oprofile->localProfile();
+ $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().'")');
+ 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 (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');
+ }
+ }
}