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