src/Model/UserItem.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2020, Friendica
   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;
  23
  24 use Friendica\Core\Logger;
  25 use Friendica\Core\Hook;
  26 use Friendica\Database\DBA;
  27 use Friendica\DI;
  28 use Friendica\Util\Strings;
  29 use Friendica\Model\Tag;
  30 use Friendica\Protocol\Activity;
  31
  32 class UserItem
  33 {
  34         // Notification types
  35         const NOTIF_NONE = 0;
  36         const NOTIF_EXPLICIT_TAGGED = 1;
  37         const NOTIF_IMPLICIT_TAGGED = 2;
  38         const NOTIF_THREAD_COMMENT = 4;
  39         const NOTIF_DIRECT_COMMENT = 8;
  40         const NOTIF_COMMENT_PARTICIPATION = 16;
  41         const NOTIF_ACTIVITY_PARTICIPATION = 32;
  42         const NOTIF_DIRECT_THREAD_COMMENT = 64;
  43         const NOTIF_SHARED = 128;
  44
  45         /**
  46          * Checks an item for notifications and sets the "notification-type" field
  47          * @ToDo:
  48          * - Check for mentions in posts with "uid=0" where the user hadn't interacted before
  49          *
  50          * @param int $iid Item ID
  51          */
  52         public static function setNotification(int $iid)
  53         {
  54                 $fields = ['id', 'uri-id', 'parent-uri-id', 'uid', 'body', 'parent', 'gravity', 'tag',
  55                         'private', 'contact-id', 'thr-parent', 'parent-uri', 'author-id', 'verb'];
  56                 $item = Item::selectFirst($fields, ['id' => $iid, 'origin' => false]);
  57                 if (!DBA::isResult($item)) {
  58                         return;
  59                 }
  60
  61                 // "Activity::FOLLOW" is an automated activity, so we ignore it here
  62                 if ($item['verb'] == Activity::FOLLOW) {
  63                         return;
  64                 }
  65
  66                 if ($item['uid'] == 0) {
  67                         $uids = [];
  68                 } else {
  69                         // Always include the item user
  70                         $uids = [$item['uid']];
  71                 }
  72
  73                 // Add every user who participated so far in this thread
  74                 // This can only happen with participations on global items. (means: uid = 0)
  75                 $users = DBA::p("SELECT DISTINCT(`contact`.`uid`) FROM `item`
  76                         INNER JOIN `contact` ON `contact`.`id` = `item`.`contact-id` AND `contact`.`uid` != 0
  77                         WHERE `parent` IN (SELECT `parent` FROM `item` WHERE `id`=?)", $iid);
  78                 while ($user = DBA::fetch($users)) {
  79                         $uids[] = $user['uid'];
  80                 }
  81                 DBA::close($users);
  82
  83                 foreach (array_unique($uids) as $uid) {
  84                         self::setNotificationForUser($item, $uid);
  85                 }
  86         }
  87
  88         /**
  89          * Checks an item for notifications for the given user and sets the "notification-type" field
  90          *
  91          * @param array $item Item array
  92          * @param int   $uid  User ID
  93          */
  94         private static function setNotificationForUser(array $item, int $uid)
  95         {
  96                 $thread = Item::selectFirstThreadForUser($uid, ['ignored'], ['iid' => $item['parent'], 'deleted' => false]);
  97                 if (!empty($thread['ignored'])) {
  98                         return;
  99                 }
 100
 101                 $notification_type = self::NOTIF_NONE;
 102
 103                 if (self::checkShared($item, $uid)) {
 104                         $notification_type = $notification_type | self::NOTIF_SHARED;
 105                 }
 106
 107                 $profiles = self::getProfileForUser($uid);
 108
 109                 // Fetch all contacts for the given profiles
 110                 $contacts = [];
 111                 $ret = DBA::select('contact', ['id'], ['uid' => 0, 'nurl' => $profiles]);
 112                 while ($contact = DBA::fetch($ret)) {
 113                         $contacts[] = $contact['id'];
 114                 }
 115                 DBA::close($ret);
 116
 117                 // Don't create notifications for user's posts
 118                 if (in_array($item['author-id'], $contacts)) {
 119                         return;
 120                 }
 121
 122                 // Only create notifications for posts and comments, not for activities
 123                 if (in_array($item['gravity'], [GRAVITY_PARENT, GRAVITY_COMMENT])) {
 124                         if (self::checkImplicitMention($item, $profiles)) {
 125                                 $notification_type = $notification_type | self::NOTIF_IMPLICIT_TAGGED;
 126                         }
 127
 128                         if (self::checkExplicitMention($item, $profiles)) {
 129                                 $notification_type = $notification_type | self::NOTIF_EXPLICIT_TAGGED;
 130                         }
 131
 132                         if (self::checkCommentedThread($item, $contacts)) {
 133                                 $notification_type = $notification_type | self::NOTIF_THREAD_COMMENT;
 134                         }
 135
 136                         if (self::checkDirectComment($item, $contacts)) {
 137                                 $notification_type = $notification_type | self::NOTIF_DIRECT_COMMENT;
 138                         }
 139
 140                         if (self::checkDirectCommentedThread($item, $contacts)) {
 141                                 $notification_type = $notification_type | self::NOTIF_DIRECT_THREAD_COMMENT;
 142                         }
 143
 144                         if (self::checkCommentedParticipation($item, $contacts)) {
 145                                 $notification_type = $notification_type | self::NOTIF_COMMENT_PARTICIPATION;
 146                         }
 147
 148                         if (self::checkActivityParticipation($item, $contacts)) {
 149                                 $notification_type = $notification_type | self::NOTIF_ACTIVITY_PARTICIPATION;
 150                         }
 151                 }
 152
 153                 if (empty($notification_type)) {
 154                         return;
 155                 }
 156
 157                 Logger::info('Set notification', ['iid' => $item['id'], 'uid' => $uid, 'notification-type' => $notification_type]);
 158
 159                 $fields = ['notification-type' => $notification_type];
 160                 Post\User::update($item['uri-id'], $uid, $fields);
 161                 DBA::update('user-item', $fields, ['iid' => $item['id'], 'uid' => $uid], true);
 162         }
 163
 164         /**
 165          * Fetch all profiles (contact URL) of a given user
 166          * @param int $uid User ID
 167          *
 168          * @return array Profile links
 169          */
 170         private static function getProfileForUser(int $uid)
 171         {
 172                 $notification_data = ['uid' => $uid, 'profiles' => []];
 173                 Hook::callAll('check_item_notification', $notification_data);
 174
 175                 $profiles = $notification_data['profiles'];
 176
 177                 $user = DBA::selectFirst('user', ['nickname'], ['uid' => $uid]);
 178                 if (!DBA::isResult($user)) {
 179                         return [];
 180                 }
 181
 182                 $owner = DBA::selectFirst('contact', ['url', 'alias'], ['self' => true, 'uid' => $uid]);
 183                 if (!DBA::isResult($owner)) {
 184                         return [];
 185                 }
 186
 187                 // This is our regular URL format
 188                 $profiles[] = $owner['url'];
 189
 190                 // Now the alias
 191                 $profiles[] = $owner['alias'];
 192
 193                 // Notifications from Diaspora are often with an URL in the Diaspora format
 194                 $profiles[] = DI::baseUrl() . '/u/' . $user['nickname'];
 195
 196                 // Validate and add profile links
 197                 foreach ($profiles AS $key => $profile) {
 198                         // Check for invalid profile urls (without scheme, host or path) and remove them
 199                         if (empty(parse_url($profile, PHP_URL_SCHEME)) || empty(parse_url($profile, PHP_URL_HOST)) || empty(parse_url($profile, PHP_URL_PATH))) {
 200                                 unset($profiles[$key]);
 201                                 continue;
 202                         }
 203
 204                         // Add the normalized form
 205                         $profile = Strings::normaliseLink($profile);
 206                         $profiles[] = $profile;
 207
 208                         // Add the SSL form
 209                         $profile = str_replace('http://', 'https://', $profile);
 210                         $profiles[] = $profile;
 211                 }
 212
 213                 return array_unique($profiles);
 214         }
 215
 216         /**
 217          * Check for a "shared" notification for every new post of contacts from the given user
 218          * @param array $item
 219          * @param int   $uid  User ID
 220          * @return bool A contact had shared something
 221          */
 222         private static function checkShared(array $item, int $uid)
 223         {
 224                 // Only check on original posts and reshare ("announce") activities, otherwise return
 225                 if (($item['gravity'] != GRAVITY_PARENT) && ($item['verb'] != Activity::ANNOUNCE)) {
 226                         return false;
 227                 }
 228
 229                 // Check if the contact posted or shared something directly
 230                 if (DBA::exists('contact', ['id' => $item['contact-id'], 'notify_new_posts' => true])) {
 231                         return true;
 232                 }
 233
 234                 // The following check doesn't make sense on activities, so quit here
 235                 if ($item['verb'] == Activity::ANNOUNCE) {
 236                         return false;
 237                 }
 238
 239                 // Check if the contact is a mentioned forum
 240                 $tags = DBA::select('tag-view', ['url'], ['uri-id' => $item['uri-id'], 'type' => [Tag::MENTION, Tag::EXCLUSIVE_MENTION]]);
 241                 while ($tag = DBA::fetch($tags)) {
 242                         $condition = ['nurl' => Strings::normaliseLink($tag['url']), 'uid' => $uid, 'notify_new_posts' => true, 'contact-type' => Contact::TYPE_COMMUNITY];
 243                         if (DBA::exists('contact', $condition)) {
 244                                 return true;
 245                         }
 246                 }
 247                 DBA::close($tags);
 248
 249                 return false;
 250         }
 251
 252         /**
 253          * Check for an implicit mention (only tag, no body) of the given user
 254          * @param array $item
 255          * @param array $profiles Profile links
 256          * @return bool The user is mentioned
 257          */
 258         private static function checkImplicitMention(array $item, array $profiles)
 259         {
 260                 $mentions = Tag::getByURIId($item['uri-id'], [Tag::IMPLICIT_MENTION]);
 261                 foreach ($mentions as $mention) {
 262                         foreach ($profiles as $profile) {
 263                                 if (Strings::compareLink($profile, $mention['url'])) {
 264                                         return true;
 265                                 }
 266                         }
 267                 }
 268
 269                 return false;
 270         }
 271
 272         /**
 273          * Check for an explicit mention (tag and body) of the given user
 274          * @param array $item
 275          * @param array $profiles Profile links
 276          * @return bool The user is mentioned
 277          */
 278         private static function checkExplicitMention(array $item, array $profiles)
 279         {
 280                 $mentions = Tag::getByURIId($item['uri-id'], [Tag::MENTION, Tag::EXCLUSIVE_MENTION]);
 281                 foreach ($mentions as $mention) {
 282                         foreach ($profiles as $profile) {
 283                                 if (Strings::compareLink($profile, $mention['url'])) {
 284                                         return true;
 285                                 }
 286                         }
 287                 }
 288
 289                 return false;
 290         }
 291
 292         /**
 293          * Check if the given user had created this thread
 294          * @param array $item
 295          * @param array $contacts Array of contact IDs
 296          * @return bool The user had created this thread
 297          */
 298         private static function checkCommentedThread(array $item, array $contacts)
 299         {
 300                 $condition = ['parent' => $item['parent'], 'author-id' => $contacts, 'deleted' => false, 'gravity' => GRAVITY_PARENT];
 301                 return Item::exists($condition);
 302         }
 303
 304         /**
 305          * Check for a direct comment to a post of the given user
 306          * @param array $item
 307          * @param array $contacts Array of contact IDs
 308          * @return bool The item is a direct comment to a user comment
 309          */
 310         private static function checkDirectComment(array $item, array $contacts)
 311         {
 312                 $condition = ['uri' => $item['thr-parent'], 'uid' => $item['uid'], 'author-id' => $contacts, 'deleted' => false, 'gravity' => GRAVITY_COMMENT];
 313                 return Item::exists($condition);
 314         }
 315
 316         /**
 317          * Check for a direct comment to the starting post of the given user
 318          * @param array $item
 319          * @param array $contacts Array of contact IDs
 320          * @return bool The user had created this thread
 321          */
 322         private static function checkDirectCommentedThread(array $item, array $contacts)
 323         {
 324                 $condition = ['uri' => $item['thr-parent'], 'uid' => $item['uid'], 'author-id' => $contacts, 'deleted' => false, 'gravity' => GRAVITY_PARENT];
 325                 return Item::exists($condition);
 326         }
 327
 328         /**
 329          *  Check if the user had commented in this thread
 330          * @param array $item
 331          * @param array $contacts Array of contact IDs
 332          * @return bool The user had commented in the thread
 333          */
 334         private static function checkCommentedParticipation(array $item, array $contacts)
 335         {
 336                 $condition = ['parent' => $item['parent'], 'author-id' => $contacts, 'deleted' => false, 'gravity' => GRAVITY_COMMENT];
 337                 return Item::exists($condition);
 338         }
 339
 340         /**
 341          * Check if the user had interacted in this thread (Like, Dislike, ...)
 342          * @param array $item
 343          * @param array $contacts Array of contact IDs
 344          * @return bool The user had interacted in the thread
 345          */
 346         private static function checkActivityParticipation(array $item, array $contacts)
 347         {
 348                 $condition = ['parent' => $item['parent'], 'author-id' => $contacts, 'deleted' => false, 'gravity' => GRAVITY_ACTIVITY];
 349                 return Item::exists($condition);
 350         }
 351 }