src/Model/Subscription.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2024, 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\Model;
  23
  24 use Friendica\Core\Logger;
  25 use Friendica\Core\Worker;
  26 use Friendica\Database\DBA;
  27 use Friendica\DI;
  28 use Friendica\Factory\Api\Mastodon\Notification as NotificationFactory;
  29 use Friendica\Navigation\Notifications\Entity;
  30 use Friendica\Object\Api\Mastodon\Notification;
  31 use Minishlink\WebPush\VAPID;
  32
  33 class Subscription
  34 {
  35         /**
  36          * Select a subscription record exists
  37          *
  38          * @param int   $applicationid
  39          * @param int   $uid
  40          * @param array $fields
  41          * @return array|bool Array on success, false on failure
  42          */
  43         public static function select(int $applicationid, int $uid, array $fields = [])
  44         {
  45                 return DBA::selectFirst('subscription', $fields, ['application-id' => $applicationid, 'uid' => $uid]);
  46         }
  47
  48         /**
  49          * Check if a subscription record exists
  50          *
  51          * @param int   $applicationid
  52          * @param int   $uid
  53          *
  54          * @return bool Does it exist?
  55          */
  56         public static function exists(int $applicationid, int $uid): bool
  57         {
  58                 return DBA::exists('subscription', ['application-id' => $applicationid, 'uid' => $uid]);
  59         }
  60
  61         /**
  62          * Update a subscription record
  63          *
  64          * @param int   $applicationid
  65          * @param int   $uid
  66          * @param array $fields subscription fields
  67          * @return bool result of update
  68          */
  69         public static function update(int $applicationid, int $uid, array $fields): bool
  70         {
  71                 return DBA::update('subscription', $fields, ['application-id' => $applicationid, 'uid' => $uid]);
  72         }
  73
  74         /**
  75          * Insert or replace a subscription record
  76          *
  77          * @param array $fields subscription fields
  78          * @return bool result of replace
  79          */
  80         public static function replace(array $fields): bool
  81         {
  82                 return DBA::replace('subscription', $fields);
  83         }
  84
  85         /**
  86          * Delete a subscription record
  87          *
  88          * @param int $applicationid
  89          * @param int $uid
  90          * @return bool
  91          */
  92         public static function delete(int $applicationid, int $uid): bool
  93         {
  94                 return DBA::delete('subscription', ['application-id' => $applicationid, 'uid' => $uid]);
  95         }
  96
  97         /**
  98          * Fetch a VAPID keypair
  99          *
 100          * @return array
 101          */
 102         private static function getKeyPair(): array
 103         {
 104                 $keypair = DI::config()->get('system', 'ec_keypair');
 105                 if (empty($keypair['publicKey']) || empty($keypair['privateKey'])) {
 106                         $keypair = VAPID::createVapidKeys();
 107                         DI::config()->set('system', 'ec_keypair', $keypair);
 108                 }
 109                 return $keypair;
 110         }
 111
 112         /**
 113          * Fetch the public VAPID key
 114          *
 115          * @return string
 116          */
 117         public static function getPublicVapidKey(): string
 118         {
 119                 $keypair = self::getKeyPair();
 120                 return $keypair['publicKey'];
 121         }
 122
 123         /**
 124          * Fetch the public VAPID key
 125          *
 126          * @return string
 127          */
 128         public static function getPrivateVapidKey(): string
 129         {
 130                 $keypair = self::getKeyPair();
 131                 return $keypair['privateKey'];
 132         }
 133
 134         /**
 135          * Prepare push notification
 136          *
 137          * @param Notification $Notification
 138          * @return void
 139          */
 140         public static function pushByNotification(Entity\Notification $notification)
 141         {
 142                 $type = NotificationFactory::getType($notification);
 143
 144                 if (DI::notify()->shouldShowOnDesktop($notification, $type)) {
 145                         DI::notify()->createFromNotification($notification);
 146                 }
 147
 148                 if (empty($type)) {
 149                         return;
 150                 }
 151
 152                 $subscriptions = DBA::select('subscription', [], ['uid' => $notification->uid, $type => true]);
 153                 while ($subscription = DBA::fetch($subscriptions)) {
 154                         Logger::info('Push notification', ['id' => $subscription['id'], 'uid' => $subscription['uid'], 'type' => $type]);
 155                         Worker::add(Worker::PRIORITY_HIGH, 'PushSubscription', $subscription['id'], $notification->id);
 156                 }
 157                 DBA::close($subscriptions);
 158         }
 159 }