From ef6a986dc65c17abc99037fb3695a9918fd19fcd Mon Sep 17 00:00:00 2001 From: Diogo Cordeiro Date: Wed, 26 Aug 2020 23:55:36 +0100 Subject: [PATCH] [TheFreeNetwork] Do not allow lower priority protocols to handle remote actors already handled by the higher ones --- lib/exceptions/alreadyhandledexception.php | 40 +++++++++++++++++++ modules/TheFreeNetwork/EVENTS.txt | 2 +- modules/TheFreeNetwork/README.md | 2 +- .../TheFreeNetwork/TheFreeNetworkModule.php | 22 +++++++--- .../classes/Activitypub_profile.php | 2 - plugins/ActivityPub/lib/postman.php | 2 +- plugins/OStatus/lib/salmonaction.php | 8 +++- 7 files changed, 66 insertions(+), 12 deletions(-) create mode 100644 lib/exceptions/alreadyhandledexception.php diff --git a/lib/exceptions/alreadyhandledexception.php b/lib/exceptions/alreadyhandledexception.php new file mode 100644 index 0000000000..b341c01445 --- /dev/null +++ b/lib/exceptions/alreadyhandledexception.php @@ -0,0 +1,40 @@ +. +/** + * Class for exception thrown when something was already handled. + * Useful to use as a lock when handling a same something in different queues and only one should be attended + * + * @category Exception + * @author Diogo Cordeiro + * @copyright 2020 Free Software Foundation, Inc http://www.fsf.org + * @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later + */ + +defined('GNUSOCIAL') || die(); + +/** + * Exception thrown when something was already handled. + * + * @copyright 2019 Free Software Foundation, Inc http://www.fsf.org + * @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later + */ +class AlreadyHandledException extends ServerException +{ + public function __construct($msg) + { + parent::__construct($msg, 202); + } +} diff --git a/modules/TheFreeNetwork/EVENTS.txt b/modules/TheFreeNetwork/EVENTS.txt index 55bcbdefc2..0adb8d5266 100644 --- a/modules/TheFreeNetwork/EVENTS.txt +++ b/modules/TheFreeNetwork/EVENTS.txt @@ -1,7 +1,7 @@ StartTFNLookup: tries to locate a duplicated remote profile by URI; federation plugins must trigger this event before profile insertion @param string $uri URI of the remote profile to be inserted @param string $class profile class of the federation protocol that triggered the event -@param int|null &$profile_id profile ID associated with the duplicated remote profile found +@param int|null &$profile_id profile ID associated with the duplicated remote profile found, throws AlreadyHandledException to warn that the duplicate has priority EndTFNLookup: deletes a previous duplicated remote profile found; federation plugins must trigget this event after successfully inserting a new profile @param string $class profile class of the federation protocol that triggered the event diff --git a/modules/TheFreeNetwork/README.md b/modules/TheFreeNetwork/README.md index 4e64af7cf6..585a55a1ab 100644 --- a/modules/TheFreeNetwork/README.md +++ b/modules/TheFreeNetwork/README.md @@ -4,7 +4,7 @@ Making this possible essentially consists in not allowing duplication of remote and to ensure that each profile is handled by one and only one federation protocol at a time. Each newly added federation protocol **must** support all the already supported functionalities by the other federation -protocols, otherwise this module will be moving between FullFeaturedFederationProtocolProfile and LackyFederationProtocolProfile all the time. +protocols, otherwise if the LackyFederationProtocolProfile is preferred, the remote actors using it will be limited. You **must** feed this Module with the list of preferences for each federation protocol, more on that in the following section. diff --git a/modules/TheFreeNetwork/TheFreeNetworkModule.php b/modules/TheFreeNetwork/TheFreeNetworkModule.php index efa64ff2f6..c15195de75 100644 --- a/modules/TheFreeNetwork/TheFreeNetworkModule.php +++ b/modules/TheFreeNetwork/TheFreeNetworkModule.php @@ -42,6 +42,7 @@ class TheFreeNetworkModule extends Module const MODULE_VERSION = '0.1.0alpha0'; public $protocols = null; // protocols TFN should handle + public $priority = []; // protocols preferences private $lrdd = false; // whether LRDD plugin is active or not @@ -56,9 +57,12 @@ class TheFreeNetworkModule extends Module // require needed classes $plugin_dir = dirname(__DIR__, 2) . DIRECTORY_SEPARATOR . 'plugins'; + $p = 0; foreach ($this->protocols as $protocol => $class) { + $this->priority[$class] = $p++; require_once $plugin_dir . DIRECTORY_SEPARATOR . $protocol . DIRECTORY_SEPARATOR . 'classes' . DIRECTORY_SEPARATOR . $class . '.php'; } + unset($p); // $lrdd flag $this->lrdd = PluginList::isPluginActive("LRDD"); @@ -74,25 +78,31 @@ class TheFreeNetworkModule extends Module * @param string $class profile class that triggered this event * @param int|null &$profile_id Profile:id associated with the remote entity found * @return bool hook flag + * @throws AlreadyHandledException Do not allow to create a profile if a preferred protocol already has one */ public function onStartTFNLookup(string $uri, string $class, int &$profile_id = null): bool { - $profile_id = $this->lookup($uri, $class); + [$profile_id, $cls] = $this->lookup($uri, $class); if (is_null($profile_id)) { $perf = common_config('performance', 'high'); if (!$perf && $this->lrdd) { // Force lookup with online resources - $profile_id = $this->lookup($uri, $class, true); + [$profile_id, $cls] = $this->lookup($uri, $class, true); } } + // Lower means higher priority + if ($this->priority[$cls] < $this->priority[$class]) { + throw new AlreadyHandledException("TheFreeNetworkModule->AlreadyHandled: $cls is preferred over $class"); + } + return false; } /** - * A new remote profile was sucessfully added, delete + * A new remote profile was successfully added, delete * other remotes associated with the same Profile entity. * * @param string $class profile class that triggered this event @@ -146,9 +156,9 @@ class TheFreeNetworkModule extends Module * @param string $uri * @param string $class * @param bool $online - * @return int|null Profile:id associated with the remote entity found + * @return null|array [Profile:id, class] associated with the remote entity found */ - private function lookup(string $uri, string $class, bool $online = false): ?int + private function lookup(string $uri, string $class, bool $online = false): ?array { if ($online) { $this->log(LOG_INFO, 'Searching with online resources for a remote profile with URI: ' . $uri); @@ -169,7 +179,7 @@ class TheFreeNetworkModule extends Module $profile = $cls::getKV('uri', $alias); if ($profile instanceof $cls) { $this->log(LOG_INFO, 'Found a remote ' . $cls . ' associated with Profile:' . $profile->getID()); - return $profile->getID(); + return [$profile->getID(), $cls]; } } } diff --git a/plugins/ActivityPub/classes/Activitypub_profile.php b/plugins/ActivityPub/classes/Activitypub_profile.php index 3167e25be3..ebaee0acf8 100644 --- a/plugins/ActivityPub/classes/Activitypub_profile.php +++ b/plugins/ActivityPub/classes/Activitypub_profile.php @@ -285,8 +285,6 @@ class Activitypub_profile extends Managed_DataObject } $aprofile->created = $aprofile->modified = common_sql_now(); - - $aprofile = new Activitypub_profile; $aprofile->profile_id = $profile->getID(); $aprofile->uri = $url; $aprofile->nickname = $profile->getNickname(); diff --git a/plugins/ActivityPub/lib/postman.php b/plugins/ActivityPub/lib/postman.php index 2a02230bef..3d360f9674 100644 --- a/plugins/ActivityPub/lib/postman.php +++ b/plugins/ActivityPub/lib/postman.php @@ -49,7 +49,7 @@ class Activitypub_postman * Create a postman to deliver something to someone * * @param Profile $from sender Profile - * @param array $to receiver Profiles + * @param array $to receiver AProfiles * @throws Exception * @author Diogo Cordeiro */ diff --git a/plugins/OStatus/lib/salmonaction.php b/plugins/OStatus/lib/salmonaction.php index 6cd1473a14..91e3737445 100644 --- a/plugins/OStatus/lib/salmonaction.php +++ b/plugins/OStatus/lib/salmonaction.php @@ -287,7 +287,13 @@ class SalmonAction extends Action if (!$this->oprofile instanceof Ostatus_profile) { common_debug("We do not have a local profile to connect to this activity's author. Let's create one."); // ensureActivityObjectProfile throws exception on failure - $this->oprofile = Ostatus_profile::ensureActivityObjectProfile($this->activity->actor); + try { + $this->oprofile = Ostatus_profile::ensureActivityObjectProfile($this->activity->actor); + } catch (AlreadyHandledException $e) { + // Some other federation protocol is handling this profile, let it go. + common_debug('SalmonAction found that this actor already was handled by another federation protocol: ' . $e->getMessage()); + return; + } } }