* @copyright 2018, Maxence Lange * @license GNU AGPL version 3 or any later version * * This program 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. * * This program 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 this program. If not, see . * */ namespace OCA\Social\Controller; use daita\MySmallPhpTools\Traits\Nextcloud\TNCDataResponse; use daita\MySmallPhpTools\Traits\TAsync; use daita\MySmallPhpTools\Traits\TStringTools; use Exception; use OC\AppFramework\Http; use OCA\Social\AppInfo\Application; use OCA\Social\Exceptions\SignatureIsGoneException; use OCA\Social\Exceptions\ItemUnknownException; use OCA\Social\Exceptions\UrlCloudException; use OCA\Social\Service\CacheActorService; use OCA\Social\Service\FollowService; use OCA\Social\Service\ImportService; use OCA\Social\Service\MiscService; use OCA\Social\Service\SignatureService; use OCA\Social\Service\StreamQueueService; use OCP\AppFramework\Controller; use OCP\AppFramework\Http\Response; use OCP\IRequest; class ActivityPubController extends Controller { use TNCDataResponse; use TStringTools; use TAsync; /** @var SocialPubController */ private $socialPubController; /** @var CacheActorService */ private $cacheActorService; /** @var SignatureService */ private $signatureService; /** @var StreamQueueService */ private $streamQueueService; /** @var ImportService */ private $importService; /** @var FollowService */ private $followService; /** @var MiscService */ private $miscService; /** * ActivityPubController constructor. * * @param IRequest $request * @param SocialPubController $socialPubController * @param CacheActorService $cacheActorService * @param SignatureService $signatureService * @param StreamQueueService $streamQueueService * @param ImportService $importService * @param FollowService $followService * @param MiscService $miscService */ public function __construct( IRequest $request, SocialPubController $socialPubController, CacheActorService $cacheActorService, SignatureService $signatureService, StreamQueueService $streamQueueService, ImportService $importService, FollowService $followService, MiscService $miscService ) { parent::__construct(Application::APP_NAME, $request); $this->socialPubController = $socialPubController; $this->cacheActorService = $cacheActorService; $this->signatureService = $signatureService; $this->streamQueueService = $streamQueueService; $this->importService = $importService; $this->followService = $followService; $this->miscService = $miscService; } /** * returns information about an Actor, based on the username. * * This method should be called when a remote ActivityPub server require information * about a local Social account * * The format is pure Json * * @NoCSRFRequired * @PublicPage * * @param string $username * * @return Response * @throws UrlCloudException */ public function actor(string $username): Response { if (!$this->checkSourceActivityStreams()) { return $this->socialPubController->actor($username); } try { $actor = $this->cacheActorService->getFromLocalAccount($username); $actor->setDisplayW3ContextSecurity(true); return $this->directSuccess($actor); } catch (Exception $e) { http_response_code(404); exit(); } } /** * Alias to the actor() method. * * Normal path is /apps/social/users/username * This alias is /apps/social/@username * * @NoCSRFRequired * @PublicPage * * @param string $username * * @return Response * @throws UrlCloudException */ public function actorAlias(string $username): Response { return $this->actor($username); } /** * Shared inbox. does nothing. * * @NoCSRFRequired * @PublicPage * * @return Response */ public function sharedInbox(): Response { try { $body = file_get_contents('php://input'); $this->miscService->log('[<<] shared-inbox: ' . $body, 1); $requestTime = 0; $origin = $this->signatureService->checkRequest($this->request, $requestTime); $activity = $this->importService->importFromJson($body); if (!$this->signatureService->checkObject($activity)) { $activity->setOrigin($origin, SignatureService::ORIGIN_HEADER, $requestTime); } try { $this->importService->parseIncomingRequest($activity); } catch (ItemUnknownException $e) { } $this->async(); $this->streamQueueService->cacheStreamByToken($activity->getRequestToken()); // or it will feed the logs. exit(); } catch (SignatureIsGoneException $e) { return $this->fail($e, [], Http::STATUS_GONE, false); } catch (Exception $e) { return $this->fail($e); } } /** * Method is called when a remote ActivityPub server wants to POST in the INBOX of a USER * Checking that the user exists, and that the header is properly signed. * * @NoCSRFRequired * @PublicPage * * @param string $username * * @return Response */ public function inbox(string $username): Response { try { $body = file_get_contents('php://input'); $this->miscService->log('[<<] inbox: ' . $body, 1); $requestTime = 0; $origin = $this->signatureService->checkRequest($this->request, $requestTime); // TODO - check the recipient <-> username // $actor = $this->actorService->getActor($username); $activity = $this->importService->importFromJson($body); if (!$this->signatureService->checkObject($activity)) { $activity->setOrigin($origin, SignatureService::ORIGIN_HEADER, $requestTime); } try { $this->importService->parseIncomingRequest($activity); } catch (ItemUnknownException $e) { } $this->async(); $this->streamQueueService->cacheStreamByToken($activity->getRequestToken()); // or it will feed the logs. exit(); } catch (SignatureIsGoneException $e) { return $this->fail($e, [], Http::STATUS_GONE); } catch (Exception $e) { return $this->fail($e); } } /** * Outbox. does nothing. * * @NoCSRFRequired * @PublicPage * * @param string $username * * @return Response */ public function outbox(string $username): Response { return $this->success([$username]); } /** * followers. does nothing. * * @NoCSRFRequired * @PublicPage * * @param string $username * * @return Response * @throws UrlCloudException */ public function followers(string $username): Response { if (!$this->checkSourceActivityStreams()) { return $this->socialPubController->followers($username); } try { $actor = $this->cacheActorService->getFromLocalAccount($username); $followers = $this->followService->getFollowersCollection($actor); // $followers->setTopLevel(true); return $this->directSuccess($followers); } catch (Exception $e) { return $this->fail($e); } } /** * following. does nothing. * * @NoCSRFRequired * @PublicPage * * @param string $username * * @return Response * @throws UrlCloudException */ public function following(string $username): Response { if (!$this->checkSourceActivityStreams()) { return $this->socialPubController->following($username); } return $this->success([$username]); } /** * should return data about a post. do nothing. * * @NoCSRFRequired * @PublicPage * * @param string $username * @param $postId * * @return Response */ public function displayPost($username, $postId) { if (!$this->checkSourceActivityStreams()) { return $this->socialPubController->displayPost($username, $postId); } return $this->success([$username, $postId]); } /** * Check that the request comes from an ActivityPub server, based on the header. * * If not, should forward to a readable webpage that displays content for navigation. * * @return bool */ private function checkSourceActivityStreams(): bool { $accepted = [ 'application/ld+json', 'application/activity+json' ]; $accepts = explode(',', $this->request->getHeader('Accept')); $accepts = array_map([$this, 'trimHeader'], $accepts); foreach ($accepts as $accept) { if (in_array($accept, $accepted)) { return true; } } return false; } private function trimHeader(string $header) { $header = trim($header); $pos = strpos($header, ';'); if ($pos === false) { return $header; } return substr($header, 0, $pos); } }