3 * @copyright Copyright (C) 2010-2022, the Friendica project
5 * @license GNU AGPL version 3 or any later version
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.
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.
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/>.
22 namespace Friendica\Model\Post;
24 use BadMethodCallException;
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;
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;
42 class UserNotification
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;
56 * Insert a new user notification entry
58 * @param integer $uri_id
61 * @return bool success
64 public static function insert(int $uri_id, int $uid, array $data = []): bool
67 throw new BadMethodCallException('Empty URI_id');
70 $fields = DBStructure::getFieldsForTable('post-user-notification', $data);
72 $fields['uri-id'] = $uri_id;
73 $fields['uid'] = $uid;
75 return DBA::insert('post-user-notification', $fields, Database::INSERT_IGNORE);
79 * Update a user notification entry
81 * @param integer $uri_id
84 * @param bool $insert_if_missing
88 public static function update(int $uri_id, int $uid, array $data = [], bool $insert_if_missing = false): bool
91 throw new BadMethodCallException('Empty URI_id');
94 $fields = DBStructure::getFieldsForTable('post-user-notification', $data);
96 // Remove the key fields
97 unset($fields['uri-id']);
98 unset($fields['uid']);
100 if (empty($fields)) {
104 return DBA::update('post-user-notification', $fields, ['uri-id' => $uri_id, 'uid' => $uid], $insert_if_missing ? true : []);
108 * Delete a row from the post-user-notification table
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)
114 * @return boolean was the deletion successful?
117 public static function delete(array $conditions, array $options = []): bool
119 return DBA::delete('post-user-notification', $conditions, $options);
123 * Checks an item for notifications and sets the "notification-type" field
126 * - Check for mentions in posts with "uid=0" where the user hadn't interacted before
128 * @param int $uri_id URI ID
129 * @param int $uid user ID
132 public static function setNotification(int $uri_id, int $uid)
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)) {
141 // "Activity::FOLLOW" is an automated activity, so we ignore it here
142 if ($item['verb'] == Activity::FOLLOW) {
146 if ($item['uid'] == 0) {
149 // Always include the item user
150 $uids = [$item['uid']];
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'];
162 foreach (array_unique($uids) as $uid) {
163 self::setNotificationForUser($item, $uid);
168 * Checks an item for notifications for the given user and sets the "notification-type" field
170 * @param array $item Item array
171 * @param int $uid User ID
172 * @throws HTTPException\InternalServerErrorException
174 private static function setNotificationForUser(array $item, int $uid)
176 if (Post\ThreadUser::getIgnored($item['parent-uri-id'], $uid)) {
180 $user = User::getById($uid, ['account-type']);
181 if (in_array($user['account-type'], [User::ACCOUNT_TYPE_COMMUNITY, User::ACCOUNT_TYPE_RELAY])) {
185 $author = Contact::getById($item['author-id'], ['contact-type']);
186 if (empty($author)) {
190 $notification_type = self::TYPE_NONE;
192 if (self::checkShared($item, $uid)) {
193 $notification_type = $notification_type | self::TYPE_SHARED;
194 self::insertNotificationByItem(self::TYPE_SHARED, $uid, $item);
200 $profiles = self::getProfileForUser($uid);
202 // Fetch all contacts for the given profiles
204 $iscommunity = false;
206 $ret = DBA::select('contact', ['id', 'contact-type'], ['uid' => 0, 'nurl' => $profiles]);
207 while ($contact = DBA::fetch($ret)) {
208 $contacts[] = $contact['id'];
210 if ($contact['contact-type'] == Contact::TYPE_COMMUNITY) {
216 // Don't create notifications for user's posts
217 if (in_array($item['author-id'], $contacts)) {
221 if (self::checkExplicitMention($item, $profiles)) {
222 $notification_type = $notification_type | self::TYPE_EXPLICIT_TAGGED;
224 self::insertNotificationByItem(self::TYPE_EXPLICIT_TAGGED, $uid, $item);
229 if (self::checkImplicitMention($item, $profiles)) {
230 $notification_type = $notification_type | self::TYPE_IMPLICIT_TAGGED;
232 self::insertNotificationByItem(self::TYPE_IMPLICIT_TAGGED, $uid, $item);
237 if (self::checkDirectComment($item, $contacts)) {
238 $notification_type = $notification_type | self::TYPE_DIRECT_COMMENT;
240 self::insertNotificationByItem(self::TYPE_DIRECT_COMMENT, $uid, $item);
245 if (!$iscommunity && self::checkDirectCommentedThread($item, $contacts)) {
246 $notification_type = $notification_type | self::TYPE_DIRECT_THREAD_COMMENT;
248 self::insertNotificationByItem(self::TYPE_DIRECT_THREAD_COMMENT, $uid, $item);
253 if (self::checkCommentedThread($item, $contacts)) {
254 $notification_type = $notification_type | self::TYPE_THREAD_COMMENT;
256 self::insertNotificationByItem(self::TYPE_THREAD_COMMENT, $uid, $item);
261 if (self::checkCommentedParticipation($item, $contacts)) {
262 $notification_type = $notification_type | self::TYPE_COMMENT_PARTICIPATION;
264 self::insertNotificationByItem(self::TYPE_COMMENT_PARTICIPATION, $uid, $item);
269 if (self::checkActivityParticipation($item, $contacts)) {
270 $notification_type = $notification_type | self::TYPE_ACTIVITY_PARTICIPATION;
272 self::insertNotificationByItem(self::TYPE_ACTIVITY_PARTICIPATION, $uid, $item);
276 if (empty($notification_type)) {
280 // Only create notifications for posts and comments, not for activities
281 if (($item['gravity'] == GRAVITY_ACTIVITY) && ($item['verb'] != Activity::ANNOUNCE)) {
285 Logger::info('Set notification', ['uri-id' => $item['uri-id'], 'uid' => $uid, 'notification-type' => $notification_type]);
287 $fields = ['notification-type' => $notification_type];
288 Post\User::update($item['uri-id'], $uid, $fields);
289 self::update($item['uri-id'], $uid, $fields, true);
293 * Add a notification entry for a given item array
295 * @param int $type User notification type
296 * @param int $uid User ID
297 * @param array $item Item array
301 private static function insertNotificationByItem(int $type, int $uid, array $item): void
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
309 $notification = (new Notifications\Factory\Notification(DI::logger()))->createForUser(
314 $item['gravity'] == GRAVITY_ACTIVITY ? $item['thr-parent-id'] : $item['uri-id'],
315 $item['parent-uri-id']
319 $notification = DI::notification()->save($notification);
320 Subscription::pushByNotification($notification);
321 } catch (Exception $e) {
327 * Add a notification entry
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
335 public static function insertNotification(int $actor, string $verb, int $uid): bool
337 $notification = (new Notifications\Factory\Notification(DI::logger()))->createForRelationship(
343 $notification = DI::notification()->save($notification);
344 Subscription::pushByNotification($notification);
346 } catch (Exception $e) {
352 * Fetch all profiles (contact URL) of a given user
354 * @param int $uid User ID
356 * @return array Profile links
357 * @throws HTTPException\InternalServerErrorException
359 private static function getProfileForUser(int $uid): array
361 $notification_data = ['uid' => $uid, 'profiles' => []];
362 Hook::callAll('check_item_notification', $notification_data);
364 $profiles = $notification_data['profiles'];
366 $user = DBA::selectFirst('user', ['nickname'], ['uid' => $uid]);
367 if (!DBA::isResult($user)) {
371 $owner = DBA::selectFirst('contact', ['url', 'alias'], ['self' => true, 'uid' => $uid]);
372 if (!DBA::isResult($owner)) {
376 // This is our regular URL format
377 $profiles[] = $owner['url'];
380 $profiles[] = $owner['alias'];
382 // Notifications from Diaspora often have a URL in the Diaspora format
383 $profiles[] = DI::baseUrl() . '/u/' . $user['nickname'];
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]);
393 // Add the normalized form
394 $profile = Strings::normaliseLink($profile);
395 $profiles[] = $profile;
398 $profile = str_replace('http://', 'https://', $profile);
399 $profiles[] = $profile;
402 return array_unique($profiles);
406 * Check for a "shared" notification for every new post of contacts from the given user
409 * @param int $uid User ID
410 * @return bool A contact had shared something
413 private static function checkShared(array $item, int $uid): bool
415 // Only check on original posts and reshare ("announce") activities, otherwise return
416 if (($item['gravity'] != GRAVITY_PARENT) && ($item['verb'] != Activity::ANNOUNCE)) {
420 // Check if the contact posted or shared something directly
421 if (DBA::exists('contact', ['id' => $item['contact-id'], 'notify_new_posts' => true])) {
429 * Check for an implicit mention (only in tags, not in body) of the given user
432 * @param array $profiles Profile links
433 * @return bool The user is mentioned
436 private static function checkImplicitMention(array $item, array $profiles): bool
438 $mentions = Tag::getByURIId($item['uri-id'], [Tag::IMPLICIT_MENTION]);
439 foreach ($mentions as $mention) {
440 foreach ($profiles as $profile) {
441 if (Strings::compareLink($profile, $mention['url'])) {
451 * Check for an explicit mention (tag and body) of the given user
454 * @param array $profiles Profile links
455 * @return bool The user is mentioned
458 private static function checkExplicitMention(array $item, array $profiles): bool
460 $mentions = Tag::getByURIId($item['uri-id'], [Tag::MENTION, Tag::EXCLUSIVE_MENTION]);
461 foreach ($mentions as $mention) {
462 foreach ($profiles as $profile) {
463 if (Strings::compareLink($profile, $mention['url'])) {
473 * Check if the given user had created this thread
476 * @param array $contacts Array of contact IDs
477 * @return bool The user had created this thread
480 private static function checkCommentedThread(array $item, array $contacts): bool
482 $condition = ['parent' => $item['parent'], 'author-id' => $contacts, 'deleted' => false, 'gravity' => GRAVITY_PARENT];
483 return Post::exists($condition);
487 * Check for a direct comment to a post of the given user
490 * @param array $contacts Array of contact IDs
491 * @return bool The item is a direct comment to a user comment
494 private static function checkDirectComment(array $item, array $contacts): bool
496 $condition = ['uri' => $item['thr-parent'], 'uid' => $item['uid'], 'author-id' => $contacts, 'deleted' => false, 'gravity' => GRAVITY_COMMENT];
497 return Post::exists($condition);
501 * Check for a direct comment to the starting post of the given user
504 * @param array $contacts Array of contact IDs
505 * @return bool The user had created this thread
508 private static function checkDirectCommentedThread(array $item, array $contacts): bool
510 $condition = ['uri' => $item['thr-parent'], 'uid' => $item['uid'], 'author-id' => $contacts, 'deleted' => false, 'gravity' => GRAVITY_PARENT];
511 return Post::exists($condition);
515 * Check if the user had commented in this thread
518 * @param array $contacts Array of contact IDs
519 * @return bool The user had commented in the thread
522 private static function checkCommentedParticipation(array $item, array $contacts): bool
524 $condition = ['parent' => $item['parent'], 'author-id' => $contacts, 'deleted' => false, 'gravity' => GRAVITY_COMMENT];
525 return Post::exists($condition);
529 * Check if the user had interacted in this thread (Like, Dislike, ...)
532 * @param array $contacts Array of contact IDs
533 * @return bool The user had interacted in the thread
536 private static function checkActivityParticipation(array $item, array $contacts): bool
538 $condition = ['parent' => $item['parent'], 'author-id' => $contacts, 'deleted' => false, 'gravity' => GRAVITY_ACTIVITY];
539 return Post::exists($condition);