src/Model/Post/UserNotification.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\Model\Post;
  23
  24 use BadMethodCallException;
  25 use Exception;
  26 use Friendica\Core\Hook;
  27 use Friendica\Core\Logger;
  28 use Friendica\Database\Database;
  29 use Friendica\Database\DBA;
  30 use Friendica\DI;
  31 use Friendica\Model\Contact;
  32 use Friendica\Model\Item;
  33 use Friendica\Model\Post;
  34 use Friendica\Model\Subscription;
  35 use Friendica\Model\Tag;
  36 use Friendica\Model\User;
  37 use Friendica\Network\HTTPException;
  38 use Friendica\Protocol\Activity;
  39 use Friendica\Util\Strings;
  40
  41 class UserNotification
  42 {
  43         // Notification types
  44         const TYPE_NONE                   = 0;
  45         const TYPE_EXPLICIT_TAGGED        = 1;
  46         const TYPE_IMPLICIT_TAGGED        = 2;
  47         const TYPE_THREAD_COMMENT         = 4;
  48         const TYPE_DIRECT_COMMENT         = 8;
  49         const TYPE_COMMENT_PARTICIPATION  = 16;
  50         const TYPE_ACTIVITY_PARTICIPATION = 32;
  51         const TYPE_DIRECT_THREAD_COMMENT  = 64;
  52         const TYPE_SHARED                 = 128;
  53         const TYPE_FOLLOW                 = 256;
  54         const TYPE_QUOTED                 = 512;
  55
  56         /**
  57          * Insert a new user notification entry
  58          *
  59          * @param integer $uri_id
  60          * @param integer $uid
  61          * @param array   $data
  62          * @return bool   success
  63          * @throws Exception
  64          */
  65         public static function insert(int $uri_id, int $uid, array $data = []): bool
  66         {
  67                 if (empty($uri_id)) {
  68                         throw new BadMethodCallException('Empty URI_id');
  69                 }
  70
  71                 $fields = DI::dbaDefinition()->truncateFieldsForTable('post-user-notification', $data);
  72
  73                 $fields['uri-id'] = $uri_id;
  74                 $fields['uid']    = $uid;
  75
  76                 return DBA::insert('post-user-notification', $fields, Database::INSERT_IGNORE);
  77         }
  78
  79         /**
  80          * Update a user notification entry
  81          *
  82          * @param integer $uri_id
  83          * @param integer $uid
  84          * @param array   $data
  85          * @param bool    $insert_if_missing
  86          * @return bool
  87          * @throws Exception
  88          */
  89         public static function update(int $uri_id, int $uid, array $data = [], bool $insert_if_missing = false): bool
  90         {
  91                 if (empty($uri_id)) {
  92                         throw new BadMethodCallException('Empty URI_id');
  93                 }
  94
  95                 $fields = DI::dbaDefinition()->truncateFieldsForTable('post-user-notification', $data);
  96
  97                 // Remove the key fields
  98                 unset($fields['uri-id']);
  99                 unset($fields['uid']);
 100
 101                 if (empty($fields)) {
 102                         return true;
 103                 }
 104
 105                 return DBA::update('post-user-notification', $fields, ['uri-id' => $uri_id, 'uid' => $uid], $insert_if_missing ? true : []);
 106         }
 107
 108         /**
 109          * Delete a row from the post-user-notification table
 110          *
 111          * @param array $conditions  Field condition(s)
 112          * @param array $options     - cascade: If true we delete records in other tables that depend on the one we're deleting through
 113          *                           relations (default: true)
 114          *
 115          * @return boolean was the deletion successful?
 116          * @throws Exception
 117          */
 118         public static function delete(array $conditions, array $options = []): bool
 119         {
 120                 return DBA::delete('post-user-notification', $conditions, $options);
 121         }
 122
 123         /**
 124          * Checks an item for notifications and sets the "notification-type" field
 125          *
 126          * @ToDo:
 127          * - Check for mentions in posts with "uid=0" where the user hadn't interacted before
 128          *
 129          * @param int $uri_id URI ID
 130          * @param int $uid    user ID
 131          * @throws Exception
 132          */
 133         public static function setNotification(int $uri_id, int $uid)
 134         {
 135                 $fields = ['id', 'uri-id', 'parent-uri-id', 'uid', 'body', 'parent', 'gravity', 'vid', 'gravity',
 136                         'contact-id', 'author-id', 'owner-id', 'causer-id',
 137                         'private', 'thr-parent', 'thr-parent-id', 'parent-uri-id', 'parent-uri', 'verb'];
 138                 $item   = Post::selectFirst($fields, ['uri-id' => $uri_id, 'uid' => $uid, 'origin' => false]);
 139                 if (!DBA::isResult($item)) {
 140                         return;
 141                 }
 142
 143                 $parent = Post::selectFirstPost(['author-id', 'owner-id', 'causer-id'], ['uri-id' => $item['parent-uri-id']]);
 144                 if (!DBA::isResult($parent)) {
 145                         return;
 146                 }
 147
 148                 // "Activity::FOLLOW" is an automated activity, so we ignore it here
 149                 if ($item['verb'] == Activity::FOLLOW) {
 150                         return;
 151                 }
 152
 153                 if ($item['uid'] == 0) {
 154                         $uids = [];
 155                 } else {
 156                         // Always include the item user
 157                         $uids = [$item['uid']];
 158                 }
 159
 160                 // Add every user who participated so far in this thread
 161                 // This can only happen with participations on global items. (means: uid = 0)
 162                 $users = DBA::p("SELECT DISTINCT(`contact-uid`) AS `uid` FROM `post-user-view`
 163                         WHERE `contact-uid` != 0 AND `parent-uri-id` = ? AND `uid` = ?", $item['parent-uri-id'], $uid);
 164                 while ($user = DBA::fetch($users)) {
 165                         $uids[] = $user['uid'];
 166                 }
 167                 DBA::close($users);
 168
 169                 foreach (array_unique($uids) as $uid) {
 170                         self::setNotificationForUser($item, $parent, $uid);
 171                 }
 172         }
 173
 174         /**
 175          * Checks an item for notifications for the given user and sets the "notification-type" field
 176          *
 177          * @param array $item   Item array
 178          * @param array $parent Parent item array
 179          * @param int   $uid    User ID
 180          * @throws HTTPException\InternalServerErrorException
 181          */
 182         private static function setNotificationForUser(array $item, array $parent, int $uid)
 183         {
 184                 if (Post\ThreadUser::getIgnored($item['parent-uri-id'], $uid)) {
 185                         return;
 186                 }
 187
 188                 foreach (array_unique([$parent['author-id'], $parent['owner-id'], $parent['causer-id'], $item['author-id'], $item['owner-id'], $item['causer-id']]) as $author_id) {
 189                         if (empty($author_id)) {
 190                                 continue;
 191                         }
 192                         if (Contact\User::isBlocked($author_id, $uid) || Contact\User::isIgnored($author_id, $uid) || Contact\User::isCollapsed($author_id, $uid)) {
 193                                 Logger::debug('Author is blocked/ignored/collapsed by user', ['uid' => $uid, 'author' => $author_id, 'uri-id' => $item['uri-id']]);
 194                                 return;
 195                         }
 196                 }
 197
 198                 $user = User::getById($uid, ['account-type', 'account_removed', 'account_expired']);
 199                 if (in_array($user['account-type'], [User::ACCOUNT_TYPE_COMMUNITY, User::ACCOUNT_TYPE_RELAY])) {
 200                         return;
 201                 }
 202
 203                 if ($user['account_removed'] || $user['account_expired']) {
 204                         return;
 205                 }
 206
 207                 $author = Contact::getById($item['author-id'], ['contact-type']);
 208                 if (empty($author)) {
 209                         return;
 210                 }
 211
 212                 $notification_type = self::TYPE_NONE;
 213
 214                 if (self::checkShared($item, $uid)) {
 215                         $notification_type = $notification_type | self::TYPE_SHARED;
 216                         self::insertNotificationByItem(self::TYPE_SHARED, $uid, $item);
 217                         $notified = true;
 218                 } elseif ($author['contact-type'] == Contact::TYPE_COMMUNITY) {
 219                         return;
 220                 } else {
 221                         $notified = false;
 222                 }
 223
 224                 $profiles = self::getProfileForUser($uid);
 225
 226                 // Fetch all contacts for the given profiles
 227                 $contacts    = [];
 228                 $iscommunity = false;
 229
 230                 $ret = DBA::select('contact', ['id', 'contact-type'], ['uid' => 0, 'nurl' => $profiles]);
 231                 while ($contact = DBA::fetch($ret)) {
 232                         $contacts[] = $contact['id'];
 233
 234                         if ($contact['contact-type'] == Contact::TYPE_COMMUNITY) {
 235                                 $iscommunity = true;
 236                         }
 237                 }
 238                 DBA::close($ret);
 239
 240                 // Don't create notifications for user's posts
 241                 if (in_array($item['author-id'], $contacts)) {
 242                         return;
 243                 }
 244
 245                 if (($item['verb'] != Activity::ANNOUNCE) && self::checkExplicitMention($item, $profiles)) {
 246                         $notification_type = $notification_type | self::TYPE_EXPLICIT_TAGGED;
 247                         if (!$notified) {
 248                                 self::insertNotificationByItem(self::TYPE_EXPLICIT_TAGGED, $uid, $item);
 249                                 $notified = true;
 250                         }
 251                 }
 252
 253                 if (($item['verb'] != Activity::ANNOUNCE) && self::checkImplicitMention($item, $profiles)) {
 254                         $notification_type = $notification_type | self::TYPE_IMPLICIT_TAGGED;
 255                         if (!$notified) {
 256                                 self::insertNotificationByItem(self::TYPE_IMPLICIT_TAGGED, $uid, $item);
 257                                 $notified = true;
 258                         }
 259                 }
 260
 261                 if (self::checkDirectComment($item, $contacts)) {
 262                         $notification_type = $notification_type | self::TYPE_DIRECT_COMMENT;
 263                         if (!$notified) {
 264                                 self::insertNotificationByItem(self::TYPE_DIRECT_COMMENT, $uid, $item);
 265                                 $notified = true;
 266                         }
 267                 }
 268
 269                 if (!$iscommunity && self::checkDirectCommentedThread($item, $contacts)) {
 270                         $notification_type = $notification_type | self::TYPE_DIRECT_THREAD_COMMENT;
 271                         if (!$notified) {
 272                                 self::insertNotificationByItem(self::TYPE_DIRECT_THREAD_COMMENT, $uid, $item);
 273                                 $notified = true;
 274                         }
 275                 }
 276
 277                 if (($item['verb'] != Activity::ANNOUNCE) && self::checkCommentedThread($item, $contacts)) {
 278                         $notification_type = $notification_type | self::TYPE_THREAD_COMMENT;
 279                         if (!$notified) {
 280                                 self::insertNotificationByItem(self::TYPE_THREAD_COMMENT, $uid, $item);
 281                                 $notified = true;
 282                         }
 283                 }
 284
 285                 if (($item['verb'] != Activity::ANNOUNCE) && self::checkCommentedParticipation($item, $contacts)) {
 286                         $notification_type = $notification_type | self::TYPE_COMMENT_PARTICIPATION;
 287                         if (!$notified) {
 288                                 self::insertNotificationByItem(self::TYPE_COMMENT_PARTICIPATION, $uid, $item);
 289                                 $notified = true;
 290                         }
 291                 }
 292
 293                 if (($item['verb'] != Activity::ANNOUNCE) && self::checkQuoted($item, $contacts)) {
 294                         $notification_type = $notification_type | self::TYPE_QUOTED;
 295                         if (!$notified) {
 296                                 self::insertNotificationByItem(self::TYPE_QUOTED, $uid, $item);
 297                                 $notified = true;
 298                         }
 299                 }
 300
 301                 if (($item['verb'] != Activity::ANNOUNCE) && self::checkFollowParticipation($item, $contacts)) {
 302                         $notification_type = $notification_type | self::TYPE_FOLLOW;
 303                         if (!$notified) {
 304                                 self::insertNotificationByItem(self::TYPE_FOLLOW, $uid, $item);
 305                                 $notified = true;
 306                         }
 307                 }
 308
 309                 if (($item['verb'] != Activity::ANNOUNCE) && self::checkActivityParticipation($item, $contacts)) {
 310                         $notification_type = $notification_type | self::TYPE_ACTIVITY_PARTICIPATION;
 311                         if (!$notified) {
 312                                 self::insertNotificationByItem(self::TYPE_ACTIVITY_PARTICIPATION, $uid, $item);
 313                         }
 314                 }
 315
 316                 if (empty($notification_type)) {
 317                         return;
 318                 }
 319
 320                 // Only create notifications for posts and comments, not for activities
 321                 if (($item['gravity'] == Item::GRAVITY_ACTIVITY) && ($item['verb'] != Activity::ANNOUNCE)) {
 322                         return;
 323                 }
 324
 325                 Logger::info('Set notification', ['uri-id' => $item['uri-id'], 'uid' => $uid, 'notification-type' => $notification_type]);
 326
 327                 $fields = ['notification-type' => $notification_type];
 328                 Post\User::update($item['uri-id'], $uid, $fields);
 329                 self::update($item['uri-id'], $uid, $fields, true);
 330         }
 331
 332         /**
 333          * Add a notification entry for a given item array
 334          *
 335          * @param int   $type User notification type
 336          * @param int   $uid  User ID
 337          * @param array $item Item array
 338          * @return void
 339          * @throws Exception
 340          */
 341         private static function insertNotificationByItem(int $type, int $uid, array $item): void
 342         {
 343                 if (($item['verb'] != Activity::ANNOUNCE) && ($item['gravity'] == Item::GRAVITY_ACTIVITY) &&
 344                         !in_array($type, [self::TYPE_DIRECT_COMMENT, self::TYPE_DIRECT_THREAD_COMMENT])) {
 345                         // Activities are only stored when performed on the user's post or comment
 346                         return;
 347                 }
 348
 349                 $notification = DI::notificationFactory()->createForUser(
 350                         $uid,
 351                         $item['vid'],
 352                         $type,
 353                         $item['author-id'],
 354                         $item['gravity'] == Item::GRAVITY_ACTIVITY ? $item['thr-parent-id'] : $item['uri-id'],
 355                         $item['parent-uri-id']
 356                 );
 357
 358                 try {
 359                         $notification = DI::notification()->save($notification);
 360                         Subscription::pushByNotification($notification);
 361                 } catch (Exception $e) {
 362
 363                 }
 364         }
 365
 366         /**
 367          * Add a notification entry
 368          *
 369          * @param int    $actor Public contact ID of the actor
 370          * @param string $verb  One of the Activity verb constant values
 371          * @param int    $uid   User ID
 372          * @return boolean
 373          * @throws Exception
 374          */
 375         public static function insertNotification(int $actor, string $verb, int $uid): bool
 376         {
 377                 $notification = DI::notificationFactory()->createForRelationship(
 378                         $uid,
 379                         $actor,
 380                         $verb
 381                 );
 382                 try {
 383                         $notification = DI::notification()->save($notification);
 384                         Subscription::pushByNotification($notification);
 385                         return true;
 386                 } catch (Exception $e) {
 387                         return false;
 388                 }
 389         }
 390
 391         /**
 392          * Fetch all profiles (contact URL) of a given user
 393          *
 394          * @param int $uid User ID
 395          *
 396          * @return array Profile links
 397          * @throws HTTPException\InternalServerErrorException
 398          */
 399         private static function getProfileForUser(int $uid): array
 400         {
 401                 $owner = User::getOwnerDataById($uid);
 402                 if (!DBA::isResult($owner)) {
 403                         return [];
 404                 }
 405
 406                 $profiles = [$owner['nurl']];
 407
 408                 $notification_data = ['uid' => $uid, 'profiles' => []];
 409                 Hook::callAll('check_item_notification', $notification_data);
 410
 411                 // Normalize the connector profiles
 412                 foreach ($notification_data['profiles'] as $profile) {
 413                         if (empty(parse_url($profile, PHP_URL_SCHEME)) || empty(parse_url($profile, PHP_URL_HOST)) || empty(parse_url($profile, PHP_URL_PATH))) {
 414                                 $profiles[] = $profile;
 415                         } else {
 416                                 $profiles[] = Strings::normaliseLink($profile);
 417                         }
 418                 }
 419
 420                 return array_unique($profiles);
 421         }
 422
 423         /**
 424          * Check for a "shared" notification for every new post of contacts from the given user
 425          *
 426          * @param array $item
 427          * @param int   $uid User ID
 428          * @return bool A contact had shared something
 429          * @throws Exception
 430          */
 431         private static function checkShared(array $item, int $uid): bool
 432         {
 433                 // Only check on original posts and reshare ("announce") activities, otherwise return
 434                 if (($item['gravity'] != Item::GRAVITY_PARENT) && ($item['verb'] != Activity::ANNOUNCE)) {
 435                         return false;
 436                 }
 437
 438                 // Don't notify about reshares by communities of our own posts or each time someone comments
 439                 if (($item['verb'] == Activity::ANNOUNCE) && DBA::exists('contact', ['id' => $item['contact-id'], 'contact-type' => Contact::TYPE_COMMUNITY])) {
 440                         $post = Post::selectFirst(['origin', 'gravity'], ['uri-id' => $item['thr-parent-id'], 'uid' => $uid]);
 441                         if (!$post || $post['origin'] || ($post['gravity'] != Item::GRAVITY_PARENT)) {
 442                                 return false;
 443                         }
 444                 }
 445
 446                 // Only check on posts by the user itself
 447                 $cdata = Contact::getPublicAndUserContactID($item['contact-id'], $item['uid']);
 448                 if (empty($cdata['user']) || ($item['author-id'] != $cdata['public'])) {
 449                         return false;
 450                 }
 451
 452                 // Check if the contact posted or shared something directly
 453                 if (DBA::exists('contact', ['id' => $item['contact-id'], 'notify_new_posts' => true])) {
 454                         return true;
 455                 }
 456
 457                 return false;
 458         }
 459
 460         /**
 461          * Check for an implicit mention (only in tags, not in body) of the given user
 462          *
 463          * @param array $item
 464          * @param array $profiles Profile links
 465          * @return bool The user is mentioned
 466          * @throws Exception
 467          */
 468         private static function checkImplicitMention(array $item, array $profiles): bool
 469         {
 470                 $mentions = Tag::getByURIId($item['uri-id'], [Tag::IMPLICIT_MENTION]);
 471                 foreach ($mentions as $mention) {
 472                         foreach ($profiles as $profile) {
 473                                 if (Strings::compareLink($profile, $mention['url'])) {
 474                                         return true;
 475                                 }
 476                         }
 477                 }
 478
 479                 return false;
 480         }
 481
 482         /**
 483          * Check for an explicit mention (tag and body) of the given user
 484          *
 485          * @param array $item
 486          * @param array $profiles Profile links
 487          * @return bool The user is mentioned
 488          * @throws Exception
 489          */
 490         private static function checkExplicitMention(array $item, array $profiles): bool
 491         {
 492                 $mentions = Tag::getByURIId($item['uri-id'], [Tag::MENTION, Tag::EXCLUSIVE_MENTION]);
 493                 foreach ($mentions as $mention) {
 494                         foreach ($profiles as $profile) {
 495                                 if (Strings::compareLink($profile, $mention['url'])) {
 496                                         return true;
 497                                 }
 498                         }
 499                 }
 500
 501                 return false;
 502         }
 503
 504         /**
 505          * Check if the given user had created this thread
 506          *
 507          * @param array $item
 508          * @param array $contacts Array of contact IDs
 509          * @return bool The user had created this thread
 510          * @throws Exception
 511          */
 512         private static function checkCommentedThread(array $item, array $contacts): bool
 513         {
 514                 $condition = ['parent' => $item['parent'], 'author-id' => $contacts, 'deleted' => false, 'gravity' => Item::GRAVITY_PARENT];
 515                 return Post::exists($condition);
 516         }
 517
 518         /**
 519          * Check for a direct comment to a post of the given user
 520          *
 521          * @param array $item
 522          * @param array $contacts Array of contact IDs
 523          * @return bool The item is a direct comment to a user comment
 524          * @throws Exception
 525          */
 526         private static function checkDirectComment(array $item, array $contacts): bool
 527         {
 528                 $condition = ['uri' => $item['thr-parent'], 'uid' => $item['uid'], 'author-id' => $contacts, 'deleted' => false, 'gravity' => Item::GRAVITY_COMMENT];
 529                 return Post::exists($condition);
 530         }
 531
 532         /**
 533          * Check for a direct comment to the starting post of the given user
 534          *
 535          * @param array $item
 536          * @param array $contacts Array of contact IDs
 537          * @return bool The user had created this thread
 538          * @throws Exception
 539          */
 540         private static function checkDirectCommentedThread(array $item, array $contacts): bool
 541         {
 542                 $condition = ['uri' => $item['thr-parent'], 'uid' => $item['uid'], 'author-id' => $contacts, 'deleted' => false, 'gravity' => Item::GRAVITY_PARENT];
 543                 return Post::exists($condition);
 544         }
 545
 546         /**
 547          *  Check if the user had commented in this thread
 548          *
 549          * @param array $item
 550          * @param array $contacts Array of contact IDs
 551          * @return bool The user had commented in the thread
 552          * @throws Exception
 553          */
 554         private static function checkCommentedParticipation(array $item, array $contacts): bool
 555         {
 556                 $condition = ['parent' => $item['parent'], 'author-id' => $contacts, 'deleted' => false, 'gravity' => Item::GRAVITY_COMMENT];
 557                 return Post::exists($condition);
 558         }
 559
 560         /**
 561          * Check if the user follows this thread
 562          *
 563          * @param array $item
 564          * @param array $contacts Array of contact IDs
 565          * @return bool The user follows the thread
 566          * @throws Exception
 567          */
 568         private static function checkFollowParticipation(array $item, array $contacts): bool
 569         {
 570                 $condition = ['parent' => $item['parent'], 'author-id' => $contacts, 'deleted' => false, 'gravity' => Item::GRAVITY_ACTIVITY, 'verb' => Activity::FOLLOW];
 571                 return Post::exists($condition);
 572         }
 573
 574         /**
 575          * Check if the user had interacted in this thread (Like, Dislike, ...)
 576          *
 577          * @param array $item
 578          * @param array $contacts Array of contact IDs
 579          * @return bool The user had interacted in the thread
 580          * @throws Exception
 581          */
 582         private static function checkActivityParticipation(array $item, array $contacts): bool
 583         {
 584                 $condition = ['parent' => $item['parent'], 'author-id' => $contacts, 'deleted' => false, 'gravity' => Item::GRAVITY_ACTIVITY];
 585                 return Post::exists($condition);
 586         }
 587
 588         /**
 589          * Check for a quoted post of a post of the given user
 590          *
 591          * @param array $item
 592          * @param array $contacts Array of contact IDs
 593          * @return bool The item is a quoted post of a user's post or comment
 594          * @throws Exception
 595          */
 596         private static function checkQuoted(array $item, array $contacts): bool
 597         {
 598                 if (empty($item['quote-uri-id'])) {
 599                         return false;
 600                 }
 601                 $condition = ['uri-id' => $item['quote-uri-id'], 'uid' => $item['uid'], 'author-id' => $contacts, 'deleted' => false, 'gravity' => [item::GRAVITY_PARENT, Item::GRAVITY_COMMENT]];
 602                 return Post::exists($condition);
 603         }
 604
 605
 606 }