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
 205                 $ret = DBA::select('contact', ['id'], ['uid' => 0, 'nurl' => $profiles]);
 206                 while ($contact = DBA::fetch($ret)) {
 207                         $contacts[] = $contact['id'];
 208                 }
 209                 DBA::close($ret);
 210
 211                 // Don't create notifications for user's posts
 212                 if (in_array($item['author-id'], $contacts)) {
 213                         return;
 214                 }
 215
 216                 if (self::checkExplicitMention($item, $profiles)) {
 217                         $notification_type = $notification_type | self::TYPE_EXPLICIT_TAGGED;
 218                         if (!$notified) {
 219                                 self::insertNotificationByItem(self::TYPE_EXPLICIT_TAGGED, $uid, $item);
 220                                 $notified = true;
 221                         }
 222                 }
 223
 224                 if (self::checkImplicitMention($item, $profiles)) {
 225                         $notification_type = $notification_type | self::TYPE_IMPLICIT_TAGGED;
 226                         if (!$notified) {
 227                                 self::insertNotificationByItem(self::TYPE_IMPLICIT_TAGGED, $uid, $item);
 228                                 $notified = true;
 229                         }
 230                 }
 231
 232                 if (self::checkDirectComment($item, $contacts)) {
 233                         $notification_type = $notification_type | self::TYPE_DIRECT_COMMENT;
 234                         if (!$notified) {
 235                                 self::insertNotificationByItem(self::TYPE_DIRECT_COMMENT, $uid, $item);
 236                                 $notified = true;
 237                         }
 238                 }
 239
 240                 if (($contact['contact-type'] != Contact::TYPE_COMMUNITY) && self::checkDirectCommentedThread($item, $contacts)) {
 241                         $notification_type = $notification_type | self::TYPE_DIRECT_THREAD_COMMENT;
 242                         if (!$notified) {
 243                                 self::insertNotificationByItem(self::TYPE_DIRECT_THREAD_COMMENT, $uid, $item);
 244                                 $notified = true;
 245                         }
 246                 }
 247
 248                 if (self::checkCommentedThread($item, $contacts)) {
 249                         $notification_type = $notification_type | self::TYPE_THREAD_COMMENT;
 250                         if (!$notified) {
 251                                 self::insertNotificationByItem(self::TYPE_THREAD_COMMENT, $uid, $item);
 252                                 $notified = true;
 253                         }
 254                 }
 255
 256                 if (self::checkCommentedParticipation($item, $contacts)) {
 257                         $notification_type = $notification_type | self::TYPE_COMMENT_PARTICIPATION;
 258                         if (!$notified) {
 259                                 self::insertNotificationByItem(self::TYPE_COMMENT_PARTICIPATION, $uid, $item);
 260                                 $notified = true;
 261                         }
 262                 }
 263
 264                 if (self::checkActivityParticipation($item, $contacts)) {
 265                         $notification_type = $notification_type | self::TYPE_ACTIVITY_PARTICIPATION;
 266                         if (!$notified) {
 267                                 self::insertNotificationByItem(self::TYPE_ACTIVITY_PARTICIPATION, $uid, $item);
 268                         }
 269                 }
 270
 271                 if (empty($notification_type)) {
 272                         return;
 273                 }
 274
 275                 // Only create notifications for posts and comments, not for activities
 276                 if (($item['gravity'] == GRAVITY_ACTIVITY) && ($item['verb'] != Activity::ANNOUNCE)) {
 277                         return;
 278                 }
 279
 280                 Logger::info('Set notification', ['uri-id' => $item['uri-id'], 'uid' => $uid, 'notification-type' => $notification_type]);
 281
 282                 $fields = ['notification-type' => $notification_type];
 283                 Post\User::update($item['uri-id'], $uid, $fields);
 284                 self::update($item['uri-id'], $uid, $fields, true);
 285         }
 286
 287         /**
 288          * Add a notification entry for a given item array
 289          *
 290          * @param int   $type User notification type
 291          * @param int   $uid  User ID
 292          * @param array $item Item array
 293          * @return void
 294          * @throws Exception
 295          */
 296         private static function insertNotificationByItem(int $type, int $uid, array $item): void
 297         {
 298                 if (($item['verb'] != Activity::ANNOUNCE) && ($item['gravity'] == GRAVITY_ACTIVITY) &&
 299                         !in_array($type, [self::TYPE_DIRECT_COMMENT, self::TYPE_DIRECT_THREAD_COMMENT])) {
 300                         // Activities are only stored when performed on the user's post or comment
 301                         return;
 302                 }
 303
 304                 $notification = (new Notifications\Factory\Notification(DI::logger()))->createForUser(
 305                         $uid,
 306                         $item['vid'],
 307                         $type,
 308                         $item['author-id'],
 309                         $item['gravity'] == GRAVITY_ACTIVITY ? $item['thr-parent-id'] : $item['uri-id'],
 310                         $item['parent-uri-id']
 311                 );
 312
 313                 try {
 314                         $notification = DI::notification()->save($notification);
 315                         Subscription::pushByNotification($notification);
 316                 } catch (Exception $e) {
 317
 318                 }
 319         }
 320
 321         /**
 322          * Add a notification entry
 323          *
 324          * @param int    $actor Contact ID of the actor
 325          * @param string $verb  One of the Activity verb constant values
 326          * @param int    $uid   User ID
 327          * @return boolean
 328          * @throws Exception
 329          */
 330         public static function insertNotification(int $actor, string $verb, int $uid): bool
 331         {
 332                 $notification = (new Notifications\Factory\Notification(DI::logger()))->createForRelationship(
 333                         $uid,
 334                         $actor,
 335                         $verb
 336                 );
 337                 try {
 338                         $notification = DI::notification()->save($notification);
 339                         Subscription::pushByNotification($notification);
 340                         return true;
 341                 } catch (Exception $e) {
 342                         return false;
 343                 }
 344         }
 345
 346         /**
 347          * Fetch all profiles (contact URL) of a given user
 348          *
 349          * @param int $uid User ID
 350          *
 351          * @return array Profile links
 352          * @throws HTTPException\InternalServerErrorException
 353          */
 354         private static function getProfileForUser(int $uid): array
 355         {
 356                 $notification_data = ['uid' => $uid, 'profiles' => []];
 357                 Hook::callAll('check_item_notification', $notification_data);
 358
 359                 $profiles = $notification_data['profiles'];
 360
 361                 $user = DBA::selectFirst('user', ['nickname'], ['uid' => $uid]);
 362                 if (!DBA::isResult($user)) {
 363                         return [];
 364                 }
 365
 366                 $owner = DBA::selectFirst('contact', ['url', 'alias'], ['self' => true, 'uid' => $uid]);
 367                 if (!DBA::isResult($owner)) {
 368                         return [];
 369                 }
 370
 371                 // This is our regular URL format
 372                 $profiles[] = $owner['url'];
 373
 374                 // Now the alias
 375                 $profiles[] = $owner['alias'];
 376
 377                 // Notifications from Diaspora often have a URL in the Diaspora format
 378                 $profiles[] = DI::baseUrl() . '/u/' . $user['nickname'];
 379
 380                 // Validate and add profile links
 381                 foreach ($profiles as $key => $profile) {
 382                         // Check for invalid profile urls (without scheme, host or path) and remove them
 383                         if (empty(parse_url($profile, PHP_URL_SCHEME)) || empty(parse_url($profile, PHP_URL_HOST)) || empty(parse_url($profile, PHP_URL_PATH))) {
 384                                 unset($profiles[$key]);
 385                                 continue;
 386                         }
 387
 388                         // Add the normalized form
 389                         $profile    = Strings::normaliseLink($profile);
 390                         $profiles[] = $profile;
 391
 392                         // Add the SSL form
 393                         $profile    = str_replace('http://', 'https://', $profile);
 394                         $profiles[] = $profile;
 395                 }
 396
 397                 return array_unique($profiles);
 398         }
 399
 400         /**
 401          * Check for a "shared" notification for every new post of contacts from the given user
 402          *
 403          * @param array $item
 404          * @param int   $uid User ID
 405          * @return bool A contact had shared something
 406          * @throws Exception
 407          */
 408         private static function checkShared(array $item, int $uid): bool
 409         {
 410                 // Only check on original posts and reshare ("announce") activities, otherwise return
 411                 if (($item['gravity'] != GRAVITY_PARENT) && ($item['verb'] != Activity::ANNOUNCE)) {
 412                         return false;
 413                 }
 414
 415                 // Check if the contact posted or shared something directly
 416                 if (DBA::exists('contact', ['id' => $item['contact-id'], 'notify_new_posts' => true])) {
 417                         return true;
 418                 }
 419
 420                 return false;
 421         }
 422
 423         /**
 424          * Check for an implicit mention (only in tags, not in body) of the given user
 425          *
 426          * @param array $item
 427          * @param array $profiles Profile links
 428          * @return bool The user is mentioned
 429          * @throws Exception
 430          */
 431         private static function checkImplicitMention(array $item, array $profiles): bool
 432         {
 433                 $mentions = Tag::getByURIId($item['uri-id'], [Tag::IMPLICIT_MENTION]);
 434                 foreach ($mentions as $mention) {
 435                         foreach ($profiles as $profile) {
 436                                 if (Strings::compareLink($profile, $mention['url'])) {
 437                                         return true;
 438                                 }
 439                         }
 440                 }
 441
 442                 return false;
 443         }
 444
 445         /**
 446          * Check for an explicit mention (tag and body) of the given user
 447          *
 448          * @param array $item
 449          * @param array $profiles Profile links
 450          * @return bool The user is mentioned
 451          * @throws Exception
 452          */
 453         private static function checkExplicitMention(array $item, array $profiles): bool
 454         {
 455                 $mentions = Tag::getByURIId($item['uri-id'], [Tag::MENTION, Tag::EXCLUSIVE_MENTION]);
 456                 foreach ($mentions as $mention) {
 457                         foreach ($profiles as $profile) {
 458                                 if (Strings::compareLink($profile, $mention['url'])) {
 459                                         return true;
 460                                 }
 461                         }
 462                 }
 463
 464                 return false;
 465         }
 466
 467         /**
 468          * Check if the given user had created this thread
 469          *
 470          * @param array $item
 471          * @param array $contacts Array of contact IDs
 472          * @return bool The user had created this thread
 473          * @throws Exception
 474          */
 475         private static function checkCommentedThread(array $item, array $contacts): bool
 476         {
 477                 $condition = ['parent' => $item['parent'], 'author-id' => $contacts, 'deleted' => false, 'gravity' => GRAVITY_PARENT];
 478                 return Post::exists($condition);
 479         }
 480
 481         /**
 482          * Check for a direct comment to a post of the given user
 483          *
 484          * @param array $item
 485          * @param array $contacts Array of contact IDs
 486          * @return bool The item is a direct comment to a user comment
 487          * @throws Exception
 488          */
 489         private static function checkDirectComment(array $item, array $contacts): bool
 490         {
 491                 $condition = ['uri' => $item['thr-parent'], 'uid' => $item['uid'], 'author-id' => $contacts, 'deleted' => false, 'gravity' => GRAVITY_COMMENT];
 492                 return Post::exists($condition);
 493         }
 494
 495         /**
 496          * Check for a direct comment to the starting post of the given user
 497          *
 498          * @param array $item
 499          * @param array $contacts Array of contact IDs
 500          * @return bool The user had created this thread
 501          * @throws Exception
 502          */
 503         private static function checkDirectCommentedThread(array $item, array $contacts): bool
 504         {
 505                 $condition = ['uri' => $item['thr-parent'], 'uid' => $item['uid'], 'author-id' => $contacts, 'deleted' => false, 'gravity' => GRAVITY_PARENT];
 506                 return Post::exists($condition);
 507         }
 508
 509         /**
 510          *  Check if the user had commented in this thread
 511          *
 512          * @param array $item
 513          * @param array $contacts Array of contact IDs
 514          * @return bool The user had commented in the thread
 515          * @throws Exception
 516          */
 517         private static function checkCommentedParticipation(array $item, array $contacts): bool
 518         {
 519                 $condition = ['parent' => $item['parent'], 'author-id' => $contacts, 'deleted' => false, 'gravity' => GRAVITY_COMMENT];
 520                 return Post::exists($condition);
 521         }
 522
 523         /**
 524          * Check if the user had interacted in this thread (Like, Dislike, ...)
 525          *
 526          * @param array $item
 527          * @param array $contacts Array of contact IDs
 528          * @return bool The user had interacted in the thread
 529          * @throws Exception
 530          */
 531         private static function checkActivityParticipation(array $item, array $contacts): bool
 532         {
 533                 $condition = ['parent' => $item['parent'], 'author-id' => $contacts, 'deleted' => false, 'gravity' => GRAVITY_ACTIVITY];
 534                 return Post::exists($condition);
 535         }
 536 }