123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290 |
- <?php
- declare(strict_types = 1);
- // {{{ License
- // 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
- * @category ActivityPub
- *
- * @author Diogo Peralta Cordeiro <@diogo.site>
- * @copyright 2018-2019, 2021 Free Software Foundation, Inc http://www.fsf.org
- * @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
- */
- namespace Plugin\ActivityPub\Util;
- use App\Core\HTTPClient;
- use App\Core\Log;
- use App\Util\Exception\NoSuchActorException;
- use Exception;
- use const JSON_UNESCAPED_SLASHES;
- use Plugin\ActivityPub\ActivityPub;
- use Plugin\ActivityPub\Entity\ActivitypubActor;
- use Symfony\Contracts\HttpClient\Exception\ClientExceptionInterface;
- use Symfony\Contracts\HttpClient\Exception\RedirectionExceptionInterface;
- use Symfony\Contracts\HttpClient\Exception\ServerExceptionInterface;
- use Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface;
- /**
- * ActivityPub's own Explorer
- *
- * Allows to discovery new remote actors
- *
- * @copyright 2021 Free Software Foundation, Inc http://www.fsf.org
- * @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
- */
- class Explorer
- {
- private array $discovered_activitypub_actor_profiles = [];
- /**
- * Shortcut function to get a single profile from its URL.
- *
- * @param bool $grab_online whether to try online grabbing, defaults to true
- *
- * @throws ClientExceptionInterface
- * @throws NoSuchActorException
- * @throws RedirectionExceptionInterface
- * @throws ServerExceptionInterface
- * @throws TransportExceptionInterface
- */
- public static function get_profile_from_url(string $url, bool $grab_online = true): ActivitypubActor
- {
- $discovery = new self();
- // Get valid Actor object
- $actor_profile = $discovery->lookup($url, $grab_online);
- if (!empty($actor_profile)) {
- return $actor_profile[0];
- }
- throw new NoSuchActorException('Invalid Actor.');
- }
- /**
- * Get every profile from the given URL
- * This function cleans the $this->discovered_actor_profiles array
- * so that there is no erroneous data
- *
- * @param string $url User's url
- * @param bool $grab_online whether to try online grabbing, defaults to true
- *
- * @throws ClientExceptionInterface
- * @throws NoSuchActorException
- * @throws RedirectionExceptionInterface
- * @throws ServerExceptionInterface
- * @throws TransportExceptionInterface
- *
- * @return array of Actor objects
- */
- public function lookup(string $url, bool $grab_online = true)
- {
- if (\in_array($url, ActivityPub::PUBLIC_TO)) {
- return [];
- }
- Log::debug('ActivityPub Explorer: Started now looking for ' . $url);
- $this->discovered_activitypub_actor_profiles = [];
- return $this->_lookup($url, $grab_online);
- }
- /**
- * Get every profile from the given URL
- * This is a recursive function that will accumulate the results on
- * $discovered_actor_profiles array
- *
- * @param string $url User's url
- * @param bool $grab_online whether to try online grabbing, defaults to true
- *
- * @throws ClientExceptionInterface
- * @throws NoSuchActorException
- * @throws RedirectionExceptionInterface
- * @throws ServerExceptionInterface
- * @throws TransportExceptionInterface
- *
- * @return array of ActivityPub Actor objects
- */
- private function _lookup(string $url, bool $grab_online = true): array
- {
- $grab_known = $this->grab_known_user($url);
- // First check if we already have it locally and, if so, return it.
- // If the known fetch fails and remote grab is required: store locally and return.
- if (!$grab_known && (!$grab_online || !$this->grab_remote_user($url))) {
- throw new NoSuchActorException('Actor not found.');
- }
- return $this->discovered_activitypub_actor_profiles;
- }
- /**
- * Get a known user profile from its URL and joins it on
- * $this->discovered_actor_profiles
- *
- * @param string $uri Actor's uri
- *
- * @throws Exception
- * @throws NoSuchActorException
- *
- * @return bool success state
- */
- private function grab_known_user(string $uri): bool
- {
- Log::debug('ActivityPub Explorer: Searching locally for ' . $uri . ' offline.');
- // Try standard ActivityPub route
- // Is this a known filthy little mudblood?
- $aprofile = self::get_aprofile_by_url($uri);
- if ($aprofile instanceof ActivitypubActor) {
- Log::debug('ActivityPub Explorer: Found a known Aprofile for ' . $uri);
- // We found something!
- $this->discovered_activitypub_actor_profiles[] = $aprofile;
- return true;
- } else {
- Log::debug('ActivityPub Explorer: Unable to find a known Aprofile for ' . $uri);
- }
- return false;
- }
- /**
- * Get a remote user(s) profile(s) from its URL and joins it on
- * $this->discovered_actor_profiles
- *
- * @param string $url User's url
- *
- * @throws ClientExceptionInterface
- * @throws NoSuchActorException
- * @throws RedirectionExceptionInterface
- * @throws ServerExceptionInterface
- * @throws TransportExceptionInterface
- *
- * @return bool success state
- */
- private function grab_remote_user(string $url): bool
- {
- Log::debug('ActivityPub Explorer: Trying to grab a remote actor for ' . $url);
- $response = HTTPClient::get($url, ['headers' => ACTIVITYPUB::HTTP_CLIENT_HEADERS]);
- $res = json_decode($response->getContent(), true);
- if ($response->getStatusCode() == 410) { // If it was deleted
- return true; // Nothing to add.
- } elseif (!HTTPClient::statusCodeIsOkay($response)) { // If it is unavailable
- return false; // Try to add at another time.
- }
- if (\is_null($res)) {
- Log::debug('ActivityPub Explorer: Invalid response returned from given Actor URL: ' . $res);
- return true; // Nothing to add.
- }
- if ($res['type'] === 'OrderedCollection') { // It's a potential collection of actors!!!
- Log::debug('ActivityPub Explorer: Found a collection of actors for ' . $url);
- $this->travel_collection($res['first']);
- return true;
- } else {
- try {
- $this->discovered_activitypub_actor_profiles[] = Model\Actor::fromJson(json_encode($res));
- return true;
- } catch (Exception $e) {
- Log::debug(
- 'ActivityPub Explorer: Invalid potential remote actor while grabbing remotely: ' . $url
- . '. He returned the following: ' . json_encode($res, JSON_UNESCAPED_SLASHES)
- . ' and the following exception: ' . $e->getMessage(),
- );
- return false;
- }
- }
- return false;
- }
- /**
- * Get a ActivityPub Profile from it's uri
- *
- * @param string $v URL
- *
- * @return ActivitypubActor|bool false if fails | Aprofile object if successful
- */
- public static function get_aprofile_by_url(string $v): ActivitypubActor|bool
- {
- $aprofile = ActivitypubActor::getByPK(['uri' => $v]);
- return \is_null($aprofile) ? false : ActivitypubActor::getByPK(['uri' => $v]);
- }
- /**
- * Allows the Explorer to transverse a collection of persons.
- *
- * @throws ClientExceptionInterface
- * @throws NoSuchActorException
- * @throws RedirectionExceptionInterface
- * @throws ServerExceptionInterface
- * @throws TransportExceptionInterface
- */
- private function travel_collection(string $url): bool
- {
- $response = HTTPClient::get($url, ['headers' => ACTIVITYPUB::HTTP_CLIENT_HEADERS]);
- $res = json_decode($response->getContent(), true);
- if (!isset($res['orderedItems'])) {
- return false;
- }
- foreach ($res['orderedItems'] as $profile) {
- if ($this->_lookup($profile) == false) {
- Log::debug('ActivityPub Explorer: Found an invalid actor for ' . $profile);
- }
- }
- // Go through entire collection
- if (!\is_null($res['next'])) {
- $this->travel_collection($res['next']);
- }
- return true;
- }
- /**
- * Get a remote user array from its URL (this function is only used for
- * profile updating and shall not be used for anything else)
- *
- * @param string $url User's url
- *
- * @throws ClientExceptionInterface
- * @throws Exception
- * @throws RedirectionExceptionInterface
- * @throws ServerExceptionInterface
- * @throws TransportExceptionInterface
- *
- * @return null|string If it is able to fetch, false if it's gone
- * // Exceptions when network issues or unsupported Activity format
- */
- public static function get_remote_user_activity(string $url): string|null
- {
- $response = HTTPClient::get($url, ['headers' => ACTIVITYPUB::HTTP_CLIENT_HEADERS]);
- // If it was deleted
- if ($response->getStatusCode() == 410) {
- return null;
- } elseif (!HTTPClient::statusCodeIsOkay($response)) { // If it is unavailable
- throw new Exception('Non Ok Status Code for given Actor URL.');
- }
- return $response->getContent();
- }
- }
|