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\Item;
34 use Friendica\Model\Post;
35 use Friendica\Model\Subscription;
36 use Friendica\Model\Tag;
37 use Friendica\Model\User;
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;
54 const TYPE_FOLLOW = 256;
57 * Insert a new user notification entry
59 * @param integer $uri_id
62 * @return bool success
65 public static function insert(int $uri_id, int $uid, array $data = []): bool
68 throw new BadMethodCallException('Empty URI_id');
71 $fields = DI::dbaDefinition()->truncateFieldsForTable('post-user-notification', $data);
73 $fields['uri-id'] = $uri_id;
74 $fields['uid'] = $uid;
76 return DBA::insert('post-user-notification', $fields, Database::INSERT_IGNORE);
80 * Update a user notification entry
82 * @param integer $uri_id
85 * @param bool $insert_if_missing
89 public static function update(int $uri_id, int $uid, array $data = [], bool $insert_if_missing = false): bool
92 throw new BadMethodCallException('Empty URI_id');
95 $fields = DI::dbaDefinition()->truncateFieldsForTable('post-user-notification', $data);
97 // Remove the key fields
98 unset($fields['uri-id']);
99 unset($fields['uid']);
101 if (empty($fields)) {
105 return DBA::update('post-user-notification', $fields, ['uri-id' => $uri_id, 'uid' => $uid], $insert_if_missing ? true : []);
109 * Delete a row from the post-user-notification table
111 * @param array $conditions Field condition(s)
112 * @param array $options - cascade: If true we delete records in other tables that depend on the one we're deleting through
113 * relations (default: true)
115 * @return boolean was the deletion successful?
118 public static function delete(array $conditions, array $options = []): bool
120 return DBA::delete('post-user-notification', $conditions, $options);
124 * Checks an item for notifications and sets the "notification-type" field
127 * - Check for mentions in posts with "uid=0" where the user hadn't interacted before
129 * @param int $uri_id URI ID
130 * @param int $uid user ID
133 public static function setNotification(int $uri_id, int $uid)
135 $fields = ['id', 'uri-id', 'parent-uri-id', 'uid', 'body', 'parent', 'gravity', 'vid', 'gravity',
136 'private', 'contact-id', 'thr-parent', 'thr-parent-id', 'parent-uri-id', 'parent-uri', 'author-id', 'verb'];
137 $item = Post::selectFirst($fields, ['uri-id' => $uri_id, 'uid' => $uid, 'origin' => false]);
138 if (!DBA::isResult($item)) {
142 // "Activity::FOLLOW" is an automated activity, so we ignore it here
143 if ($item['verb'] == Activity::FOLLOW) {
147 if ($item['uid'] == 0) {
150 // Always include the item user
151 $uids = [$item['uid']];
154 // Add every user who participated so far in this thread
155 // This can only happen with participations on global items. (means: uid = 0)
156 $users = DBA::p("SELECT DISTINCT(`contact-uid`) AS `uid` FROM `post-user-view`
157 WHERE `contact-uid` != 0 AND `parent-uri-id` = ? AND `uid` = ?", $item['parent-uri-id'], $uid);
158 while ($user = DBA::fetch($users)) {
159 $uids[] = $user['uid'];
163 foreach (array_unique($uids) as $uid) {
164 self::setNotificationForUser($item, $uid);
169 * Checks an item for notifications for the given user and sets the "notification-type" field
171 * @param array $item Item array
172 * @param int $uid User ID
173 * @throws HTTPException\InternalServerErrorException
175 private static function setNotificationForUser(array $item, int $uid)
177 if (Post\ThreadUser::getIgnored($item['parent-uri-id'], $uid)) {
181 $user = User::getById($uid, ['account-type']);
182 if (in_array($user['account-type'], [User::ACCOUNT_TYPE_COMMUNITY, User::ACCOUNT_TYPE_RELAY])) {
186 $author = Contact::getById($item['author-id'], ['contact-type']);
187 if (empty($author)) {
191 $notification_type = self::TYPE_NONE;
193 if (self::checkShared($item, $uid)) {
194 $notification_type = $notification_type | self::TYPE_SHARED;
195 self::insertNotificationByItem(self::TYPE_SHARED, $uid, $item);
197 } elseif ($author['contact-type'] == Contact::TYPE_COMMUNITY) {
203 $profiles = self::getProfileForUser($uid);
205 // Fetch all contacts for the given profiles
207 $iscommunity = false;
209 $ret = DBA::select('contact', ['id', 'contact-type'], ['uid' => 0, 'nurl' => $profiles]);
210 while ($contact = DBA::fetch($ret)) {
211 $contacts[] = $contact['id'];
213 if ($contact['contact-type'] == Contact::TYPE_COMMUNITY) {
219 // Don't create notifications for user's posts
220 if (in_array($item['author-id'], $contacts)) {
224 if (($item['verb'] != Activity::ANNOUNCE) && self::checkExplicitMention($item, $profiles)) {
225 $notification_type = $notification_type | self::TYPE_EXPLICIT_TAGGED;
227 self::insertNotificationByItem(self::TYPE_EXPLICIT_TAGGED, $uid, $item);
232 if (($item['verb'] != Activity::ANNOUNCE) && self::checkImplicitMention($item, $profiles)) {
233 $notification_type = $notification_type | self::TYPE_IMPLICIT_TAGGED;
235 self::insertNotificationByItem(self::TYPE_IMPLICIT_TAGGED, $uid, $item);
240 if (self::checkDirectComment($item, $contacts)) {
241 $notification_type = $notification_type | self::TYPE_DIRECT_COMMENT;
243 self::insertNotificationByItem(self::TYPE_DIRECT_COMMENT, $uid, $item);
248 if (!$iscommunity && self::checkDirectCommentedThread($item, $contacts)) {
249 $notification_type = $notification_type | self::TYPE_DIRECT_THREAD_COMMENT;
251 self::insertNotificationByItem(self::TYPE_DIRECT_THREAD_COMMENT, $uid, $item);
256 if (($item['verb'] != Activity::ANNOUNCE) && self::checkCommentedThread($item, $contacts)) {
257 $notification_type = $notification_type | self::TYPE_THREAD_COMMENT;
259 self::insertNotificationByItem(self::TYPE_THREAD_COMMENT, $uid, $item);
264 if (($item['verb'] != Activity::ANNOUNCE) && self::checkCommentedParticipation($item, $contacts)) {
265 $notification_type = $notification_type | self::TYPE_COMMENT_PARTICIPATION;
267 self::insertNotificationByItem(self::TYPE_COMMENT_PARTICIPATION, $uid, $item);
272 if (($item['verb'] != Activity::ANNOUNCE) && self::checkFollowParticipation($item, $contacts)) {
273 $notification_type = $notification_type | self::TYPE_FOLLOW;
275 self::insertNotificationByItem(self::TYPE_FOLLOW, $uid, $item);
280 if (($item['verb'] != Activity::ANNOUNCE) && self::checkActivityParticipation($item, $contacts)) {
281 $notification_type = $notification_type | self::TYPE_ACTIVITY_PARTICIPATION;
283 self::insertNotificationByItem(self::TYPE_ACTIVITY_PARTICIPATION, $uid, $item);
287 if (empty($notification_type)) {
291 // Only create notifications for posts and comments, not for activities
292 if (($item['gravity'] == Item::GRAVITY_ACTIVITY) && ($item['verb'] != Activity::ANNOUNCE)) {
296 Logger::info('Set notification', ['uri-id' => $item['uri-id'], 'uid' => $uid, 'notification-type' => $notification_type]);
298 $fields = ['notification-type' => $notification_type];
299 Post\User::update($item['uri-id'], $uid, $fields);
300 self::update($item['uri-id'], $uid, $fields, true);
304 * Add a notification entry for a given item array
306 * @param int $type User notification type
307 * @param int $uid User ID
308 * @param array $item Item array
312 private static function insertNotificationByItem(int $type, int $uid, array $item): void
314 if (($item['verb'] != Activity::ANNOUNCE) && ($item['gravity'] == Item::GRAVITY_ACTIVITY) &&
315 !in_array($type, [self::TYPE_DIRECT_COMMENT, self::TYPE_DIRECT_THREAD_COMMENT])) {
316 // Activities are only stored when performed on the user's post or comment
320 $notification = DI::notificationFactory()->createForUser(
325 $item['gravity'] == Item::GRAVITY_ACTIVITY ? $item['thr-parent-id'] : $item['uri-id'],
326 $item['parent-uri-id']
330 $notification = DI::notification()->save($notification);
331 Subscription::pushByNotification($notification);
332 } catch (Exception $e) {
338 * Add a notification entry
340 * @param int $actor Public contact ID of the actor
341 * @param string $verb One of the Activity verb constant values
342 * @param int $uid User ID
346 public static function insertNotification(int $actor, string $verb, int $uid): bool
348 $notification = DI::notificationFactory()->createForRelationship(
354 $notification = DI::notification()->save($notification);
355 Subscription::pushByNotification($notification);
357 } catch (Exception $e) {
363 * Fetch all profiles (contact URL) of a given user
365 * @param int $uid User ID
367 * @return array Profile links
368 * @throws HTTPException\InternalServerErrorException
370 private static function getProfileForUser(int $uid): array
372 $notification_data = ['uid' => $uid, 'profiles' => []];
373 Hook::callAll('check_item_notification', $notification_data);
375 $profiles = $notification_data['profiles'];
377 $user = DBA::selectFirst('user', ['nickname'], ['uid' => $uid]);
378 if (!DBA::isResult($user)) {
382 $owner = DBA::selectFirst('contact', ['url', 'alias'], ['self' => true, 'uid' => $uid]);
383 if (!DBA::isResult($owner)) {
387 // This is our regular URL format
388 $profiles[] = $owner['url'];
391 $profiles[] = $owner['alias'];
393 // Notifications from Diaspora often have a URL in the Diaspora format
394 $profiles[] = DI::baseUrl() . '/u/' . $user['nickname'];
396 // Validate and add profile links
397 foreach ($profiles as $key => $profile) {
398 // Check for invalid profile urls (without scheme, host or path) and remove them
399 if (empty(parse_url($profile, PHP_URL_SCHEME)) || empty(parse_url($profile, PHP_URL_HOST)) || empty(parse_url($profile, PHP_URL_PATH))) {
400 unset($profiles[$key]);
404 // Add the normalized form
405 $profile = Strings::normaliseLink($profile);
406 $profiles[] = $profile;
409 $profile = str_replace('http://', 'https://', $profile);
410 $profiles[] = $profile;
413 return array_unique($profiles);
417 * Check for a "shared" notification for every new post of contacts from the given user
420 * @param int $uid User ID
421 * @return bool A contact had shared something
424 private static function checkShared(array $item, int $uid): bool
426 // Only check on original posts and reshare ("announce") activities, otherwise return
427 if (($item['gravity'] != Item::GRAVITY_PARENT) && ($item['verb'] != Activity::ANNOUNCE)) {
431 // Don't notify about reshares by communities of our own posts or each time someone comments
432 if (($item['verb'] == Activity::ANNOUNCE) && DBA::exists('contact', ['id' => $item['contact-id'], 'contact-type' => Contact::TYPE_COMMUNITY])) {
433 $post = Post::selectFirst(['origin', 'gravity'], ['uri-id' => $item['thr-parent-id'], 'uid' => $uid]);
434 if ($post['origin'] || ($post['gravity'] != Item::GRAVITY_PARENT)) {
439 // Check if the contact posted or shared something directly
440 if (DBA::exists('contact', ['id' => $item['contact-id'], 'notify_new_posts' => true])) {
448 * Check for an implicit mention (only in tags, not in body) of the given user
451 * @param array $profiles Profile links
452 * @return bool The user is mentioned
455 private static function checkImplicitMention(array $item, array $profiles): bool
457 $mentions = Tag::getByURIId($item['uri-id'], [Tag::IMPLICIT_MENTION]);
458 foreach ($mentions as $mention) {
459 foreach ($profiles as $profile) {
460 if (Strings::compareLink($profile, $mention['url'])) {
470 * Check for an explicit mention (tag and body) of the given user
473 * @param array $profiles Profile links
474 * @return bool The user is mentioned
477 private static function checkExplicitMention(array $item, array $profiles): bool
479 $mentions = Tag::getByURIId($item['uri-id'], [Tag::MENTION, Tag::EXCLUSIVE_MENTION]);
480 foreach ($mentions as $mention) {
481 foreach ($profiles as $profile) {
482 if (Strings::compareLink($profile, $mention['url'])) {
492 * Check if the given user had created this thread
495 * @param array $contacts Array of contact IDs
496 * @return bool The user had created this thread
499 private static function checkCommentedThread(array $item, array $contacts): bool
501 $condition = ['parent' => $item['parent'], 'author-id' => $contacts, 'deleted' => false, 'gravity' => Item::GRAVITY_PARENT];
502 return Post::exists($condition);
506 * Check for a direct comment to a post of the given user
509 * @param array $contacts Array of contact IDs
510 * @return bool The item is a direct comment to a user comment
513 private static function checkDirectComment(array $item, array $contacts): bool
515 $condition = ['uri' => $item['thr-parent'], 'uid' => $item['uid'], 'author-id' => $contacts, 'deleted' => false, 'gravity' => Item::GRAVITY_COMMENT];
516 return Post::exists($condition);
520 * Check for a direct comment to the starting post of the given user
523 * @param array $contacts Array of contact IDs
524 * @return bool The user had created this thread
527 private static function checkDirectCommentedThread(array $item, array $contacts): bool
529 $condition = ['uri' => $item['thr-parent'], 'uid' => $item['uid'], 'author-id' => $contacts, 'deleted' => false, 'gravity' => Item::GRAVITY_PARENT];
530 return Post::exists($condition);
534 * Check if the user had commented in this thread
537 * @param array $contacts Array of contact IDs
538 * @return bool The user had commented in the thread
541 private static function checkCommentedParticipation(array $item, array $contacts): bool
543 $condition = ['parent' => $item['parent'], 'author-id' => $contacts, 'deleted' => false, 'gravity' => Item::GRAVITY_COMMENT];
544 return Post::exists($condition);
548 * Check if the user follows this thread
551 * @param array $contacts Array of contact IDs
552 * @return bool The user follows the thread
555 private static function checkFollowParticipation(array $item, array $contacts): bool
557 $condition = ['parent' => $item['parent'], 'author-id' => $contacts, 'deleted' => false, 'gravity' => Item::GRAVITY_ACTIVITY, 'verb' => Activity::FOLLOW];
558 return Post::exists($condition);
562 * Check if the user had interacted in this thread (Like, Dislike, ...)
565 * @param array $contacts Array of contact IDs
566 * @return bool The user had interacted in the thread
569 private static function checkActivityParticipation(array $item, array $contacts): bool
571 $condition = ['parent' => $item['parent'], 'author-id' => $contacts, 'deleted' => false, 'gravity' => Item::GRAVITY_ACTIVITY];
572 return Post::exists($condition);