src/Navigation/Notifications/Factory/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\Factory;
  23
  24 use Friendica\App\BaseURL;
  25 use Friendica\BaseFactory;
  26 use Friendica\Capabilities\ICanCreateFromTableRow;
  27 use Friendica\Contact\LocalRelationship\Repository\LocalRelationship;
  28 use Friendica\Content\Text\Plaintext;
  29 use Friendica\Core\L10n;
  30 use Friendica\Model\Contact;
  31 use Friendica\Model\Post;
  32 use Friendica\Model\Verb;
  33 use Friendica\Navigation\Notifications\Entity;
  34 use Friendica\Network\HTTPException;
  35 use Friendica\Protocol\Activity;
  36 use Psr\Log\LoggerInterface;
  37
  38 class Notification extends BaseFactory implements ICanCreateFromTableRow
  39 {
  40         /** @var BaseURL */
  41         private $baseUrl;
  42         /** @var L10n */
  43         private $l10n;
  44         /** @var LocalRelationship */
  45         private $localRelationshipRepo;
  46
  47         public function __construct(\Friendica\App\BaseURL $baseUrl, \Friendica\Core\L10n $l10n, \Friendica\Contact\LocalRelationship\Repository\LocalRelationship $localRelationshipRepo, LoggerInterface $logger)
  48         {
  49                 parent::__construct($logger);
  50
  51                 $this->baseUrl = $baseUrl;
  52                 $this->l10n = $l10n;
  53                 $this->localRelationshipRepo = $localRelationshipRepo;
  54         }
  55
  56         public function createFromTableRow(array $row): Entity\Notification
  57         {
  58                 return new Entity\Notification(
  59                         $row['uid'] ?? 0,
  60                         Verb::getByID($row['vid']),
  61                         $row['type'],
  62                         $row['actor-id'],
  63                         $row['target-uri-id'],
  64                         $row['parent-uri-id'],
  65                         new \DateTime($row['created'], new \DateTimeZone('UTC')),
  66                         $row['seen'],
  67                         $row['dismissed'],
  68                         $row['id'],
  69                 );
  70         }
  71
  72         public function createForUser(int $uid, int $vid, int $type, int $actorId, int $targetUriId, int $parentUriId): Entity\Notification
  73         {
  74                 return new Entity\Notification(
  75                         $uid,
  76                         Verb::getByID($vid),
  77                         $type,
  78                         $actorId,
  79                         $targetUriId,
  80                         $parentUriId
  81                 );
  82         }
  83
  84         /**
  85          * @param int    $uid
  86          * @param int    $contactId Public contact id
  87          * @param string $verb
  88          * @return Entity\Notification
  89          */
  90         public function createForRelationship(int $uid, int $contactId, string $verb): Entity\Notification
  91         {
  92                 return new Entity\Notification(
  93                         $uid,
  94                         $verb,
  95                         Post\UserNotification::TYPE_NONE,
  96                         $contactId
  97                 );
  98         }
  99
 100         /**
 101          * @param Entity\Notification $Notification
 102          * @return array
 103          * @throws HTTPException\InternalServerErrorException
 104          * @throws HTTPException\NotFoundException
 105          */
 106         public function getMessageFromNotification(Entity\Notification $Notification): array
 107         {
 108                 $message = [];
 109
 110                 $causer = $author = Contact::getById($Notification->actorId, ['id', 'name', 'url', 'contact-type', 'pending']);
 111                 if (empty($causer)) {
 112                         $this->logger->info('Causer not found', ['contact' => $Notification->actorId]);
 113                         return $message;
 114                 }
 115
 116                 if ($Notification->type === Post\UserNotification::TYPE_NONE) {
 117                         $localRelationship = $this->localRelationshipRepo->getForUserContact($Notification->uid, $Notification->actorId);
 118                         if ($localRelationship->pending) {
 119                                 $msg = $this->l10n->t('%1$s wants to follow you');
 120                         } else {
 121                                 $msg = $this->l10n->t('%1$s has started following you');
 122                         }
 123
 124                         $title = $causer['name'];
 125                         $link  = $this->baseUrl . '/contact/' . $causer['id'];
 126                 } else {
 127                         if (!$Notification->targetUriId) {
 128                                 return $message;
 129                         }
 130
 131                         if (Post\ThreadUser::getIgnored($Notification->parentUriId, $Notification->uid)) {
 132                                 $this->logger->info('Thread is ignored', ['parent-uri-id' => $Notification->parentUriId, 'type' => $Notification->type]);
 133                                 return $message;
 134                         }
 135
 136                         if (in_array($Notification->type, [Post\UserNotification::TYPE_THREAD_COMMENT, Post\UserNotification::TYPE_COMMENT_PARTICIPATION, Post\UserNotification::TYPE_ACTIVITY_PARTICIPATION, Post\UserNotification::TYPE_EXPLICIT_TAGGED])) {
 137                                 $item = Post::selectFirst([], ['uri-id' => $Notification->parentUriId, 'uid' => [0, $Notification->uid]], ['order' => ['uid' => true]]);
 138                                 if (empty($item)) {
 139                                         $this->logger->info('Parent post not found', ['uri-id' => $Notification->parentUriId]);
 140                                         return $message;
 141                                 }
 142                                 $link_item = Post::selectFirstPost(['guid'], ['uri-id' => $Notification->targetUriId]);
 143                         } else {
 144                                 $link_item = $item = Post::selectFirst([], ['uri-id' => $Notification->targetUriId, 'uid' => [0, $Notification->uid]], ['order' => ['uid' => true]]);
 145                                 if (empty($item)) {
 146                                         $this->logger->info('Post not found', ['uri-id' => $Notification->targetUriId]);
 147                                         return $message;
 148                                 }
 149
 150                                 if (($Notification->verb == Activity::POST) || ($Notification->type === Post\UserNotification::TYPE_SHARED)) {
 151                                         $item = Post::selectFirst([], ['uri-id' => $item['thr-parent-id'], 'uid' => [0, $Notification->uid]], ['order' => ['uid' => true]]);
 152                                         if (empty($item)) {
 153                                                 $this->logger->info('Thread parent post not found', ['uri-id' => $item['thr-parent-id']]);
 154                                                 return $message;
 155                                         }
 156                                 }
 157
 158                                 if (($Notification->verb != Activity::POST) || !in_array($Notification->type, [Post\UserNotification::TYPE_DIRECT_THREAD_COMMENT, Post\UserNotification::TYPE_IMPLICIT_TAGGED])) {
 159                                         $link_item = $item;
 160                                 }
 161                         }
 162
 163                         if (in_array($Notification->type, [Post\UserNotification::TYPE_COMMENT_PARTICIPATION, Post\UserNotification::TYPE_ACTIVITY_PARTICIPATION, Post\UserNotification::TYPE_SHARED])) {
 164                                 $author = Contact::getById($item['author-id'], ['id', 'name', 'url', 'contact-type']);
 165                                 if (empty($author)) {
 166                                         $this->logger->info('Author not found', ['author' => $item['author-id']]);
 167                                         return $message;
 168                                 }
 169                         }
 170
 171                         $link = $this->baseUrl . '/display/' . urlencode($link_item['guid']);
 172
 173                         $content = Plaintext::getPost($item, 70);
 174                         if (!empty($content['text'])) {
 175                                 $title = '"' . trim(str_replace("\n", " ", $content['text'])) . '"';
 176                         } else {
 177                                 $title = '';
 178                         }
 179
 180                         $this->logger->debug('Got verb and type', ['verb' => $Notification->verb, 'type' => $Notification->type, 'causer' => $causer['id'], 'author' => $author['id'], 'item' => $item['id'], 'uid' => $Notification->uid]);
 181
 182                         switch ($Notification->verb) {
 183                                 case Activity::LIKE:
 184                                         switch ($Notification->type) {
 185                                                 case Post\UserNotification::TYPE_DIRECT_COMMENT:
 186                                                         $msg = $this->l10n->t('%1$s liked your comment on %2$s');
 187                                                         break;
 188                                                 case Post\UserNotification::TYPE_DIRECT_THREAD_COMMENT:
 189                                                         $msg = $this->l10n->t('%1$s liked your post %2$s');
 190                                                         break;
 191                                         }
 192                                         break;
 193                                 case Activity::DISLIKE:
 194                                         switch ($Notification->type) {
 195                                                 case Post\UserNotification::TYPE_DIRECT_COMMENT:
 196                                                         $msg = $this->l10n->t('%1$s disliked your comment on %2$s');
 197                                                         break;
 198                                                 case Post\UserNotification::TYPE_DIRECT_THREAD_COMMENT:
 199                                                         $msg = $this->l10n->t('%1$s disliked your post %2$s');
 200                                                         break;
 201                                         }
 202                                         break;
 203                                 case Activity::ANNOUNCE:
 204                                         switch ($Notification->type) {
 205                                                 case Post\UserNotification::TYPE_DIRECT_COMMENT:
 206                                                         $msg = $this->l10n->t('%1$s shared your comment %2$s');
 207                                                         break;
 208                                                 case Post\UserNotification::TYPE_DIRECT_THREAD_COMMENT:
 209                                                         $msg = $this->l10n->t('%1$s shared your post %2$s');
 210                                                         break;
 211                                                 case Post\UserNotification::TYPE_SHARED:
 212                                                         if (($causer['id'] != $author['id']) && ($title != '')) {
 213                                                                 $msg = $this->l10n->t('%1$s shared the post %2$s from %3$s');
 214                                                         } elseif ($causer['id'] != $author['id']) {
 215                                                                 $msg = $this->l10n->t('%1$s shared a post from %3$s');
 216                                                         } elseif ($title != '') {
 217                                                                 $msg = $this->l10n->t('%1$s shared the post %2$s');
 218                                                         } else {
 219                                                                 $msg = $this->l10n->t('%1$s shared a post');
 220                                                         }
 221                                                         break;
 222                                         }
 223                                         break;
 224                                 case Activity::ATTEND:
 225                                         switch ($Notification->type) {
 226                                                 case Post\UserNotification::TYPE_DIRECT_THREAD_COMMENT:
 227                                                         $msg = $this->l10n->t('%1$s wants to attend your event %2$s');
 228                                                         break;
 229                                         }
 230                                         break;
 231                                 case Activity::ATTENDNO:
 232                                         switch ($Notification->type) {
 233                                                 case Post\UserNotification::TYPE_DIRECT_THREAD_COMMENT:
 234                                                         $msg = $this->l10n->t('%1$s does not want to attend your event %2$s');
 235                                                         break;
 236                                         }
 237                                         break;
 238                                 case Activity::ATTENDMAYBE:
 239                                         switch ($Notification->type) {
 240                                                 case Post\UserNotification::TYPE_DIRECT_THREAD_COMMENT:
 241                                                         $msg = $this->l10n->t('%1$s maybe wants to attend your event %2$s');
 242                                                         break;
 243                                         }
 244                                         break;
 245                                 case Activity::POST:
 246                                         switch ($Notification->type) {
 247                                                 case Post\UserNotification::TYPE_EXPLICIT_TAGGED:
 248                                                         $msg = $this->l10n->t('%1$s tagged you on %2$s');
 249                                                         break;
 250
 251                                                 case Post\UserNotification::TYPE_IMPLICIT_TAGGED:
 252                                                         $msg = $this->l10n->t('%1$s replied to you on %2$s');
 253                                                         break;
 254
 255                                                 case Post\UserNotification::TYPE_THREAD_COMMENT:
 256                                                         $msg = $this->l10n->t('%1$s commented in your thread %2$s');
 257                                                         break;
 258
 259                                                 case Post\UserNotification::TYPE_DIRECT_COMMENT:
 260                                                         $msg = $this->l10n->t('%1$s commented on your comment %2$s');
 261                                                         break;
 262
 263                                                 case Post\UserNotification::TYPE_COMMENT_PARTICIPATION:
 264                                                 case Post\UserNotification::TYPE_ACTIVITY_PARTICIPATION:
 265                                                         if (($causer['id'] == $author['id']) && ($title != '')) {
 266                                                                 $msg = $this->l10n->t('%1$s commented in their thread %2$s');
 267                                                         } elseif ($causer['id'] == $author['id']) {
 268                                                                 $msg = $this->l10n->t('%1$s commented in their thread');
 269                                                         } elseif ($title != '') {
 270                                                                 $msg = $this->l10n->t('%1$s commented in the thread %2$s from %3$s');
 271                                                         } else {
 272                                                                 $msg = $this->l10n->t('%1$s commented in the thread from %3$s');
 273                                                         }
 274                                                         break;
 275
 276                                                 case Post\UserNotification::TYPE_DIRECT_THREAD_COMMENT:
 277                                                         $msg = $this->l10n->t('%1$s commented on your thread %2$s');
 278                                                         break;
 279
 280                                                 case Post\UserNotification::TYPE_SHARED:
 281                                                         if (($causer['id'] != $author['id']) && ($title != '')) {
 282                                                                 $msg = $this->l10n->t('%1$s shared the post %2$s from %3$s');
 283                                                         } elseif ($causer['id'] != $author['id']) {
 284                                                                 $msg = $this->l10n->t('%1$s shared a post from %3$s');
 285                                                         } elseif ($title != '') {
 286                                                                 $msg = $this->l10n->t('%1$s shared the post %2$s');
 287                                                         } else {
 288                                                                 $msg = $this->l10n->t('%1$s shared a post');
 289                                                         }
 290                                                         break;
 291                                         }
 292                                         break;
 293                         }
 294                 }
 295
 296                 if (!empty($msg)) {
 297                         // Name of the notification's causer
 298                         $message['causer'] = $causer['name'];
 299                         // Format for the "ping" mechanism
 300                         $message['notification'] = sprintf($msg, '{0}', $title, $author['name']);
 301                         // Plain text for the web push api
 302                         $message['plain'] = sprintf($msg, $causer['name'], $title, $author['name']);
 303                         // Rich text for other purposes
 304                         $message['rich'] = sprintf($msg,
 305                                 '[url=' . $causer['url'] . ']' . $causer['name'] . '[/url]',
 306                                 '[url=' . $link . ']' . $title . '[/url]',
 307                                 '[url=' . $author['url'] . ']' . $author['name'] . '[/url]');
 308                         $message['link'] = $link;
 309                 } else {
 310                         $this->logger->debug('Unhandled notification', ['notification' => $Notification]);
 311                 }
 312
 313                 return $message;
 314         }
 315 }