Friendica/friendica-github
1
0
Fork 0
mirror of https://github.com/friendica/friendica synced 2025-04-26 17:50:11 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #10722 from MrPetovan/task/refactor-notifications

Browse source 
Move notify, notifications and introduction notifications to new paradigm
This commit is contained in:
Michael Vogel 2021-10-03 14:13:28 +02:00 • committed by GitHub
commit 3d97149007
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
57 changed files with 2452 additions and 1948 deletions
Download patch file Download diff file Expand all files Collapse all files

222
src/Model/Post/UserNotification.php
View file

@ -21,9 +21,10 @@
namespace Friendica\Model\Post;
use \BadMethodCallException;
use Friendica\Core\Logger;
use BadMethodCallException;
use Exception;
use Friendica\Core\Hook;
use Friendica\Core\Logger;
use Friendica\Database\Database;
use Friendica\Database\DBA;
use Friendica\Database\DBStructure;
@ -31,35 +32,35 @@ use Friendica\DI;
use Friendica\Model\Contact;
use Friendica\Model\Post;
use Friendica\Model\Subscription;
use Friendica\Util\Strings;
use Friendica\Model\Tag;
use Friendica\Navigation\Notifications;
use Friendica\Network\HTTPException;
use Friendica\Protocol\Activity;
use Friendica\Util\DateTimeFormat;
use Friendica\Util\Strings;
class UserNotification
{
// Notification types
const NOTIF_NONE = 0;
const NOTIF_EXPLICIT_TAGGED = 1;
const NOTIF_IMPLICIT_TAGGED = 2;
const NOTIF_THREAD_COMMENT = 4;
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;
const TYPE_NONE = 0;
const TYPE_EXPLICIT_TAGGED = 1;
const TYPE_IMPLICIT_TAGGED = 2;
const TYPE_THREAD_COMMENT = 4;
const TYPE_DIRECT_COMMENT = 8;
const TYPE_COMMENT_PARTICIPATION = 16;
const TYPE_ACTIVITY_PARTICIPATION = 32;
const TYPE_DIRECT_THREAD_COMMENT = 64;
const TYPE_SHARED = 128;
/**
* Insert a new user notification entry
*
* @param integer $uri_id
* @param integer $uid
* @param array $fields
* @param array $data
* @return bool success
* @throws \Exception
* @throws Exception
*/
public static function insert(int $uri_id, int $uid, array $data = [])
public static function insert(int $uri_id, int $uid, array $data = []): bool
{
if (empty($uri_id)) {
throw new BadMethodCallException('Empty URI_id');
@ -67,9 +68,8 @@ class UserNotification
$fields = DBStructure::getFieldsForTable('post-user-notification', $data);
// Additionally assign the key fields
$fields['uri-id'] = $uri_id;
$fields['uid'] = $uid;
$fields['uid'] = $uid;
return DBA::insert('post-user-notification', $fields, Database::INSERT_IGNORE);
}
@ -82,9 +82,9 @@ class UserNotification
* @param array $data
* @param bool $insert_if_missing
* @return bool
* @throws \Exception
* @throws Exception
*/
public static function update(int $uri_id, int $uid, array $data = [], bool $insert_if_missing = false)
public static function update(int $uri_id, int $uid, array $data = [], bool $insert_if_missing = false): bool
{
if (empty($uri_id)) {
throw new BadMethodCallException('Empty URI_id');
@ -106,32 +106,33 @@ class UserNotification
/**
* Delete a row from the post-user-notification table
*
* @param array $conditions Field condition(s)
* @param array $options
* - cascade: If true we delete records in other tables that depend on the one we're deleting through
* @param array $conditions Field condition(s)
* @param array $options - cascade: If true we delete records in other tables that depend on the one we're deleting through
* relations (default: true)
*
* @return boolean was the delete successful?
* @throws \Exception
* @return boolean was the deletion successful?
* @throws Exception
*/
public static function delete(array $conditions, array $options = [])
public static function delete(array $conditions, array $options = []): bool
{
return DBA::delete('post-user-notification', $conditions, $options);
}
/**
* 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 int $uri_id URI ID
* @param int $uid user ID
* @throws Exception
*/
public static function setNotification(int $uri_id, int $uid)
{
$fields = ['id', 'uri-id', 'parent-uri-id', 'uid', 'body', 'parent', 'gravity', 'vid', 'gravity',
'private', 'contact-id', 'thr-parent', 'thr-parent-id', 'parent-uri-id', 'parent-uri', 'author-id', 'verb'];
$item = Post::selectFirst($fields, ['uri-id' => $uri_id, 'uid' => $uid, 'origin' => false]);
'private', 'contact-id', 'thr-parent', 'thr-parent-id', 'parent-uri-id', 'parent-uri', 'author-id', 'verb'];
$item = Post::selectFirst($fields, ['uri-id' => $uri_id, 'uid' => $uid, 'origin' => false]);
if (!DBA::isResult($item)) {
return;
}
@ -167,6 +168,7 @@ class UserNotification
*
* @param array $item Item array
* @param int $uid User ID
* @throws HTTPException\InternalServerErrorException
*/
private static function setNotificationForUser(array $item, int $uid)
{
@ -174,11 +176,11 @@ class UserNotification
return;
}
$notification_type = self::NOTIF_NONE;
$notification_type = self::TYPE_NONE;
if (self::checkShared($item, $uid)) {
$notification_type = $notification_type | self::NOTIF_SHARED;
self::insertNoticationByItem(self::NOTIF_SHARED, $uid, $item);
$notification_type = $notification_type | self::TYPE_SHARED;
self::insertNotificationByItem(self::TYPE_SHARED, $uid, $item);
$notified = true;
} else {
$notified = false;
@ -188,6 +190,7 @@ class UserNotification
// Fetch all contacts for the given profiles
$contacts = [];
$ret = DBA::select('contact', ['id'], ['uid' => 0, 'nurl' => $profiles]);
while ($contact = DBA::fetch($ret)) {
$contacts[] = $contact['id'];
@ -200,58 +203,57 @@ class UserNotification
}
if (self::checkExplicitMention($item, $profiles)) {
$notification_type = $notification_type | self::NOTIF_EXPLICIT_TAGGED;
$notification_type = $notification_type | self::TYPE_EXPLICIT_TAGGED;
if (!$notified) {
self::insertNoticationByItem( self::NOTIF_EXPLICIT_TAGGED, $uid, $item);
self::insertNotificationByItem(self::TYPE_EXPLICIT_TAGGED, $uid, $item);
$notified = true;
}
}
if (self::checkImplicitMention($item, $profiles)) {
$notification_type = $notification_type | self::NOTIF_IMPLICIT_TAGGED;
$notification_type = $notification_type | self::TYPE_IMPLICIT_TAGGED;
if (!$notified) {
self::insertNoticationByItem(self::NOTIF_IMPLICIT_TAGGED, $uid, $item);
self::insertNotificationByItem(self::TYPE_IMPLICIT_TAGGED, $uid, $item);
$notified = true;
}
}
if (self::checkDirectComment($item, $contacts)) {
$notification_type = $notification_type | self::NOTIF_DIRECT_COMMENT;
$notification_type = $notification_type | self::TYPE_DIRECT_COMMENT;
if (!$notified) {
self::insertNoticationByItem(self::NOTIF_DIRECT_COMMENT, $uid, $item);
self::insertNotificationByItem(self::TYPE_DIRECT_COMMENT, $uid, $item);
$notified = true;
}
}
if (self::checkDirectCommentedThread($item, $contacts)) {
$notification_type = $notification_type | self::NOTIF_DIRECT_THREAD_COMMENT;
$notification_type = $notification_type | self::TYPE_DIRECT_THREAD_COMMENT;
if (!$notified) {
self::insertNoticationByItem(self::NOTIF_DIRECT_THREAD_COMMENT, $uid, $item);
self::insertNotificationByItem(self::TYPE_DIRECT_THREAD_COMMENT, $uid, $item);
$notified = true;
}
}
if (self::checkCommentedThread($item, $contacts)) {
$notification_type = $notification_type | self::NOTIF_THREAD_COMMENT;
$notification_type = $notification_type | self::TYPE_THREAD_COMMENT;
if (!$notified) {
self::insertNoticationByItem(self::NOTIF_THREAD_COMMENT, $uid, $item);
self::insertNotificationByItem(self::TYPE_THREAD_COMMENT, $uid, $item);
$notified = true;
}
}
if (self::checkCommentedParticipation($item, $contacts)) {
$notification_type = $notification_type | self::NOTIF_COMMENT_PARTICIPATION;
$notification_type = $notification_type | self::TYPE_COMMENT_PARTICIPATION;
if (!$notified) {
self::insertNoticationByItem(self::NOTIF_COMMENT_PARTICIPATION, $uid, $item);
self::insertNotificationByItem(self::TYPE_COMMENT_PARTICIPATION, $uid, $item);
$notified = true;
}
}
if (self::checkActivityParticipation($item, $contacts)) {
$notification_type = $notification_type | self::NOTIF_ACTIVITY_PARTICIPATION;
$notification_type = $notification_type | self::TYPE_ACTIVITY_PARTICIPATION;
if (!$notified) {
self::insertNoticationByItem(self::NOTIF_ACTIVITY_PARTICIPATION, $uid, $item);
$notified = true;
self::insertNotificationByItem(self::TYPE_ACTIVITY_PARTICIPATION, $uid, $item);
}
}
@ -270,79 +272,71 @@ class UserNotification
/**
* Add a notification entry for a given item array
*
* @param int $type User notification type
* @param int $uid User ID
* @param int $type User notification type
* @param int $uid User ID
* @param array $item Item array
* @return boolean
* @return void
* @throws Exception
*/
private static function insertNoticationByItem(int $type, int $uid, array $item)
private static function insertNotificationByItem(int $type, int $uid, array $item): void
{
if (($item['gravity'] == GRAVITY_ACTIVITY) &&
!in_array($type, [self::NOTIF_DIRECT_COMMENT, self::NOTIF_DIRECT_THREAD_COMMENT])) {
!in_array($type, [self::TYPE_DIRECT_COMMENT, self::TYPE_DIRECT_THREAD_COMMENT])) {
// Activities are only stored when performed on the user's post or comment
return;
}
$fields = [
'uid' => $uid,
'vid' => $item['vid'],
'type' => $type,
'actor-id' => $item['author-id'],
'parent-uri-id' => $item['parent-uri-id'],
'created' => DateTimeFormat::utcNow(),
];
$notification = (new Notifications\Factory\Notification(DI::logger()))->createForUser(
$uid,
$item['vid'],
$type,
$item['author-id'],
$item['gravity'] == GRAVITY_ACTIVITY ? $item['thr-parent-id'] : $item['uri-id'],
$item['parent-uri-id']
);
if ($item['gravity'] == GRAVITY_ACTIVITY) {
$fields['target-uri-id'] = $item['thr-parent-id'];
} else {
$fields['target-uri-id'] = $item['uri-id'];
}
try {
$notification = DI::notification()->save($notification);
Subscription::pushByNotification($notification);
} catch (Exception $e) {
$ret = DBA::insert('notification', $fields, Database::INSERT_IGNORE);
if ($ret) {
$id = DBA::lastInsertId();
if (!empty($id)) {
Subscription::pushByNotificationId($id);
}
}
return $ret;
}
/**
* Add a notification entry
*
* @param int $actor Contact ID of the actor
* @param int $vid Verb ID
* @param int $uid User ID
* @param int $actor Contact ID of the actor
* @param string $verb One of the Activity verb constant values
* @param int $uid User ID
* @return boolean
* @throws Exception
*/
public static function insertNotication(int $actor, int $vid, int $uid)
public static function insertNotification(int $actor, string $verb, int $uid): bool
{
$fields = [
'uid' => $uid,
'vid' => $vid,
'type' => self::NOTIF_NONE,
'actor-id' => $actor,
'created' => DateTimeFormat::utcNow(),
];
$ret = DBA::insert('notification', $fields, Database::INSERT_IGNORE);
if ($ret) {
$id = DBA::lastInsertId();
if (!empty($id)) {
Subscription::pushByNotificationId($id);
}
$notification = (new Notifications\Factory\Notification(DI::logger()))->createForRelationship(
$uid,
$actor,
$verb
);
try {
$notification = DI::notification()->save($notification);
Subscription::pushByNotification($notification);
return true;
} catch (Exception $e) {
return false;
}
return $ret;
}
/**
* Fetch all profiles (contact URL) of a given user
*
* @param int $uid User ID
*
* @return array Profile links
* @throws HTTPException\InternalServerErrorException
*/
private static function getProfileForUser(int $uid)
private static function getProfileForUser(int $uid): array
{
$notification_data = ['uid' => $uid, 'profiles' => []];
Hook::callAll('check_item_notification', $notification_data);
@ -365,11 +359,11 @@ class UserNotification
// Now the alias
$profiles[] = $owner['alias'];
// Notifications from Diaspora are often with an URL in the Diaspora format
// Notifications from Diaspora often have a URL in the Diaspora format
$profiles[] = DI::baseUrl() . '/u/' . $user['nickname'];
// Validate and add profile links
foreach ($profiles AS $key => $profile) {
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]);
@ -377,11 +371,11 @@ class UserNotification
}
// Add the normalized form
$profile = Strings::normaliseLink($profile);
$profile = Strings::normaliseLink($profile);
$profiles[] = $profile;
// Add the SSL form
$profile = str_replace('http://', 'https://', $profile);
$profile = str_replace('http://', 'https://', $profile);
$profiles[] = $profile;
}
@ -390,11 +384,13 @@ class UserNotification
/**
* Check for a "shared" notification for every new post of contacts from the given user
*
* @param array $item
* @param int $uid User ID
* @param int $uid User ID
* @return bool A contact had shared something
* @throws Exception
*/
private static function checkShared(array $item, int $uid)
private static function checkShared(array $item, int $uid): bool
{
// Only check on original posts and reshare ("announce") activities, otherwise return
if (($item['gravity'] != GRAVITY_PARENT) && ($item['verb'] != Activity::ANNOUNCE)) {
@ -425,12 +421,14 @@ class UserNotification
}
/**
* Check for an implicit mention (only tag, no body) of the given user
* Check for an implicit mention (only in tags, not in body) of the given user
*
* @param array $item
* @param array $profiles Profile links
* @return bool The user is mentioned
* @throws Exception
*/
private static function checkImplicitMention(array $item, array $profiles)
private static function checkImplicitMention(array $item, array $profiles): bool
{
$mentions = Tag::getByURIId($item['uri-id'], [Tag::IMPLICIT_MENTION]);
foreach ($mentions as $mention) {
@ -446,11 +444,13 @@ class UserNotification
/**
* 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
* @throws Exception
*/
private static function checkExplicitMention(array $item, array $profiles)
private static function checkExplicitMention(array $item, array $profiles): bool
{
$mentions = Tag::getByURIId($item['uri-id'], [Tag::MENTION, Tag::EXCLUSIVE_MENTION]);
foreach ($mentions as $mention) {
@ -466,11 +466,13 @@ class UserNotification
/**
* 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
* @throws Exception
*/
private static function checkCommentedThread(array $item, array $contacts)
private static function checkCommentedThread(array $item, array $contacts): bool
{
$condition = ['parent' => $item['parent'], 'author-id' => $contacts, 'deleted' => false, 'gravity' => GRAVITY_PARENT];
return Post::exists($condition);
@ -478,11 +480,13 @@ class UserNotification
/**
* 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
* @throws Exception
*/
private static function checkDirectComment(array $item, array $contacts)
private static function checkDirectComment(array $item, array $contacts): bool
{
$condition = ['uri' => $item['thr-parent'], 'uid' => $item['uid'], 'author-id' => $contacts, 'deleted' => false, 'gravity' => GRAVITY_COMMENT];
return Post::exists($condition);
@ -490,11 +494,13 @@ class UserNotification
/**
* 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
* @throws Exception
*/
private static function checkDirectCommentedThread(array $item, array $contacts)
private static function checkDirectCommentedThread(array $item, array $contacts): bool
{
$condition = ['uri' => $item['thr-parent'], 'uid' => $item['uid'], 'author-id' => $contacts, 'deleted' => false, 'gravity' => GRAVITY_PARENT];
return Post::exists($condition);
@ -502,11 +508,13 @@ class UserNotification
/**
* 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
* @throws Exception
*/
private static function checkCommentedParticipation(array $item, array $contacts)
private static function checkCommentedParticipation(array $item, array $contacts): bool
{
$condition = ['parent' => $item['parent'], 'author-id' => $contacts, 'deleted' => false, 'gravity' => GRAVITY_COMMENT];
return Post::exists($condition);
@ -514,11 +522,13 @@ class UserNotification
/**
* 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
* @throws Exception
*/
private static function checkActivityParticipation(array $item, array $contacts)
private static function checkActivityParticipation(array $item, array $contacts): bool
{
$condition = ['parent' => $item['parent'], 'author-id' => $contacts, 'deleted' => false, 'gravity' => GRAVITY_ACTIVITY];
return Post::exists($condition);