src/Module/Api/Mastodon/PushSubscription.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2022, 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\Model\Subscription;
  28 use Friendica\Module\Api\ApiResponse;
  29 use Friendica\Module\BaseApi;
  30 use Friendica\Object\Api\Mastodon\Notification;
  31 use Friendica\Util\Profiler;
  32 use Psr\Log\LoggerInterface;
  33
  34 /**
  35  * @see https://docs.joinmastodon.org/methods/notifications/push/
  36  */
  37 class PushSubscription extends BaseApi
  38 {
  39         /** @var \Friendica\Factory\Api\Mastodon\Subscription */
  40         protected $subscriptionFac;
  41         /** @var Error */
  42         protected $errorFac;
  43
  44         public function __construct(App $app, L10n $l10n, App\BaseURL $baseUrl, App\Arguments $args, LoggerInterface $logger, Profiler $profiler, ApiResponse $response, \Friendica\Factory\Api\Mastodon\Subscription $subscriptionFac, Error $errorFac, array $server, array $parameters = [])
  45         {
  46                 parent::__construct($app, $l10n, $baseUrl, $args, $logger, $profiler, $response, $server, $parameters);
  47
  48                 $this->subscriptionFac = $subscriptionFac;
  49                 $this->errorFac        = $errorFac;
  50         }
  51
  52         protected function post(array $request = []): void
  53         {
  54                 self::checkAllowedScope(self::SCOPE_PUSH);
  55                 $uid         = self::getCurrentUserID();
  56                 $application = self::getCurrentApplication();
  57
  58                 $request = $this->getRequest([
  59                         'subscription' => [],
  60                         'data'         => [],
  61                 ], $request);
  62
  63                 $subscription = [
  64                         'application-id'                => $application['id'],
  65                         'uid'                           => $uid,
  66                         'endpoint'                      => $request['subscription']['endpoint'] ?? '',
  67                         'pubkey'                        => $request['subscription']['keys']['p256dh'] ?? '',
  68                         'secret'                        => $request['subscription']['keys']['auth'] ?? '',
  69                         Notification::TYPE_FOLLOW       => filter_var($request['data']['alerts'][Notification::TYPE_FOLLOW] ?? false, FILTER_VALIDATE_BOOLEAN),
  70                         Notification::TYPE_LIKE         => filter_var($request['data']['alerts'][Notification::TYPE_LIKE] ?? false, FILTER_VALIDATE_BOOLEAN),
  71                         Notification::TYPE_RESHARE      => filter_var($request['data']['alerts'][Notification::TYPE_RESHARE] ?? false, FILTER_VALIDATE_BOOLEAN),
  72                         Notification::TYPE_MENTION      => filter_var($request['data']['alerts'][Notification::TYPE_MENTION] ?? false, FILTER_VALIDATE_BOOLEAN),
  73                         Notification::TYPE_POLL         => filter_var($request['data']['alerts'][Notification::TYPE_POLL] ?? false, FILTER_VALIDATE_BOOLEAN),
  74                         Notification::TYPE_INTRODUCTION => filter_var($request['data']['alerts'][Notification::TYPE_INTRODUCTION] ?? false, FILTER_VALIDATE_BOOLEAN),
  75                         Notification::TYPE_POST         => filter_var($request['data']['alerts'][Notification::TYPE_POST] ?? false, FILTER_VALIDATE_BOOLEAN),
  76                 ];
  77
  78                 $ret = Subscription::replace($subscription);
  79
  80                 $this->logger->info('Subscription stored', ['ret' => $ret, 'subscription' => $subscription]);
  81
  82                 $subscriptionObj = $this->subscriptionFac->createForApplicationIdAndUserId($application['id'], $uid);
  83                 $this->response->exitWithJson($subscriptionObj->toArray());
  84         }
  85
  86         public function put(array $request = []): void
  87         {
  88                 self::checkAllowedScope(self::SCOPE_PUSH);
  89                 $uid         = self::getCurrentUserID();
  90                 $application = self::getCurrentApplication();
  91
  92                 $request = $this->getRequest([
  93                         'data' => [],
  94                 ], $request);
  95
  96                 $subscription = Subscription::select($application['id'], $uid, ['id']);
  97                 if (empty($subscription)) {
  98                         $this->logger->info('Subscription not found', ['application-id' => $application['id'], 'uid' => $uid]);
  99                         $this->errorFac->RecordNotFound();
 100                 }
 101
 102                 $fields = [
 103                         Notification::TYPE_FOLLOW       => $request['data']['alerts'][Notification::TYPE_FOLLOW] ?? false,
 104                         Notification::TYPE_LIKE         => $request['data']['alerts'][Notification::TYPE_LIKE] ?? false,
 105                         Notification::TYPE_RESHARE      => $request['data']['alerts'][Notification::TYPE_RESHARE] ?? false,
 106                         Notification::TYPE_MENTION      => $request['data']['alerts'][Notification::TYPE_MENTION] ?? false,
 107                         Notification::TYPE_POLL         => $request['data']['alerts'][Notification::TYPE_POLL] ?? false,
 108                         Notification::TYPE_INTRODUCTION => $request['data']['alerts'][Notification::TYPE_INTRODUCTION] ?? false,
 109                         Notification::TYPE_POST         => $request['data']['alerts'][Notification::TYPE_POST] ?? false,
 110                 ];
 111
 112                 $ret = Subscription::update($application['id'], $uid, $fields);
 113
 114                 $this->logger->info('Subscription updated', ['result' => $ret, 'application-id' => $application['id'],
 115                                                                                                          'uid'    => $uid, 'fields' => $fields]);
 116
 117                 $subscriptionObj = $this->subscriptionFac->createForApplicationIdAndUserId($application['id'], $uid);
 118                 $this->response->exitWithJson($subscriptionObj->toArray());
 119         }
 120
 121         protected function delete(array $request = []): void
 122         {
 123                 self::checkAllowedScope(self::SCOPE_PUSH);
 124                 $uid         = self::getCurrentUserID();
 125                 $application = self::getCurrentApplication();
 126
 127                 $ret = Subscription::delete($application['id'], $uid);
 128
 129                 $this->logger->info('Subscription deleted', ['result' => $ret, 'application-id' => $application['id'],
 130                                                                                                          'uid'    => $uid]);
 131
 132                 $this->response->exitWithJson([]);
 133         }
 134
 135         protected function rawContent(array $request = []): void
 136         {
 137                 self::checkAllowedScope(self::SCOPE_PUSH);
 138                 $uid         = self::getCurrentUserID();
 139                 $application = self::getCurrentApplication();
 140
 141                 if (!Subscription::exists($application['id'], $uid)) {
 142                         $this->logger->info('Subscription not found', ['application-id' => $application['id'], 'uid' => $uid]);
 143                         $this->errorFac->RecordNotFound();
 144                 }
 145
 146                 $this->logger->info('Fetch subscription', ['application-id' => $application['id'], 'uid' => $uid]);
 147
 148                 $subscriptionObj = $this->subscriptionFac->createForApplicationIdAndUserId($application['id'], $uid);
 149                 $this->response->exitWithJson($subscriptionObj->toArray());
 150         }
 151 }