<?php
-
/**
- * @file src/Model/UserItem.php
+ * @copyright Copyright (C) 2020, Friendica
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
*/
namespace Friendica\Model;
+use Friendica\Core\Logger;
use Friendica\Core\Hook;
use Friendica\Database\DBA;
use Friendica\DI;
use Friendica\Util\Strings;
+use Friendica\Model\Tag;
+use Friendica\Protocol\Activity;
class UserItem
{
+ // Notification types
const NOTIF_NONE = 0;
const NOTIF_EXPLICIT_TAGGED = 1;
const NOTIF_IMPLICIT_TAGGED = 2;
const NOTIF_DIRECT_COMMENT = 8;
const NOTIF_COMMENT_PARTICIPATION = 16;
const NOTIF_ACTIVITY_PARTICIPATION = 32;
+ const NOTIF_DIRECT_THREAD_COMMENT = 64;
const NOTIF_SHARED = 128;
/**
* Checks an item for notifications and sets the "notification-type" field
+ * @ToDo:
+ * - Check for mentions in posts with "uid=0" where the user hadn't interacted before
*
- * @param array $item The message array that is checked for notifications
- * @param int $uid User ID
+ * @param int $iid Item ID
*/
- public static function setNotification($item, $uid)
+ public static function setNotification(int $iid)
{
- // Don't check for own posts
- if ($item['origin'] || empty($uid)) {
+ $fields = ['id', 'uri-id', 'parent-uri-id', 'uid', 'body', 'parent', 'gravity', 'tag',
+ 'private', 'contact-id', 'thr-parent', 'parent-uri', 'author-id', 'verb'];
+ $item = Item::selectFirst($fields, ['id' => $iid, 'origin' => false]);
+ if (!DBA::isResult($item)) {
return;
}
- $fields = ['ignored', 'mention'];
- $thread = Item::selectFirstThreadForUser($uid, $fields, ['iid' => $item['parent'], 'deleted' => false]);
- if ($thread['ignored']) {
+ // "Activity::FOLLOW" is an automated activity, so we ignore it here
+ if ($item['verb'] == Activity::FOLLOW) {
return;
}
- $notification_type = self::NOTIF_NONE;
+ if ($item['uid'] == 0) {
+ $uids = [];
+ } else {
+ // Always include the item user
+ $uids = [$item['uid']];
+ }
- if (self::checkShared($item, $uid)) {
- $notification_type = $notification_type | self::NOTIF_SHARED;
+ // Add every user who participated so far in this thread
+ // This can only happen with participations on global items. (means: uid = 0)
+ $users = DBA::p("SELECT DISTINCT(`contact`.`uid`) FROM `item`
+ INNER JOIN `contact` ON `contact`.`id` = `item`.`contact-id` AND `contact`.`uid` != 0
+ WHERE `parent` IN (SELECT `parent` FROM `item` WHERE `id`=?)", $iid);
+ while ($user = DBA::fetch($users)) {
+ $uids[] = $user['uid'];
}
+ DBA::close($users);
- $profiles = self::getProfileForUser($uid);
+ foreach (array_unique($uids) as $uid) {
+ self::setNotificationForUser($item, $uid);
+ }
+ }
- if (self::checkImplicitMention($item, $uid, $profiles)) {
- $notification_type = $notification_type | self::NOTIF_IMPLICIT_TAGGED;
+ /**
+ * Checks an item for notifications for the given user and sets the "notification-type" field
+ *
+ * @param array $item Item array
+ * @param int $uid User ID
+ */
+ private static function setNotificationForUser(array $item, int $uid)
+ {
+ $thread = Item::selectFirstThreadForUser($uid, ['ignored'], ['iid' => $item['parent'], 'deleted' => false]);
+ if (!empty($thread['ignored'])) {
+ return;
}
- if (self::checkExplicitMention($item, $uid, $profiles)) {
- $notification_type = $notification_type | self::NOTIF_EXPLICIT_TAGGED;
+ $notification_type = self::NOTIF_NONE;
+
+ if (self::checkShared($item, $uid)) {
+ $notification_type = $notification_type | self::NOTIF_SHARED;
}
+ $profiles = self::getProfileForUser($uid);
+
+ // Fetch all contacts for the given profiles
$contacts = [];
$ret = DBA::select('contact', ['id'], ['uid' => 0, 'nurl' => $profiles]);
while ($contact = DBA::fetch($ret)) {
}
DBA::close($ret);
- if (self::checkCommentedThread($item, $uid, $contacts)) {
- $notification_type = $notification_type | self::NOTIF_THREAD_COMMENT;
+ // Don't create notifications for user's posts
+ if (in_array($item['author-id'], $contacts)) {
+ return;
}
- if (self::checkDirectComment($item, $uid, $contacts, $thread)) {
- $notification_type = $notification_type | self::NOTIF_DIRECT_COMMENT;
- }
+ // Only create notifications for posts and comments, not for activities
+ if (in_array($item['gravity'], [GRAVITY_PARENT, GRAVITY_COMMENT])) {
+ if (self::checkImplicitMention($item, $profiles)) {
+ $notification_type = $notification_type | self::NOTIF_IMPLICIT_TAGGED;
+ }
+
+ if (self::checkExplicitMention($item, $profiles)) {
+ $notification_type = $notification_type | self::NOTIF_EXPLICIT_TAGGED;
+ }
+
+ if (self::checkCommentedThread($item, $contacts)) {
+ $notification_type = $notification_type | self::NOTIF_THREAD_COMMENT;
+ }
- if (self::checkCommentedParticipation($item, $uid, $contacts)) {
- $notification_type = $notification_type | self::NOTIF_COMMENT_PARTICIPATION;
+ if (self::checkDirectComment($item, $contacts)) {
+ $notification_type = $notification_type | self::NOTIF_DIRECT_COMMENT;
+ }
+
+ if (self::checkDirectCommentedThread($item, $contacts)) {
+ $notification_type = $notification_type | self::NOTIF_DIRECT_THREAD_COMMENT;
+ }
+
+ if (self::checkCommentedParticipation($item, $contacts)) {
+ $notification_type = $notification_type | self::NOTIF_COMMENT_PARTICIPATION;
+ }
+
+ if (self::checkActivityParticipation($item, $contacts)) {
+ $notification_type = $notification_type | self::NOTIF_ACTIVITY_PARTICIPATION;
+ }
}
- if (self::checkActivityParticipation($item, $uid, $contacts)) {
- $notification_type = $notification_type | self::NOTIF_ACTIVITY_PARTICIPATION;
+ if (empty($notification_type)) {
+ return;
}
+ Logger::info('Set notification', ['iid' => $item['id'], 'uid' => $uid, 'notification-type' => $notification_type]);
+
DBA::update('user-item', ['notification-type' => $notification_type], ['iid' => $item['id'], 'uid' => $uid], true);
}
- // Fetch all contacts for the given profiles
- private static function getProfileForUser($uid)
+ /**
+ * Fetch all profiles (contact URL) of a given user
+ * @param int $uid User ID
+ *
+ * @return array Profile links
+ */
+ private static function getProfileForUser(int $uid)
{
$notification_data = ['uid' => $uid, 'profiles' => []];
Hook::callAll('check_item_notification', $notification_data);
$profiles = $notification_data['profiles'];
- $fields = ['nickname'];
- $user = DBA::selectFirst('user', $fields, ['uid' => $uid]);
+ $user = DBA::selectFirst('user', ['nickname'], ['uid' => $uid]);
if (!DBA::isResult($user)) {
- return false;
+ return [];
}
- $owner = DBA::selectFirst('contact', ['url'], ['self' => true, 'uid' => $uid]);
+ $owner = DBA::selectFirst('contact', ['url', 'alias'], ['self' => true, 'uid' => $uid]);
if (!DBA::isResult($owner)) {
- return false;
+ return [];
}
// This is our regular URL format
$profiles[] = $owner['url'];
- // Notifications from Diaspora are often with an URL in the Diaspora format
- $profiles[] = DI::baseUrl().'/u/'.$user['nickname'];
-
- $profiles2 = [];
+ // Now the alias
+ $profiles[] = $owner['alias'];
- foreach ($profiles AS $profile) {
- // Check for invalid profile urls. 13 should be the shortest possible profile length:
- // http://a.bc/d
- // Additionally check for invalid urls that would return the normalised value "http:"
- if ((strlen($profile) >= 13) && (Strings::normaliseLink($profile) != 'http:')) {
- if (!in_array($profile, $profiles2))
- $profiles2[] = $profile;
+ // Notifications from Diaspora are often with an URL in the Diaspora format
+ $profiles[] = DI::baseUrl() . '/u/' . $user['nickname'];
+
+ // Validate and add profile links
+ foreach ($profiles AS $key => $profile) {
+ // Check for invalid profile urls (without scheme, host or path) and remove them
+ if (empty(parse_url($profile, PHP_URL_SCHEME)) || empty(parse_url($profile, PHP_URL_HOST)) || empty(parse_url($profile, PHP_URL_PATH))) {
+ unset($profiles[$key]);
+ continue;
+ }
- $profile = Strings::normaliseLink($profile);
- if (!in_array($profile, $profiles2))
- $profiles2[] = $profile;
+ // Add the normalized form
+ $profile = Strings::normaliseLink($profile);
+ $profiles[] = $profile;
- $profile = str_replace('http://', 'https://', $profile);
- if (!in_array($profile, $profiles2))
- $profiles2[] = $profile;
- }
+ // Add the SSL form
+ $profile = str_replace('http://', 'https://', $profile);
+ $profiles[] = $profile;
}
- return $profiles2;
+ return array_unique($profiles);
}
- private static function checkShared($item, $uid)
+ /**
+ * Check for a "shared" notification for every new post of contacts from the given user
+ * @param array $item
+ * @param int $uid User ID
+ * @return bool A contact had shared something
+ */
+ private static function checkShared(array $item, int $uid)
{
- if ($item['gravity'] != GRAVITY_PARENT) {
+ // Only check on original posts and reshare ("announce") activities, otherwise return
+ if (($item['gravity'] != GRAVITY_PARENT) && ($item['verb'] != Activity::ANNOUNCE)) {
return false;
}
- // Send a notification for every new post?
- // Either the contact had posted something directly
+ // Check if the contact posted or shared something directly
if (DBA::exists('contact', ['id' => $item['contact-id'], 'notify_new_posts' => true])) {
return true;
}
- // Or the contact is a mentioned forum
- $tags = DBA::select('term', ['url'], ['otype' => TERM_OBJ_POST, 'oid' => $itemid, 'type' => TERM_MENTION, 'uid' => $uid]);
+ // The following check doesn't make sense on activities, so quit here
+ if ($item['verb'] == Activity::ANNOUNCE) {
+ return false;
+ }
+
+ // Check if the contact is a mentioned forum
+ $tags = DBA::select('tag-view', ['url'], ['uri-id' => $item['uri-id'], 'type' => [Tag::MENTION, Tag::EXCLUSIVE_MENTION]]);
while ($tag = DBA::fetch($tags)) {
$condition = ['nurl' => Strings::normaliseLink($tag['url']), 'uid' => $uid, 'notify_new_posts' => true, 'contact-type' => Contact::TYPE_COMMUNITY];
if (DBA::exists('contact', $condition)) {
return true;
}
}
+ DBA::close($tags);
return false;
}
- // Is the user mentioned in this post?
- private static function checkImplicitMention($item, $uid, $profiles)
+ /**
+ * Check for an implicit mention (only tag, no body) of the given user
+ * @param array $item
+ * @param array $profiles Profile links
+ * @return bool The user is mentioned
+ */
+ private static function checkImplicitMention(array $item, array $profiles)
{
- foreach ($profiles AS $profile) {
- if (strpos($item['tag'], '='.$profile.']') || strpos($item['body'], '='.$profile.']'))
- return true;
+ $mentions = Tag::getByURIId($item['uri-id'], [Tag::IMPLICIT_MENTION]);
+ foreach ($mentions as $mention) {
+ foreach ($profiles as $profile) {
+ if (Strings::compareLink($profile, $mention['url'])) {
+ return true;
+ }
+ }
}
return false;
}
- private static function checkExplicitMention($item, $uid, $profiles)
+ /**
+ * Check for an explicit mention (tag and body) of the given user
+ * @param array $item
+ * @param array $profiles Profile links
+ * @return bool The user is mentioned
+ */
+ private static function checkExplicitMention(array $item, array $profiles)
{
- foreach ($profiles AS $profile) {
- if (strpos($item['tag'], '='.$profile.']') || strpos($item['body'], '='.$profile.']'))
- return !(strpos($item['body'], $profile) === false);
+ $mentions = Tag::getByURIId($item['uri-id'], [Tag::MENTION, Tag::EXCLUSIVE_MENTION]);
+ foreach ($mentions as $mention) {
+ foreach ($profiles as $profile) {
+ if (Strings::compareLink($profile, $mention['url'])) {
+ return true;
+ }
+ }
}
return false;
}
- // Is it a post that the user had started?
- private static function checkCommentedThread($item, $uid, $contacts)
+ /**
+ * Check if the given user had created this thread
+ * @param array $item
+ * @param array $contacts Array of contact IDs
+ * @return bool The user had created this thread
+ */
+ private static function checkCommentedThread(array $item, array $contacts)
{
- // Additional check for connector posts
$condition = ['parent' => $item['parent'], 'author-id' => $contacts, 'deleted' => false, 'gravity' => GRAVITY_PARENT];
return Item::exists($condition);
}
- private static function checkDirectComment($item, $uid, $contacts)
+ /**
+ * Check for a direct comment to a post of the given user
+ * @param array $item
+ * @param array $contacts Array of contact IDs
+ * @return bool The item is a direct comment to a user comment
+ */
+ private static function checkDirectComment(array $item, array $contacts)
+ {
+ $condition = ['uri' => $item['thr-parent'], 'uid' => $item['uid'], 'author-id' => $contacts, 'deleted' => false, 'gravity' => GRAVITY_COMMENT];
+ return Item::exists($condition);
+ }
+
+ /**
+ * Check for a direct comment to the starting post of the given user
+ * @param array $item
+ * @param array $contacts Array of contact IDs
+ * @return bool The user had created this thread
+ */
+ private static function checkDirectCommentedThread(array $item, array $contacts)
{
- // Additional check for connector posts
- $condition = ['uri' => $item['thr-parent'], 'uid' => [0, $uid], 'author-id' => $contacts, 'deleted' => false, 'gravity' => GRAVITY_COMMENT];
+ $condition = ['uri' => $item['thr-parent'], 'uid' => $item['uid'], 'author-id' => $contacts, 'deleted' => false, 'gravity' => GRAVITY_PARENT];
return Item::exists($condition);
}
- // Check for participation of one of our contacts in the thread
- private static function checkCommentedParticipation($item, $uid, $contacts)
+ /**
+ * Check if the user had commented in this thread
+ * @param array $item
+ * @param array $contacts Array of contact IDs
+ * @return bool The user had commented in the thread
+ */
+ private static function checkCommentedParticipation(array $item, array $contacts)
{
$condition = ['parent' => $item['parent'], 'author-id' => $contacts, 'deleted' => false, 'gravity' => GRAVITY_COMMENT];
return Item::exists($condition);
}
- private static function checkActivityParticipation($item, $uid, $contacts)
+ /**
+ * Check if the user had interacted in this thread (Like, Dislike, ...)
+ * @param array $item
+ * @param array $contacts Array of contact IDs
+ * @return bool The user had interacted in the thread
+ */
+ private static function checkActivityParticipation(array $item, array $contacts)
{
$condition = ['parent' => $item['parent'], 'author-id' => $contacts, 'deleted' => false, 'gravity' => GRAVITY_ACTIVITY];
return Item::exists($condition);
projects / friendica.git / blobdiff