Create new OStatus\PubSub module class

- Retain previous route /pubsub for backward compatibility

diff --git a/mod/pubsub.php b/mod/pubsub.php
index a740b7b81da89c5e03ea6e5d5e03401c0cfbb25d..7640efd07f9644a3c0e403210081d2f0928964a5 100644 (file)
--- a/mod/pubsub.php
+++ b/mod/pubsub.php
@@ -42,117 +42,12 @@ function hub_return($valid, $body)
        System::exit();
 }
 
-// when receiving an XML feed, always return OK
-
-function hub_post_return()
-{
-       throw new \Friendica\Network\HTTPException\OKException();
-}
-
 function pubsub_init(App $a)
 {
-       $nick       = ((DI::args()->getArgc() > 1) ? trim(DI::args()->getArgv()[1])   : '');
-       $contact_id = ((DI::args()->getArgc() > 2) ? intval(DI::args()->getArgv()[2]) : 0 );
-
-       if (DI::args()->getMethod() === App\Router::GET) {
-               $hub_mode      = trim($_GET['hub_mode']         ?? '');
-               $hub_topic     = trim($_GET['hub_topic']        ?? '');
-               $hub_challenge = trim($_GET['hub_challenge']    ?? '');
-               $hub_verify    = trim($_GET['hub_verify_token'] ?? '');
-
-               Logger::notice('Subscription from ' . $_SERVER['REMOTE_ADDR'] . ' Mode: ' . $hub_mode . ' Nick: ' . $nick);
-               Logger::debug('Data: ', ['get' => $_GET]);
-
-               $subscribe = (($hub_mode === 'subscribe') ? 1 : 0);
-
-               $owner = DBA::selectFirst('user', ['uid'], ['nickname' => $nick, 'account_expired' => false, 'account_removed' => false]);
-               if (!DBA::isResult($owner)) {
-                       Logger::notice('Local account not found: ' . $nick);
-                       hub_return(false, '');
-               }
 
-               $condition = ['uid' => $owner['uid'], 'id' => $contact_id, 'blocked' => false, 'pending' => false];
-
-               if (!empty($hub_verify)) {
-                       $condition['hub-verify'] = $hub_verify;
-               }
-
-               $contact = DBA::selectFirst('contact', ['id', 'poll'], $condition);
-               if (!DBA::isResult($contact)) {
-                       Logger::notice('Contact ' . $contact_id . ' not found.');
-                       hub_return(false, '');
-               }
-
-               if (!empty($hub_topic) && !Strings::compareLink($hub_topic, $contact['poll'])) {
-                       Logger::notice('Hub topic ' . $hub_topic . ' != ' . $contact['poll']);
-                       hub_return(false, '');
-               }
-
-               // We must initiate an unsubscribe request with a verify_token.
-               // Don't allow outsiders to unsubscribe us.
-
-               if (($hub_mode === 'unsubscribe') && empty($hub_verify)) {
-                       Logger::notice('Bogus unsubscribe');
-                       hub_return(false, '');
-               }
-
-               if (!empty($hub_mode)) {
-                       Contact::update(['subhub' => $subscribe], ['id' => $contact['id']]);
-                       Logger::notice($hub_mode . ' success for contact ' . $contact_id . '.');
-               }
-               hub_return(true, $hub_challenge);
-       }
 }
 
 function pubsub_post(App $a)
 {
-       $xml = Network::postdata();
-
-       Logger::info('Feed arrived from ' . $_SERVER['REMOTE_ADDR'] . ' for ' .  DI::args()->getCommand() . ' with user-agent: ' . $_SERVER['HTTP_USER_AGENT']);
-       Logger::debug('Data: ' . $xml);
-
-       $nick       = ((DI::args()->getArgc() > 1) ? trim(DI::args()->getArgv()[1])   : '');
-       $contact_id = ((DI::args()->getArgc() > 2) ? intval(DI::args()->getArgv()[2]) : 0 );
-
-       $importer = DBA::selectFirst('user', [], ['nickname' => $nick, 'account_expired' => false, 'account_removed' => false]);
-       if (!DBA::isResult($importer)) {
-               hub_post_return();
-       }
-
-       $condition = ['id' => $contact_id, 'uid' => $importer['uid'], 'subhub' => true, 'blocked' => false];
-       $contact = DBA::selectFirst('contact', [], $condition);
-
-       if (!DBA::isResult($contact)) {
-               $author = OStatus::salmonAuthor($xml, $importer);
-               if (!empty($author['contact-id'])) {
-                       $condition = ['id' => $author['contact-id'], 'uid' => $importer['uid'], 'subhub' => true, 'blocked' => false];
-                       $contact = DBA::selectFirst('contact', [], $condition);
-                       Logger::notice('No record for ' . $nick .' with contact id ' . $contact_id . ' - using '.$author['contact-id'].' instead.');
-               }
-               if (!DBA::isResult($contact)) {
-                       Logger::notice('Contact ' . $author["author-link"] . ' (' . $contact_id . ') for user ' . $nick . " wasn't found - ignored. XML: " . $xml);
-                       hub_post_return();
-               }
-       }
-
-       if (!empty($contact['gsid'])) {
-               GServer::setProtocol($contact['gsid'], Post\DeliveryData::OSTATUS);
-       }
-
-       if (!in_array($contact['rel'], [Contact::SHARING, Contact::FRIEND]) && ($contact['network'] != Protocol::FEED)) {
-               Logger::notice('Contact ' . $contact['id'] . ' is not expected to share with us - ignored.');
-               hub_post_return();
-       }
-
-       // We only import feeds from OStatus here
-       if (!in_array($contact['network'], [Protocol::ACTIVITYPUB, Protocol::OSTATUS])) {
-               Logger::warning('Unexpected network', ['contact' => $contact]);
-               hub_post_return();
-       }
-
-       Logger::info('Import item for ' . $nick . ' from ' . $contact['nick'] . ' (' . $contact['id'] . ')');
-       $feedhub = '';
-       OStatus::import($xml, $importer, $contact, $feedhub);
 
-       hub_post_return();
 }

