src/Navigation/Notifications/Repository/Notification.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\Navigation\Notifications\Repository;
  23
  24 use Exception;
  25 use Friendica\BaseCollection;
  26 use Friendica\BaseRepository;
  27 use Friendica\Core\PConfig\Capability\IManagePersonalConfigValues;
  28 use Friendica\Database\Database;
  29 use Friendica\Database\DBA;
  30 use Friendica\Model\Post\UserNotification;
  31 use Friendica\Model\Verb;
  32 use Friendica\Navigation\Notifications\Collection;
  33 use Friendica\Navigation\Notifications\Entity;
  34 use Friendica\Navigation\Notifications\Factory;
  35 use Friendica\Network\HTTPException\NotFoundException;
  36 use Friendica\Util\DateTimeFormat;
  37 use Psr\Log\LoggerInterface;
  38
  39 class Notification extends BaseRepository
  40 {
  41         /** @var Factory\Notification  */
  42         protected $factory;
  43
  44         protected static $table_name = 'notification';
  45
  46         /** @var IManagePersonalConfigValues */
  47         private $pconfig;
  48
  49         public function __construct(IManagePersonalConfigValues $pconfig, Database $database, LoggerInterface $logger, Factory\Notification $factory)
  50         {
  51                 parent::__construct($database, $logger, $factory);
  52
  53                 $this->pconfig = $pconfig;
  54         }
  55
  56         /**
  57          * @param array $condition
  58          * @param array $params
  59          * @return Entity\Notification
  60          * @throws NotFoundException
  61          */
  62         private function selectOne(array $condition, array $params = []): Entity\Notification
  63         {
  64                 return parent::_selectOne($condition, $params);
  65         }
  66
  67         private function select(array $condition, array $params = []): Collection\Notifications
  68         {
  69                 return new Collection\Notifications(parent::_select($condition, $params)->getArrayCopy());
  70         }
  71
  72         public function countForUser($uid, array $condition, array $params = []): int
  73         {
  74                 $condition = DBA::mergeConditions($condition, ['uid' => $uid]);
  75
  76                 return $this->count($condition, $params);
  77         }
  78
  79         public function existsForUser($uid, array $condition): bool
  80         {
  81                 $condition = DBA::mergeConditions($condition, ['uid' => $uid]);
  82
  83                 return $this->exists($condition);
  84         }
  85
  86         /**
  87          * @param int $id
  88          * @return Entity\Notification
  89          * @throws NotFoundException
  90          */
  91         public function selectOneById(int $id): Entity\Notification
  92         {
  93                 return $this->selectOne(['id' => $id]);
  94         }
  95
  96         public function selectOneForUser(int $uid, array $condition, array $params = []): Entity\Notification
  97         {
  98                 $condition = DBA::mergeConditions($condition, ['uid' => $uid]);
  99
 100                 return $this->selectOne($condition, $params);
 101         }
 102
 103         public function selectForUser(int $uid, array $condition = [], array $params = []): Collection\Notifications
 104         {
 105                 $condition = DBA::mergeConditions($condition, ['uid' => $uid]);
 106
 107                 return $this->select($condition, $params);
 108         }
 109
 110
 111         /**
 112          * Returns only the most recent notifications for the same conversation or contact
 113          *
 114          * @param int $uid
 115          * @return Collection\Notifications
 116          * @throws Exception
 117          */
 118         public function selectDetailedForUser(int $uid): Collection\Notifications
 119         {
 120                 $notify_type = $this->pconfig->get($uid, 'system', 'notify_type');
 121                 if (!is_null($notify_type)) {
 122                         $condition = ["`type` & ? != 0", $notify_type | UserNotification::TYPE_SHARED | UserNotification::TYPE_FOLLOW];
 123                 } else {
 124                         $condition = [];
 125                 }
 126
 127                 if (!$this->pconfig->get($uid, 'system', 'notify_like')) {
 128                         $condition = DBA::mergeConditions($condition, ['NOT `vid` IN (?, ?)', Verb::getID(\Friendica\Protocol\Activity::LIKE), Verb::getID(\Friendica\Protocol\Activity::DISLIKE)]);
 129                 }
 130
 131                 if (!$this->pconfig->get($uid, 'system', 'notify_announce')) {
 132                         $condition = DBA::mergeConditions($condition, ['`vid` != ?', Verb::getID(\Friendica\Protocol\Activity::ANNOUNCE)]);
 133                 }
 134
 135                 return $this->selectForUser($uid, $condition, ['limit' => 50, 'order' => ['id' => true]]);
 136         }
 137
 138         /**
 139          * Returns only the most recent notifications for the same conversation or contact
 140          *
 141          * @param int $uid
 142          * @return Collection\Notifications
 143          * @throws Exception
 144          */
 145         public function selectDigestForUser(int $uid): Collection\Notifications
 146         {
 147                 $values = [$uid];
 148
 149                 $type_condition = '';
 150                 $notify_type = $this->pconfig->get($uid, 'system', 'notify_type');
 151                 if (!is_null($notify_type)) {
 152                         $type_condition = 'AND `type` & ? != 0';
 153                         $values[] = $notify_type | UserNotification::TYPE_SHARED | UserNotification::TYPE_FOLLOW;
 154                 }
 155
 156                 $like_condition = '';
 157                 if (!$this->pconfig->get($uid, 'system', 'notify_like')) {
 158                         $like_condition = 'AND NOT `vid` IN (?, ?)';
 159                         $values[] = Verb::getID(\Friendica\Protocol\Activity::LIKE);
 160                         $values[] = Verb::getID(\Friendica\Protocol\Activity::DISLIKE);
 161                 }
 162
 163                 $announce_condition = '';
 164                 if (!$this->pconfig->get($uid, 'system', 'notify_announce')) {
 165                         $announce_condition = 'AND vid != ?';
 166                         $values[] = Verb::getID(\Friendica\Protocol\Activity::ANNOUNCE);
 167                 }
 168
 169                 $rows = $this->db->p("
 170                 SELECT notification.*
 171                 FROM notification
 172                 WHERE `id` IN (
 173                     SELECT MAX(`id`)
 174                     FROM `notification`
 175                     WHERE `uid` = ?
 176                         $type_condition
 177                     $like_condition
 178                     $announce_condition
 179                     GROUP BY IFNULL(`parent-uri-id`, `actor-id`)
 180                 )
 181                 ORDER BY `seen`, `id` DESC
 182                 LIMIT 50
 183                 ", ...$values);
 184
 185                 $Entities = new Collection\Notifications();
 186                 foreach ($rows as $fields) {
 187                         $Entities[] = $this->factory->createFromTableRow($fields);
 188                 }
 189
 190                 return $Entities;
 191         }
 192
 193         public function selectAllForUser(int $uid): Collection\Notifications
 194         {
 195                 return $this->selectForUser($uid);
 196         }
 197
 198         /**
 199          * @param array    $condition
 200          * @param array    $params
 201          * @param int|null $min_id Retrieve models with an id no fewer than this, as close to it as possible
 202          * @param int|null $max_id Retrieve models with an id no greater than this, as close to it as possible
 203          * @param int      $limit
 204          * @return BaseCollection
 205          * @throws Exception
 206          * @see _selectByBoundaries
 207          */
 208         public function selectByBoundaries(array $condition = [], array $params = [], int $min_id = null, int $max_id = null, int $limit = self::LIMIT)
 209         {
 210                 $BaseCollection = parent::_selectByBoundaries($condition, $params, $min_id, $max_id, $limit);
 211
 212                 return new Collection\Notifications($BaseCollection->getArrayCopy(), $BaseCollection->getTotalCount());
 213         }
 214
 215         public function setAllSeenForUser(int $uid, array $condition = []): bool
 216         {
 217                 $condition = DBA::mergeConditions($condition, ['uid' => $uid]);
 218
 219                 return $this->db->update(self::$table_name, ['seen' => true], $condition);
 220         }
 221
 222         public function setAllDismissedForUser(int $uid, array $condition = []): bool
 223         {
 224                 $condition = DBA::mergeConditions($condition, ['uid' => $uid]);
 225
 226                 return $this->db->update(self::$table_name, ['dismissed' => true], $condition);
 227         }
 228
 229         /**
 230          * @param Entity\Notification $Notification
 231          * @return Entity\Notification
 232          * @throws Exception
 233          */
 234         public function save(Entity\Notification $Notification): Entity\Notification
 235         {
 236                 $fields = [
 237                         'uid'           => $Notification->uid,
 238                         'vid'           => Verb::getID($Notification->verb),
 239                         'type'          => $Notification->type,
 240                         'actor-id'      => $Notification->actorId,
 241                         'target-uri-id' => $Notification->targetUriId,
 242                         'parent-uri-id' => $Notification->parentUriId,
 243                         'seen'          => $Notification->seen,
 244                         'dismissed'     => $Notification->dismissed,
 245                 ];
 246
 247                 if ($Notification->id) {
 248                         $this->db->update(self::$table_name, $fields, ['id' => $Notification->id]);
 249                 } else {
 250                         $fields['created'] = DateTimeFormat::utcNow();
 251                         $this->db->insert(self::$table_name, $fields);
 252
 253                         $Notification = $this->selectOneById($this->db->lastInsertId());
 254                 }
 255
 256                 return $Notification;
 257         }
 258
 259         public function deleteForUserByVerb(int $uid, string $verb, array $condition = []): bool
 260         {
 261                 $condition['uid'] = $uid;
 262                 $condition['vid'] = Verb::getID($verb);
 263
 264                 $this->logger->notice('deleteForUserByVerb', ['condition' => $condition]);
 265
 266                 return $this->db->delete(self::$table_name, $condition);
 267         }
 268 }