83f179989e
Note that this commit isn't intended to add support for sending such notes in GS. Instead, we handle the reception, storage and direct reply to this type of notices, in AP. ActivityPubPlugin: - Subscribe the event StartNoticeSave to hack answering non-public notes Activitypub_create: - Add 'directMessage' attribute to the Create activity, defaulting to false for now - Update validation method: validate 'directMessage' and add debug Activitypub_notice: - Handle incoming unlisted/followers-only notes - Add support for unlisted-replies - Add method to verify private (direct) notices inbox_handler: - Add handler for CREATE Note - Prepare logic for private-messaging - Overall refactor: Class members were continuously being passed as function arguments without need SharePlugin: - Stop showing the announce button in non public posts
939 lines
32 KiB
PHP
939 lines
32 KiB
PHP
<?php
|
|
// This file is part of GNU social - https://www.gnu.org/software/social
|
|
//
|
|
// GNU social is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU Affero General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// GNU social is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU Affero General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Affero General Public License
|
|
// along with GNU social. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
/**
|
|
* ActivityPub implementation for GNU social
|
|
*
|
|
* @package GNUsocial
|
|
* @author Diogo Cordeiro <diogo@fc.up.pt>
|
|
* @copyright 2018-2019 Free Software Foundation, Inc http://www.fsf.org
|
|
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
|
|
* @link http://www.gnu.org/software/social/
|
|
*/
|
|
|
|
defined('GNUSOCIAL') || die();
|
|
|
|
// Import plugin libs
|
|
foreach (glob(__DIR__ . DIRECTORY_SEPARATOR . 'lib' . DIRECTORY_SEPARATOR . '*.php') as $filename) {
|
|
require_once $filename;
|
|
}
|
|
// Import plugin models
|
|
foreach (glob(__DIR__ . DIRECTORY_SEPARATOR . 'lib' . DIRECTORY_SEPARATOR . 'models' . DIRECTORY_SEPARATOR . '*.php') as $filename) {
|
|
require_once $filename;
|
|
}
|
|
|
|
// So that this isn't hardcoded everywhere
|
|
define('ACTIVITYPUB_BASE_ACTOR_URI', common_root_url().'index.php/user/');
|
|
const ACTIVITYPUB_PUBLIC_TO = ['https://www.w3.org/ns/activitystreams#Public',
|
|
'Public',
|
|
'as:Public'
|
|
];
|
|
|
|
/**
|
|
* @category Plugin
|
|
* @package GNUsocial
|
|
* @author Diogo Cordeiro <diogo@fc.up.pt>
|
|
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
|
|
*/
|
|
class ActivityPubPlugin extends Plugin
|
|
{
|
|
const PLUGIN_VERSION = '0.1.0alpha0';
|
|
|
|
/**
|
|
* Returns a Actor's URI from its local $profile
|
|
* Works both for local and remote users.
|
|
*
|
|
* @param Profile $profile Actor's local profile
|
|
* @return string Actor's URI
|
|
* @throws Exception
|
|
* @author Diogo Cordeiro <diogo@fc.up.pt>
|
|
*/
|
|
public static function actor_uri($profile)
|
|
{
|
|
if ($profile->isLocal()) {
|
|
return ACTIVITYPUB_BASE_ACTOR_URI.$profile->getID();
|
|
} else {
|
|
return $profile->getUri();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns a Actor's URL from its local $profile
|
|
* Works both for local and remote users.
|
|
*
|
|
* @param Profile $profile Actor's local profile
|
|
* @return string Actor's URL
|
|
* @throws Exception
|
|
* @author Diogo Cordeiro <diogo@fc.up.pt>
|
|
*/
|
|
public static function actor_url($profile)
|
|
{
|
|
return ActivityPubPlugin::actor_uri($profile)."/";
|
|
}
|
|
|
|
/**
|
|
* Returns a notice from its URL.
|
|
*
|
|
* @author Diogo Cordeiro <diogo@fc.up.pt>
|
|
* @param string $url Notice's URL
|
|
* @return Notice The Notice object
|
|
* @throws Exception This function or provides a Notice or fails with exception
|
|
*/
|
|
public static function grab_notice_from_url($url)
|
|
{
|
|
/* Offline Grabbing */
|
|
try {
|
|
// Look for a known remote notice
|
|
return Notice::getByUri($url);
|
|
} catch (Exception $e) {
|
|
// Look for a local notice (unfortunately GNU social doesn't
|
|
// provide this functionality natively)
|
|
try {
|
|
$candidate = Notice::getByID(intval(substr($url, (strlen(common_local_url('apNotice', ['id' => 0]))-1))));
|
|
if (common_local_url('apNotice', ['id' => $candidate->getID()]) === $url) { // Sanity check
|
|
return $candidate;
|
|
} else {
|
|
common_debug('ActivityPubPlugin Notice Grabber: '.$candidate->getUrl(). ' is different of '.$url);
|
|
}
|
|
} catch (Exception $e) {
|
|
common_debug('ActivityPubPlugin Notice Grabber: failed to find: '.$url.' offline.');
|
|
}
|
|
}
|
|
|
|
/* Online Grabbing */
|
|
$client = new HTTPClient();
|
|
$headers = [];
|
|
$headers[] = 'Accept: application/ld+json; profile="https://www.w3.org/ns/activitystreams"';
|
|
$headers[] = 'User-Agent: GNUSocialBot v0.1 - https://gnu.io/social';
|
|
$response = $client->get($url, $headers);
|
|
$object = json_decode($response->getBody(), true);
|
|
Activitypub_notice::validate_note($object);
|
|
return Activitypub_notice::create_notice($object);
|
|
}
|
|
|
|
/**
|
|
* Route/Reroute urls
|
|
*
|
|
* @param URLMapper $m
|
|
* @return void
|
|
* @throws Exception
|
|
*/
|
|
public function onRouterInitialized(URLMapper $m)
|
|
{
|
|
$acceptHeaders = [
|
|
'application/ld+json; profile="https://www.w3.org/ns/activitystreams"' => 0,
|
|
'application/activity+json' => 1,
|
|
'application/json' => 2,
|
|
'application/ld+json' => 3
|
|
];
|
|
|
|
$m->connect('user/:id',
|
|
['action' => 'apActorProfile'],
|
|
['id' => '[0-9]+'],
|
|
true,
|
|
$acceptHeaders);
|
|
|
|
$m->connect(':nickname',
|
|
['action' => 'apActorProfile'],
|
|
['nickname' => Nickname::DISPLAY_FMT],
|
|
true,
|
|
$acceptHeaders);
|
|
|
|
$m->connect(':nickname/',
|
|
['action' => 'apActorProfile'],
|
|
['nickname' => Nickname::DISPLAY_FMT],
|
|
true,
|
|
$acceptHeaders);
|
|
|
|
$m->connect('notice/:id',
|
|
['action' => 'apNotice'],
|
|
['id' => '[0-9]+'],
|
|
true,
|
|
$acceptHeaders);
|
|
|
|
$m->connect(
|
|
'user/:id/liked.json',
|
|
['action' => 'apActorLiked'],
|
|
['id' => '[0-9]+']
|
|
);
|
|
|
|
$m->connect(
|
|
'user/:id/followers.json',
|
|
['action' => 'apActorFollowers'],
|
|
['id' => '[0-9]+']
|
|
);
|
|
|
|
$m->connect(
|
|
'user/:id/following.json',
|
|
['action' => 'apActorFollowing'],
|
|
['id' => '[0-9]+']
|
|
);
|
|
|
|
$m->connect(
|
|
'user/:id/inbox.json',
|
|
['action' => 'apInbox'],
|
|
['id' => '[0-9]+']
|
|
);
|
|
|
|
$m->connect(
|
|
'user/:id/outbox.json',
|
|
['action' => 'apActorOutbox'],
|
|
['id' => '[0-9]+']
|
|
);
|
|
|
|
$m->connect(
|
|
'inbox.json',
|
|
['action' => 'apInbox']
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Plugin version information
|
|
*
|
|
* @param array $versions
|
|
* @return bool hook true
|
|
*/
|
|
public function onPluginVersion(array &$versions): bool
|
|
{
|
|
$versions[] = [
|
|
'name' => 'ActivityPub',
|
|
'version' => self::PLUGIN_VERSION,
|
|
'author' => 'Diogo Cordeiro',
|
|
'homepage' => 'https://notabug.org/diogo/gnu-social/src/activitypub/plugins/ActivityPub',
|
|
// TRANS: Plugin description.
|
|
'rawdescription' => _m('Follow people across social networks that implement '.
|
|
'<a href="https://activitypub.rocks/">ActivityPub</a>.')
|
|
];
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Set up queue handlers for required interactions
|
|
*
|
|
* @param QueueManager $qm
|
|
* @return bool event hook return
|
|
*/
|
|
public function onEndInitializeQueueManager(QueueManager $qm): bool
|
|
{
|
|
// Notice distribution
|
|
$qm->connect('activitypub', 'ActivityPubQueueHandler');
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Enqueue saved notices for distribution
|
|
*
|
|
* @param Notice $notice notice to be distributed
|
|
* @param Array &$transports list of transports to queue for
|
|
* @return bool event hook return
|
|
*/
|
|
public function onStartEnqueueNotice(Notice $notice, Array &$transports): bool
|
|
{
|
|
try {
|
|
$id = $notice->getID();
|
|
|
|
if ($id > 0) {
|
|
$transports[] = 'activitypub';
|
|
$this->log(LOG_INFO, "Notice:{$id} queued for distribution");
|
|
}
|
|
} catch (Exception $e) {
|
|
$this->log(LOG_ERR, "Invalid notice, not queueing for distribution");
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Update notice before saving.
|
|
* We'll use this as a hack to maintain replies to unlisted/followers-only
|
|
* notices away from the public timelines.
|
|
*
|
|
* @param Notice &$notice notice to be saved
|
|
* @return bool event hook return
|
|
*/
|
|
public function onStartNoticeSave(Notice &$notice): bool {
|
|
if ($notice->reply_to) {
|
|
try {
|
|
$parent = $notice->getParent();
|
|
$is_local = (int)$parent->is_local;
|
|
|
|
// if we're replying unlisted/followers-only notices received by AP
|
|
// or replying to replies of such notices, then we make sure to set
|
|
// the correct type flag.
|
|
if ( ($parent->source === 'ActivityPub' && $is_local === Notice::GATEWAY) ||
|
|
($parent->source === 'web' && $is_local === Notice::LOCAL_NONPUBLIC) ) {
|
|
$this->log(LOG_INFO, "Enforcing type flag LOCAL_NONPUBLIC for new notice");
|
|
$notice->is_local = Notice::LOCAL_NONPUBLIC;
|
|
}
|
|
} catch (NoParentNoticeException $e) {
|
|
// This is not a reply to something (has no parent)
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Plugin Nodeinfo information
|
|
*
|
|
* @param array $protocols
|
|
* @return bool hook true
|
|
*/
|
|
public function onNodeInfoProtocols(array &$protocols)
|
|
{
|
|
$protocols[] = "activitypub";
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Adds an indicator on Remote ActivityPub profiles.
|
|
*
|
|
* @param HTMLOutputter $out
|
|
* @param Profile $profile
|
|
* @return boolean hook return value
|
|
* @throws Exception
|
|
* @author Diogo Cordeiro <diogo@fc.up.pt>
|
|
*/
|
|
public function onEndShowAccountProfileBlock(HTMLOutputter $out, Profile $profile)
|
|
{
|
|
if ($profile->isLocal()) {
|
|
return true;
|
|
}
|
|
try {
|
|
Activitypub_profile::from_profile($profile);
|
|
} catch (Exception $e) {
|
|
// Not a remote ActivityPub_profile! Maybe some other network
|
|
// that has imported a non-local user (e.g.: OStatus)?
|
|
return true;
|
|
}
|
|
|
|
$out->elementStart('dl', 'entity_tags activitypub_profile');
|
|
$out->element('dt', null, 'ActivityPub');
|
|
$out->element('dd', null, _m('Remote Profile'));
|
|
$out->elementEnd('dl');
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Make sure necessary tables are filled out.
|
|
*
|
|
* @return boolean hook true
|
|
*/
|
|
public function onCheckSchema()
|
|
{
|
|
$schema = Schema::get();
|
|
$schema->ensureTable('activitypub_profile', Activitypub_profile::schemaDef());
|
|
$schema->ensureTable('activitypub_rsa', Activitypub_rsa::schemaDef());
|
|
$schema->ensureTable('activitypub_pending_follow_requests', Activitypub_pending_follow_requests::schemaDef());
|
|
return true;
|
|
}
|
|
|
|
/********************************************************
|
|
* WebFinger Events *
|
|
********************************************************/
|
|
|
|
/**
|
|
* Get remote user's ActivityPub_profile via a identifier
|
|
*
|
|
* @author GNU social
|
|
* @author Diogo Cordeiro <diogo@fc.up.pt>
|
|
* @param string $arg A remote user identifier
|
|
* @return Activitypub_profile|null Valid profile in success | null otherwise
|
|
*/
|
|
public static function pull_remote_profile($arg)
|
|
{
|
|
if (preg_match('!^((?:\w+\.)*\w+@(?:\w+\.)*\w+(?:\w+\-\w+)*\.\w+)$!', $arg)) {
|
|
// webfinger lookup
|
|
try {
|
|
return Activitypub_profile::ensure_web_finger($arg);
|
|
} catch (Exception $e) {
|
|
common_log(LOG_ERR, 'Webfinger lookup failed for ' .
|
|
$arg . ': ' . $e->getMessage());
|
|
}
|
|
}
|
|
|
|
// Look for profile URLs, with or without scheme:
|
|
$urls = [];
|
|
if (preg_match('!^https?://((?:\w+\.)*\w+(?:\w+\-\w+)*\.\w+(?:/\w+)+)$!', $arg)) {
|
|
$urls[] = $arg;
|
|
}
|
|
if (preg_match('!^((?:\w+\.)*\w+(?:\w+\-\w+)*\.\w+(?:/\w+)+)$!', $arg)) {
|
|
$schemes = array('http', 'https');
|
|
foreach ($schemes as $scheme) {
|
|
$urls[] = "$scheme://$arg";
|
|
}
|
|
}
|
|
|
|
foreach ($urls as $url) {
|
|
try {
|
|
return Activitypub_profile::fromUri($url);
|
|
} catch (Exception $e) {
|
|
common_log(LOG_ERR, 'Profile lookup failed for ' .
|
|
$arg . ': ' . $e->getMessage());
|
|
}
|
|
}
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Webfinger matches: @user@example.com or even @user--one.george_orwell@1984.biz
|
|
*
|
|
* @author GNU social
|
|
* @param string $text The text from which to extract webfinger IDs
|
|
* @param string $preMention Character(s) that signals a mention ('@', '!'...)
|
|
* @return array The matching IDs (without $preMention) and each respective position in the given string.
|
|
*/
|
|
public static function extractWebfingerIds($text, $preMention='@')
|
|
{
|
|
$wmatches = [];
|
|
$result = preg_match_all(
|
|
'/(?<!\S)'.preg_quote($preMention, '/').'('.Nickname::WEBFINGER_FMT.')/',
|
|
$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().').');
|
|
return [];
|
|
} elseif ($n_matches = count($wmatches)) {
|
|
common_debug(sprintf('Found %d matches for WebFinger IDs: %s', $n_matches, _ve($wmatches)));
|
|
}
|
|
return $wmatches[1];
|
|
}
|
|
|
|
/**
|
|
* Profile URL matches: @example.com/mublog/user
|
|
*
|
|
* @author GNU social
|
|
* @param string $text The text from which to extract URL mentions
|
|
* @param string $preMention Character(s) that signals a mention ('@', '!'...)
|
|
* @return array The matching URLs (without @ or acct:) and each respective position in the given string.
|
|
*/
|
|
public static function extractUrlMentions($text, $preMention='@')
|
|
{
|
|
$wmatches = [];
|
|
// 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+)'.preg_quote($preMention, '/').'('.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().').');
|
|
return [];
|
|
} elseif (count($wmatches)) {
|
|
common_debug(sprintf('Found %d matches for profile URL mentions: %s', count($wmatches), _ve($wmatches)));
|
|
}
|
|
return $wmatches[1];
|
|
}
|
|
|
|
/**
|
|
* Add activity+json mimetype on WebFinger
|
|
*
|
|
* @param XML_XRD $xrd
|
|
* @param Managed_DataObject $object
|
|
* @throws Exception
|
|
* @author Diogo Cordeiro <diogo@fc.up.pt>
|
|
*/
|
|
public function onEndWebFingerProfileLinks(XML_XRD $xrd, Managed_DataObject $object)
|
|
{
|
|
if ($object->isPerson()) {
|
|
$link = new XML_XRD_Element_Link(
|
|
'self',
|
|
ActivityPubPlugin::actor_uri($object->getProfile()),
|
|
'application/activity+json'
|
|
);
|
|
$xrd->links[] = clone($link);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Find any explicit remote mentions. Accepted forms:
|
|
* Webfinger: @user@example.com
|
|
* Profile link:
|
|
* @param Profile $sender
|
|
* @param string $text input markup text
|
|
* @param $mentions
|
|
* @return boolean hook return value
|
|
* @throws InvalidUrlException
|
|
* @author Diogo Cordeiro <diogo@fc.up.pt>
|
|
* @example.com/mublog/user
|
|
*
|
|
* @author GNU social
|
|
*/
|
|
public function onEndFindMentions(Profile $sender, $text, &$mentions)
|
|
{
|
|
$matches = [];
|
|
|
|
foreach (self::extractWebfingerIds($text, '@') as $wmatch) {
|
|
list($target, $pos) = $wmatch;
|
|
$this->log(LOG_INFO, "Checking webfinger person '$target'");
|
|
$profile = null;
|
|
try {
|
|
$aprofile = Activitypub_profile::ensure_web_finger($target);
|
|
$profile = $aprofile->local_profile();
|
|
} catch (Exception $e) {
|
|
$this->log(LOG_ERR, "Webfinger check failed: " . $e->getMessage());
|
|
continue;
|
|
}
|
|
assert($profile instanceof Profile);
|
|
|
|
$displayName = !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' => $displayName,
|
|
'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 {
|
|
$aprofile = Activitypub_profile::fromUri($url);
|
|
$profile = $aprofile->local_profile();
|
|
$displayName = !empty($profile->nickname) && mb_strlen($profile->nickname) < mb_strlen($target) ?
|
|
$profile->nickname : $target;
|
|
$matches[$pos] = array('mentioned' => array($profile),
|
|
'type' => 'mention',
|
|
'text' => $displayName,
|
|
'position' => $pos,
|
|
'length' => mb_strlen($target),
|
|
'url' => $profile->getUrl());
|
|
break;
|
|
} catch (Exception $e) {
|
|
$this->log(LOG_ERR, "Profile check failed: " . $e->getMessage());
|
|
}
|
|
}
|
|
}
|
|
|
|
foreach ($mentions as $i => $other) {
|
|
// If we share a common prefix with a local user, override it!
|
|
$pos = $other['position'];
|
|
if (isset($matches[$pos])) {
|
|
$mentions[$i] = $matches[$pos];
|
|
unset($matches[$pos]);
|
|
}
|
|
}
|
|
foreach ($matches as $mention) {
|
|
$mentions[] = $mention;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Allow remote profile references to be used in commands:
|
|
* sub update@status.net
|
|
* whois evan@identi.ca
|
|
* reply http://identi.ca/evan hey what's up
|
|
*
|
|
* @param Command $command
|
|
* @param string $arg
|
|
* @param Profile &$profile
|
|
* @return boolean hook return code
|
|
* @author GNU social
|
|
* @author Diogo Cordeiro <diogo@fc.up.pt>
|
|
*/
|
|
public function onStartCommandGetProfile($command, $arg, &$profile)
|
|
{
|
|
try {
|
|
$aprofile = $this->pull_remote_profile($arg);
|
|
$profile = $aprofile->local_profile();
|
|
} catch (Exception $e) {
|
|
// No remote ActivityPub profile found
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/********************************************************
|
|
* Discovery Events *
|
|
********************************************************/
|
|
|
|
/**
|
|
* Profile URI for remote profiles.
|
|
*
|
|
* @author GNU social
|
|
* @author Diogo Cordeiro <diogo@fc.up.pt>
|
|
* @param Profile $profile
|
|
* @param string $uri in/out
|
|
* @return mixed hook return code
|
|
*/
|
|
public function onStartGetProfileUri(Profile $profile, &$uri)
|
|
{
|
|
$aprofile = Activitypub_profile::getKV('profile_id', $profile->id);
|
|
if ($aprofile instanceof Activitypub_profile) {
|
|
$uri = $aprofile->getUri();
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Profile from URI.
|
|
*
|
|
* @author GNU social
|
|
* @author Diogo Cordeiro <diogo@fc.up.pt>
|
|
* @param string $uri
|
|
* @param Profile &$profile in/out param: Profile got from URI
|
|
* @return mixed hook return code
|
|
*/
|
|
public function onStartGetProfileFromURI($uri, &$profile)
|
|
{
|
|
try {
|
|
$explorer = new Activitypub_explorer();
|
|
$profile = $explorer->lookup($uri)[0];
|
|
return false;
|
|
} catch (Exception $e) {
|
|
return true; // It's not an ActivityPub profile as far as we know, continue event handling
|
|
}
|
|
}
|
|
|
|
/********************************************************
|
|
* Delivery Events *
|
|
********************************************************/
|
|
|
|
/**
|
|
* Having established a remote subscription, send a notification to the
|
|
* remote ActivityPub profile's endpoint.
|
|
*
|
|
* @param Profile $profile subscriber
|
|
* @param Profile $other subscribee
|
|
* @return bool return value
|
|
* @throws HTTP_Request2_Exception
|
|
* @author Diogo Cordeiro <diogo@fc.up.pt>
|
|
*/
|
|
public function onStartSubscribe(Profile $profile, Profile $other) {
|
|
if (!$profile->isLocal() && $other->isLocal()) {
|
|
return true;
|
|
}
|
|
|
|
try {
|
|
$other = Activitypub_profile::from_profile($other);
|
|
} catch (Exception $e) {
|
|
return true; // Let other plugin handle this instead
|
|
}
|
|
|
|
$postman = new Activitypub_postman($profile, array($other));
|
|
|
|
$postman->follow();
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Notify remote server on unsubscribe.
|
|
*
|
|
* @param Profile $profile
|
|
* @param Profile $other
|
|
* @return bool return value
|
|
* @throws HTTP_Request2_Exception
|
|
* @author Diogo Cordeiro <diogo@fc.up.pt>
|
|
*/
|
|
public function onStartUnsubscribe(Profile $profile, Profile $other)
|
|
{
|
|
if (!$profile->isLocal() && $other->isLocal()) {
|
|
return true;
|
|
}
|
|
|
|
try {
|
|
$other = Activitypub_profile::from_profile($other);
|
|
} catch (Exception $e) {
|
|
return true; // Let other plugin handle this instead
|
|
}
|
|
|
|
$postman = new Activitypub_postman($profile, array($other));
|
|
|
|
$postman->undo_follow();
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Notify remote users when their notices get favourited.
|
|
*
|
|
* @param Profile $profile of local user doing the faving
|
|
* @param Notice $notice Notice being favored
|
|
* @return bool return value
|
|
* @throws HTTP_Request2_Exception
|
|
* @throws InvalidUrlException
|
|
* @author Diogo Cordeiro <diogo@fc.up.pt>
|
|
*/
|
|
public function onEndFavorNotice(Profile $profile, Notice $notice)
|
|
{
|
|
// Only distribute local users' favor actions, remote users
|
|
// will have already distributed theirs.
|
|
if (!$profile->isLocal()) {
|
|
return true;
|
|
}
|
|
|
|
$other = [];
|
|
|
|
try {
|
|
$other[] = Activitypub_profile::from_profile($notice->getProfile());
|
|
} catch (Exception $e) {
|
|
// Local user can be ignored
|
|
}
|
|
|
|
$other = array_merge($other,
|
|
Activitypub_profile::from_profile_collection(
|
|
$notice->getAttentionProfiles()
|
|
));
|
|
|
|
if ($notice->reply_to) {
|
|
try {
|
|
$parent_notice = $notice->getParent();
|
|
|
|
try {
|
|
$other[] = Activitypub_profile::from_profile($parent_notice->getProfile());
|
|
} catch (Exception $e) {
|
|
// Local user can be ignored
|
|
}
|
|
|
|
$other = array_merge($other,
|
|
Activitypub_profile::from_profile_collection(
|
|
$parent_notice->getAttentionProfiles()
|
|
));
|
|
} catch (NoParentNoticeException $e) {
|
|
// This is not a reply to something (has no parent)
|
|
} catch (NoResultException $e) {
|
|
// Parent author's profile not found! Complain louder?
|
|
common_log(LOG_ERR, "Parent notice's author not found: ".$e->getMessage());
|
|
}
|
|
}
|
|
|
|
$postman = new Activitypub_postman($profile, $other);
|
|
$postman->like($notice);
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Notify remote users when their notices get de-favourited.
|
|
*
|
|
* @param Profile $profile of local user doing the de-faving
|
|
* @param Notice $notice Notice being favored
|
|
* @return bool return value
|
|
* @throws HTTP_Request2_Exception
|
|
* @throws InvalidUrlException
|
|
* @author Diogo Cordeiro <diogo@fc.up.pt>
|
|
*/
|
|
public function onEndDisfavorNotice(Profile $profile, Notice $notice)
|
|
{
|
|
// Only distribute local users' favor actions, remote users
|
|
// will have already distributed theirs.
|
|
if (!$profile->isLocal()) {
|
|
return true;
|
|
}
|
|
|
|
$other = [];
|
|
|
|
try {
|
|
$other[] = Activitypub_profile::from_profile($notice->getProfile());
|
|
} catch (Exception $e) {
|
|
// Local user can be ignored
|
|
}
|
|
|
|
$other = array_merge($other,
|
|
Activitypub_profile::from_profile_collection(
|
|
$notice->getAttentionProfiles()
|
|
));
|
|
|
|
if ($notice->reply_to) {
|
|
try {
|
|
$parent_notice = $notice->getParent();
|
|
|
|
try {
|
|
$other[] = Activitypub_profile::from_profile($parent_notice->getProfile());
|
|
} catch (Exception $e) {
|
|
// Local user can be ignored
|
|
}
|
|
|
|
$other = array_merge($other,
|
|
Activitypub_profile::from_profile_collection(
|
|
$parent_notice->getAttentionProfiles()
|
|
));
|
|
} catch (NoParentNoticeException $e) {
|
|
// This is not a reply to something (has no parent)
|
|
} catch (NoResultException $e) {
|
|
// Parent author's profile not found! Complain louder?
|
|
common_log(LOG_ERR, "Parent notice's author not found: ".$e->getMessage());
|
|
}
|
|
}
|
|
|
|
$postman = new Activitypub_postman($profile, $other);
|
|
$postman->undo_like($notice);
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Notify remote users when their notices get deleted
|
|
*
|
|
* @param $user
|
|
* @param $notice
|
|
* @return boolean hook flag
|
|
* @throws HTTP_Request2_Exception
|
|
* @throws InvalidUrlException
|
|
* @author Diogo Cordeiro <diogo@fc.up.pt>
|
|
*/
|
|
public function onStartDeleteOwnNotice($user, $notice)
|
|
{
|
|
$profile = $user->getProfile();
|
|
|
|
// Only distribute local users' delete actions, remote users
|
|
// will have already distributed theirs.
|
|
if (!$profile->isLocal()) {
|
|
return true;
|
|
}
|
|
|
|
// We handle things locally either because:
|
|
// 1. the deleting user has special permissions to do so,
|
|
// but still doesn't own the notice
|
|
// 2. the notice is an announce, and there's no undo-share
|
|
// logic in GS's AP implementation
|
|
if (!$notice->isLocal() || $notice->isRepeat()) {
|
|
return true;
|
|
}
|
|
|
|
$other = Activitypub_profile::from_profile_collection(
|
|
$notice->getAttentionProfiles()
|
|
);
|
|
|
|
if ($notice->reply_to) {
|
|
try {
|
|
$parent_notice = $notice->getParent();
|
|
|
|
try {
|
|
$other[] = Activitypub_profile::from_profile($parent_notice->getProfile());
|
|
} catch (Exception $e) {
|
|
// Local user can be ignored
|
|
}
|
|
|
|
$other = array_merge($other,
|
|
Activitypub_profile::from_profile_collection(
|
|
$parent_notice->getAttentionProfiles()
|
|
));
|
|
} catch (NoParentNoticeException $e) {
|
|
// This is not a reply to something (has no parent)
|
|
} catch (NoResultException $e) {
|
|
// Parent author's profile not found! Complain louder?
|
|
common_log(LOG_ERR, "Parent notice's author not found: ".$e->getMessage());
|
|
}
|
|
}
|
|
|
|
$postman = new Activitypub_postman($profile, $other);
|
|
$postman->delete($notice);
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Override the "from ActivityPub" bit in notice lists to link to the
|
|
* original post and show the domain it came from.
|
|
*
|
|
* @author Diogo Cordeiro <diogo@fc.up.pt>
|
|
* @param $notice
|
|
* @param $name
|
|
* @param $url
|
|
* @param $title
|
|
* @return mixed hook return code
|
|
* @throws Exception
|
|
*/
|
|
public function onStartNoticeSourceLink($notice, &$name, &$url, &$title)
|
|
{
|
|
// If we don't handle this, keep the event handler going
|
|
if (!in_array($notice->source, array('ActivityPub', 'share'))) {
|
|
return true;
|
|
}
|
|
|
|
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 ActivityPub'), $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;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Plugin return handler
|
|
*/
|
|
class ActivityPubReturn
|
|
{
|
|
/**
|
|
* Return a valid answer
|
|
*
|
|
* @param string $res
|
|
* @param int $code Status Code
|
|
* @return void
|
|
* @author Diogo Cordeiro <diogo@fc.up.pt>
|
|
*/
|
|
public static function answer($res = '', $code = 202)
|
|
{
|
|
http_response_code($code);
|
|
header('Content-Type: application/activity+json');
|
|
echo json_encode($res, JSON_UNESCAPED_SLASHES | (isset($_GET["pretty"]) ? JSON_PRETTY_PRINT : null));
|
|
exit;
|
|
}
|
|
|
|
/**
|
|
* Return an error
|
|
*
|
|
* @param string $m
|
|
* @param int $code Status Code
|
|
* @return void
|
|
* @author Diogo Cordeiro <diogo@fc.up.pt>
|
|
*/
|
|
public static function error($m, $code = 400)
|
|
{
|
|
http_response_code($code);
|
|
header('Content-Type: application/activity+json');
|
|
$res[] = Activitypub_error::error_message_to_array($m);
|
|
echo json_encode($res, JSON_UNESCAPED_SLASHES);
|
|
exit;
|
|
}
|
|
}
|