src/Module/Api/Mastodon/PushSubscription.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2023, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\Module\Api\Mastodon;
  23
  24 use Friendica\App;
  25 use Friendica\Core\L10n;
  26 use Friendica\Factory\Api\Mastodon\Error;
  27 use Friendica\Factory\Api\Mastodon\Subscription as SubscriptionFactory;
  28 use Friendica\Model\Subscription;
  29 use Friendica\Module\Api\ApiResponse;
  30 use Friendica\Module\BaseApi;
  31 use Friendica\Object\Api\Mastodon\Notification;
  32 use Friendica\Util\Profiler;
  33 use Psr\Log\LoggerInterface;
  34
  35 /**
  36  * @see https://docs.joinmastodon.org/methods/notifications/push/
  37  */
  38 class PushSubscription extends BaseApi
  39 {
  40         /** @var SubscriptionFactory */
  41         protected $subscriptionFac;
  42
  43         public function __construct(\Friendica\Factory\Api\Mastodon\Error $errorFactory, App $app, L10n $l10n, App\BaseURL $baseUrl, App\Arguments $args, LoggerInterface $logger, Profiler $profiler, ApiResponse $response, SubscriptionFactory $subscriptionFac, array $server, array $parameters = [])
  44         {
  45                 parent::__construct($errorFactory, $app, $l10n, $baseUrl, $args, $logger, $profiler, $response, $server, $parameters);
  46
  47                 $this->subscriptionFac = $subscriptionFac;
  48         }
  49
  50         protected function post(array $request = []): void
  51         {
  52                 $this->checkAllowedScope(self::SCOPE_PUSH);
  53                 $uid         = self::getCurrentUserID();
  54                 $application = self::getCurrentApplication();
  55
  56                 $request = $this->getRequest([
  57                         'subscription' => [],
  58                         'data'         => [],
  59                 ], $request);
  60
  61                 $subscription = [
  62                         'application-id'                => $application['id'],
  63                         'uid'                           => $uid,
  64                         'endpoint'                      => $request['subscription']['endpoint'] ?? '',
  65                         'pubkey'                        => $request['subscription']['keys']['p256dh'] ?? '',
  66                         'secret'                        => $request['subscription']['keys']['auth'] ?? '',
  67                         Notification::TYPE_FOLLOW       => filter_var($request['data']['alerts'][Notification::TYPE_FOLLOW] ?? false, FILTER_VALIDATE_BOOLEAN),
  68                         Notification::TYPE_LIKE         => filter_var($request['data']['alerts'][Notification::TYPE_LIKE] ?? false, FILTER_VALIDATE_BOOLEAN),
  69                         Notification::TYPE_RESHARE      => filter_var($request['data']['alerts'][Notification::TYPE_RESHARE] ?? false, FILTER_VALIDATE_BOOLEAN),
  70                         Notification::TYPE_MENTION      => filter_var($request['data']['alerts'][Notification::TYPE_MENTION] ?? false, FILTER_VALIDATE_BOOLEAN),
  71                         Notification::TYPE_POLL         => filter_var($request['data']['alerts'][Notification::TYPE_POLL] ?? false, FILTER_VALIDATE_BOOLEAN),
  72                         Notification::TYPE_INTRODUCTION => filter_var($request['data']['alerts'][Notification::TYPE_INTRODUCTION] ?? false, FILTER_VALIDATE_BOOLEAN),
  73                         Notification::TYPE_POST         => filter_var($request['data']['alerts'][Notification::TYPE_POST] ?? false, FILTER_VALIDATE_BOOLEAN),
  74                 ];
  75
  76                 $ret = Subscription::replace($subscription);
  77
  78                 $this->logger->info('Subscription stored', ['ret' => $ret, 'subscription' => $subscription]);
  79
  80                 $subscriptionObj = $this->subscriptionFac->createForApplicationIdAndUserId($application['id'], $uid);
  81                 $this->response->addJsonContent($subscriptionObj->toArray());
  82         }
  83
  84         public function put(array $request = []): void
  85         {
  86                 $this->checkAllowedScope(self::SCOPE_PUSH);
  87                 $uid         = self::getCurrentUserID();
  88                 $application = self::getCurrentApplication();
  89
  90                 $request = $this->getRequest([
  91                         'data' => [],
  92                 ], $request);
  93
  94                 $subscription = Subscription::select($application['id'], $uid, ['id']);
  95                 if (empty($subscription)) {
  96                         $this->logger->info('Subscription not found', ['application-id' => $application['id'], 'uid' => $uid]);
  97                         $this->errorFactory->RecordNotFound();
  98                 }
  99
 100                 $fields = [
 101                         Notification::TYPE_FOLLOW       => $request['data']['alerts'][Notification::TYPE_FOLLOW] ?? false,
 102                         Notification::TYPE_LIKE         => $request['data']['alerts'][Notification::TYPE_LIKE] ?? false,
 103                         Notification::TYPE_RESHARE      => $request['data']['alerts'][Notification::TYPE_RESHARE] ?? false,
 104                         Notification::TYPE_MENTION      => $request['data']['alerts'][Notification::TYPE_MENTION] ?? false,
 105                         Notification::TYPE_POLL         => $request['data']['alerts'][Notification::TYPE_POLL] ?? false,
 106                         Notification::TYPE_INTRODUCTION => $request['data']['alerts'][Notification::TYPE_INTRODUCTION] ?? false,
 107                         Notification::TYPE_POST         => $request['data']['alerts'][Notification::TYPE_POST] ?? false,
 108                 ];
 109
 110                 $ret = Subscription::update($application['id'], $uid, $fields);
 111
 112                 $this->logger->info('Subscription updated', [
 113                         'result'         => $ret,
 114                         'application-id' => $application['id'],
 115                         'uid'            => $uid,
 116                         'fields'         => $fields,
 117                 ]);
 118
 119                 $subscriptionObj = $this->subscriptionFac->createForApplicationIdAndUserId($application['id'], $uid);
 120                 $this->response->addJsonContent($subscriptionObj->toArray());
 121         }
 122
 123         protected function delete(array $request = []): void
 124         {
 125                 $this->checkAllowedScope(self::SCOPE_PUSH);
 126                 $uid         = self::getCurrentUserID();
 127                 $application = self::getCurrentApplication();
 128
 129                 $ret = Subscription::delete($application['id'], $uid);
 130
 131                 $this->logger->info('Subscription deleted', [
 132                         'result'         => $ret,
 133                         'application-id' => $application['id'],
 134                         'uid'            => $uid,
 135                 ]);
 136
 137                 $this->response->addJsonContent([]);
 138         }
 139
 140         protected function rawContent(array $request = []): void
 141         {
 142                 $this->checkAllowedScope(self::SCOPE_PUSH);
 143                 $uid         = self::getCurrentUserID();
 144                 $application = self::getCurrentApplication();
 145
 146                 if (!Subscription::exists($application['id'], $uid)) {
 147                         $this->logger->info('Subscription not found', ['application-id' => $application['id'], 'uid' => $uid]);
 148                         $this->errorFactory->RecordNotFound();
 149                 }
 150
 151                 $this->logger->info('Fetch subscription', ['application-id' => $application['id'], 'uid' => $uid]);
 152
 153                 $subscriptionObj = $this->subscriptionFac->createForApplicationIdAndUserId($application['id'], $uid);
 154                 $this->response->addJsonContent($subscriptionObj->toArray());
 155         }
 156 }