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