diff --git a/src/Module/OStatus/PubSub.php b/src/Module/OStatus/PubSub.php
new file mode 100644 (file)
index 0000000..c6305ec
--- /dev/null
+++ b/src/Module/OStatus/PubSub.php
@@ -0,0 +1,159 @@
+<?php
+/**
+ * @copyright Copyright (C) 2010-2022, the Friendica project
+ *
+ * @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 <https://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace Friendica\Module\OStatus;
+
+use Friendica\App;
+use Friendica\Core\L10n;
+use Friendica\Core\Protocol;
+use Friendica\Core\System;
+use Friendica\Database\Database;
+use Friendica\Model\Contact;
+use Friendica\Model\GServer;
+use Friendica\Model\Post;
+use Friendica\Module\Response;
+use Friendica\Network\HTTPException;
+use Friendica\Protocol\OStatus;
+use Friendica\Util\Network;
+use Friendica\Util\Profiler;
+use Friendica\Util\Strings;
+use Psr\Log\LoggerInterface;
+
+class PubSub extends \Friendica\BaseModule
+{
+       /** @var Database */
+       private $database;
+       /** @var App\Request */
+       private $request;
+
+       public function __construct(App\Request $request, Database $database, L10n $l10n, App\BaseURL $baseUrl, App\Arguments $args, LoggerInterface $logger, Profiler $profiler, Response $response, array $server, array $parameters = [])
+       {
+               parent::__construct($l10n, $baseUrl, $args, $logger, $profiler, $response, $server, $parameters);
+
+               $this->database = $database;
+               $this->request  = $request;
+       }
+
+       protected function post(array $request = [])
+       {
+               $xml = Network::postdata();
+
+               $this->logger->info('Feed arrived.', ['from' =>  $this->request->getRemoteAddress(), 'for' => $this->args->getCommand(), 'user-agent' => $this->server['HTTP_USER_AGENT']]);
+               $this->logger->debug('Data stream.', ['xml' => $xml]);
+
+               $nickname   = $this->parameters['nickname'] ?? '';
+               $contact_id = $this->parameters['cid']      ?? 0;
+
+               $importer = $this->database->selectFirst('user', [], ['nickname' => $nickname, 'account_expired' => false, 'account_removed' => false]);
+               if (!$importer) {
+                       throw new HTTPException\OKException();
+               }
+
+               $condition = ['id' => $contact_id, 'uid' => $importer['uid'], 'subhub' => true, 'blocked' => false];
+               $contact   = $this->database->selectFirst('contact', [], $condition);
+               if (!$contact) {
+                       $author = OStatus::salmonAuthor($xml, $importer);
+                       if (!empty($author['contact-id'])) {
+                               $condition = ['id' => $author['contact-id'], 'uid' => $importer['uid'], 'subhub' => true, 'blocked' => false];
+                               $contact   = $this->database->selectFirst('contact', [], $condition);
+                               $this->logger->notice('No record found for nickname, using author entry instead.', ['nickname' =>  $nickname, 'contact-id' => $contact_id, 'author-contact-id' => $author['contact-id']]);
+                       }
+
+                       if (!$contact) {
+                               $this->logger->notice("Contact wasn't found - ignored.", ['author-link' => $author['author-link'], 'contact-id' => $contact_id, 'nickname' => $nickname, 'xml' => $xml]);
+                               throw new HTTPException\OKException();
+                       }
+               }
+
+               if (!empty($contact['gsid'])) {
+                       GServer::setProtocol($contact['gsid'], Post\DeliveryData::OSTATUS);
+               }
+
+               if (!in_array($contact['rel'], [Contact::SHARING, Contact::FRIEND]) && ($contact['network'] != Protocol::FEED)) {
+                       $this->logger->notice('Contact is not expected to share with us - ignored.', ['contact-id' => $contact['id']]);
+                       throw new HTTPException\OKException();
+               }
+
+               // We only import feeds from OStatus here
+               if (!in_array($contact['network'], [Protocol::ACTIVITYPUB, Protocol::OSTATUS])) {
+                       $this->logger->warning('Unexpected network', ['contact' => $contact, 'network' => $contact['network']]);
+                       throw new HTTPException\OKException();
+               }
+
+               $this->logger->info('Import item from Contact.', ['nickname' => $nickname, 'contact-nickname' => $contact['nick'], 'contact-id' => $contact['id']]);
+               $feedhub = '';
+               OStatus::import($xml, $importer, $contact, $feedhub);
+
+               throw new HTTPException\OKException();
+       }
+
+       protected function rawContent(array $request = [])
+       {
+               $nickname   = $this->parameters['nickname'] ?? '';
+               $contact_id = $this->parameters['cid']      ?? 0;
+
+               $hub_mode      = trim($request['hub_mode']         ?? '');
+               $hub_topic     = trim($request['hub_topic']        ?? '');
+               $hub_challenge = trim($request['hub_challenge']    ?? '');
+               $hub_verify    = trim($request['hub_verify_token'] ?? '');
+
+               $this->logger->notice('Subscription start.', ['from' => $this->request->getRemoteAddress(), 'mode' => $hub_mode, 'nickname' => $nickname]);
+               $this->logger->debug('Data: ', ['get' => $request]);
+
+               $owner = $this->database->selectFirst('user', ['uid'], ['nickname' => $nickname, 'account_expired' => false, 'account_removed' => false]);
+               if (!$owner) {
+                       $this->logger->notice('Local account not found.', ['nickname' => $nickname]);
+                       throw new HTTPException\NotFoundException();
+               }
+
+               $condition = ['uid' => $owner['uid'], 'id' => $contact_id, 'blocked' => false, 'pending' => false];
+
+               if (!empty($hub_verify)) {
+                       $condition['hub-verify'] = $hub_verify;
+               }
+
+               $contact = $this->database->selectFirst('contact', ['id', 'poll'], $condition);
+               if (!$contact) {
+                       $this->logger->notice('Contact not found.', ['contact' => $contact_id]);
+                       throw new HTTPException\NotFoundException();
+               }
+
+               if (!empty($hub_topic) && !Strings::compareLink($hub_topic, $contact['poll'])) {
+                       $this->logger->notice("Hub topic isn't valid for Contact.", ['hub_topic' =>  $hub_topic, 'contact_poll' => $contact['poll']]);
+                       throw new HTTPException\NotFoundException();
+               }
+
+               // We must initiate an unsubscribe request with a verify_token.
+               // Don't allow outsiders to unsubscribe us.
+
+               if (($hub_mode === 'unsubscribe') && empty($hub_verify)) {
+                       $this->logger->notice('Bogus unsubscribe');
+                       throw new HTTPException\NotFoundException();
+               }
+
+               if (!empty($hub_mode)) {
+                       Contact::update(['subhub' => $hub_mode === 'subscribe'], ['id' => $contact['id']]);
+                       $this->logger->notice('Success for contact.', ['mode' => $hub_mode, 'contact' => $contact_id]);
+               }
+
+               System::httpExit($hub_challenge);
+       }
+}

diff --git a/static/routes.config.php b/static/routes.config.php
index 00f147cc49308b1c48714db657032461868e17c9..0e9ce965e261e8ef83090ef6aa56191cc8dda4b6 100644 (file)
--- a/static/routes.config.php
+++ b/static/routes.config.php
@@ -569,8 +569,9 @@ return [
                '/{sub1}/{sub2}/{url}' => [Module\Proxy::class, [R::GET]],
        ],
 
-       '/pubsubhubbub/{nickname}' => [Module\OStatus\PubSubHubBub::class, [        R::POST]],
-       '/salmon/{nickname}'       => [Module\OStatus\Salmon::class,       [        R::POST]],
+       '/pubsub/{nickname}/{cid:\d+}' => [Module\OStatus\PubSub::class,       [R::GET, R::POST]],
+       '/pubsubhubbub/{nickname}'     => [Module\OStatus\PubSubHubBub::class, [        R::POST]],
+       '/salmon/{nickname}'           => [Module\OStatus\Salmon::class,       [        R::POST]],
 
        '/search' => [
                '[/]'                  => [Module\Search\Index::class, [R::GET         ]],