]> git.mxchange.org Git - friendica.git/blobdiff - src/Model/UserItem.php
Improved documentation, now checking all items
[friendica.git] / src / Model / UserItem.php
index 1888906fa75e1b33e62398b9bf6382d514116de6..029e7afb629f77e9de118d0c8185d7a6ca867d87 100644 (file)
@@ -6,6 +6,7 @@
 
 namespace Friendica\Model;
 
+use Friendica\Core\Logger;
 use Friendica\Core\Hook;
 use Friendica\Database\DBA;
 use Friendica\DI;
@@ -13,52 +14,131 @@ use Friendica\Util\Strings;
 
 class UserItem
 {
+       // 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_SHARED = 128;
+
        /**
         * Checks an item for notifications and sets the "notification-type" field
         *
-        * @param array $item The message array that is checked for notifications
+        * @param int $iid Item ID
+        */
+       public static function setNotification(int $iid)
+       {
+               $fields = ['id', 'uid', 'body', 'parent', 'gravity', 'tag', 'contact-id',
+                       'thr-parent', 'parent-uri', 'mention'];
+               $item = Item::selectFirst($fields, ['id' => $iid, 'origin' => false]);
+               if (!DBA::isResult($item)) {
+                       return;
+               }
+
+               // fetch all users in the thread
+               $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)) {
+                       self::setNotificationForUser($item, $user['uid']);
+               }
+               DBA::close($users);
+       }
+
+       /**
+        * 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
         */
-       public static function setNotification($item, $uid)
+       private static function setNotificationForUser(array $item, int $uid)
        {
+               $fields = ['ignored', 'mention'];
+               $thread = Item::selectFirstThreadForUser($uid, $fields, ['iid' => $item['parent'], 'deleted' => false]);
+               if ($thread['ignored']) {
+                       return;
+               }
+
+               $notification_type = self::NOTIF_NONE;
+
                if (self::checkShared($item, $uid)) {
-                       echo "shared\n";
+                       $notification_type = $notification_type | self::NOTIF_SHARED;
                }
 
                $profiles = self::getProfileForUser($uid);
 
-               if (self::checkTagged($item, $uid, $profiles)) {
-                       echo "tagged\n";
+               if (self::checkImplicitMention($item, $uid, $profiles)) {
+                       $notification_type = $notification_type | self::NOTIF_IMPLICIT_TAGGED;
+               }
+
+               if (self::checkExplicitMention($item, $uid, $profiles)) {
+                       $notification_type = $notification_type | self::NOTIF_EXPLICIT_TAGGED;
                }
 
-               if (self::checkCommented($item, $uid, $profiles)) {
-                       echo "commented\n";
+               // 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'];
                }
+               DBA::close($ret);
+
+               if (self::checkCommentedThread($item, $uid, $contacts)) {
+                       $notification_type = $notification_type | self::NOTIF_THREAD_COMMENT;
+               }
+
+               if (self::checkDirectComment($item, $uid, $contacts, $thread)) {
+                       $notification_type = $notification_type | self::NOTIF_DIRECT_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 (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 profiles (contact URL) of a given user
+        * @param int $uid User ID
+        *
+        * @return array Profiles
+        */
        private static function getProfileForUser($uid)
        {
-               $notification_data = ["uid" => $uid, "profiles" => []];
+               $notification_data = ['uid' => $uid, 'profiles' => []];
                Hook::callAll('check_item_notification', $notification_data);
 
-               $profiles = $notification_data["profiles"];
+               $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]);
                if (!DBA::isResult($owner)) {
-                       return false;
+                       return [];
                }
 
                // This is our regular URL format
-               $profiles[] = $owner["url"];
+               $profiles[] = $owner['url'];
 
                // Notifications from Diaspora are often with an URL in the Diaspora format
-               $profiles[] = DI::baseUrl()."/u/".$user["nickname"];
+               $profiles[] = DI::baseUrl().'/u/'.$user['nickname'];
 
                $profiles2 = [];
 
@@ -66,7 +146,7 @@ class UserItem
                        // 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 ((strlen($profile) >= 13) && (Strings::normaliseLink($profile) != 'http:')) {
                                if (!in_array($profile, $profiles2))
                                        $profiles2[] = $profile;
 
@@ -74,7 +154,7 @@ class UserItem
                                if (!in_array($profile, $profiles2))
                                        $profiles2[] = $profile;
 
-                               $profile = str_replace("http://", "https://", $profile);
+                               $profile = str_replace('http://', 'https://', $profile);
                                if (!in_array($profile, $profiles2))
                                        $profiles2[] = $profile;
                        }
@@ -83,22 +163,27 @@ class UserItem
                return $profiles2;
        }
 
+       /**
+        * 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($item, $uid)
        {
                if ($item['gravity'] != GRAVITY_PARENT) {
                        return false;
                }
 
-               // Send a notification for every new post?
                // Either the contact had posted 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]);
+               $tags = DBA::select('term', ['url'], ['otype' => TERM_OBJ_POST, 'oid' => $item['id'], 'type' => TERM_MENTION, 'uid' => $uid]);
                while ($tag = DBA::fetch($tags)) {
-                       $condition = ['nurl' => Strings::normaliseLink($tag["url"]), 'uid' => $uid, 'notify_new_posts' => true, 'contact-type' => Contact::TYPE_COMMUNITY];
+                       $condition = ['nurl' => Strings::normaliseLink($tag['url']), 'uid' => $uid, 'notify_new_posts' => true, 'contact-type' => Contact::TYPE_COMMUNITY];
                        if (DBA::exists('contact', $condition)) {
                                return true;
                        }
@@ -107,41 +192,90 @@ class UserItem
                return false;
        }
 
-       // Is the user mentioned in this post?
-       private static function checkTagged($item, $uid, $profiles)
+       /**
+        * Check for an implicit mention (only tag, no body) of the given user
+        * @param array $item
+        * @param int   $uid  User ID
+        * @return bool The user is mentioned
+        */
+       private static function checkImplicitMention($item, $uid, $profiles)
        {
                foreach ($profiles AS $profile) {
-                       if (strpos($item["tag"], "=".$profile."]") || strpos($item["body"], "=".$profile."]"))
-                               return true;
+                       if (strpos($item['tag'], '='.$profile.']') || strpos($item['body'], '='.$profile.']')) {
+                               if (strpos($item['body'], $profile) === false) {
+                                       return true;
+                               }
+                       }
                }
 
                return false;
        }
 
-       // Fetch all contacts for the given profiles
-       private static function checkCommented($item, $uid, $profiles)
+       /**
+        * Check for an explicit mention (tag and body) of the given user
+        * @param array $item
+        * @param int   $uid  User ID
+        * @return bool The user is mentioned
+        */
+       private static function checkExplicitMention($item, $uid, $profiles)
        {
-               // Is it a post that the user had started?
-               $fields = ['ignored', 'mention'];
-               $thread = Item::selectFirstThreadForUser($uid, $fields, ['iid' => $item["parent"], 'deleted' => false]);
-               if ($thread['mention'] && !$thread['ignored']) {
-                       return true;
+               foreach ($profiles AS $profile) {
+                       if (strpos($item['tag'], '='.$profile.']') || strpos($item['body'], '='.$profile.']')) {
+                               if (!(strpos($item['body'], $profile) === false)) {
+                                       return true;
+                               }
+                       }
                }
 
-               $contacts = [];
-               $ret = DBA::select('contact', ['id'], ['uid' => 0, 'nurl' => $profiles]);
-               while ($contact = DBA::fetch($ret)) {
-                       $contacts[] = $contact['id'];
-               }
-               DBA::close($ret);
+               return false;
+       }
 
-               // And now we check for participation of one of our contacts in the thread
-               $condition = ['parent' => $item["parent"], 'author-id' => $contacts, 'deleted' => false];
+       /**
+        * Check if the given user had created this thread
+        * @param array $item
+        * @param int   $uid  User ID
+        * @return bool The user had created this thread
+        */
+       private static function checkCommentedThread($item, $uid, $contacts)
+       {
+               $condition = ['parent' => $item['parent'], 'author-id' => $contacts, 'deleted' => false, 'gravity' => GRAVITY_PARENT];
+               return Item::exists($condition);
+       }
 
-               if (!$thread['ignored'] && Item::exists($condition)) {
-                       return true;
-               }
+       /**
+        * Check for a direct comment to a post of the given user
+        * @param array $item
+        * @param int   $uid  User ID
+        * @param array $contacts Array of contacts
+        * @return bool The item is a direct comment to a user comment
+        */
+       private static function checkDirectComment($item, $uid, $contacts)
+       {
+               $condition = ['uri' => $item['thr-parent'], 'uid' => [0, $uid], 'author-id' => $contacts, 'deleted' => false, 'gravity' => GRAVITY_COMMENT];
+               return Item::exists($condition);
+       }
 
-               return false;
+       /**
+        *  Check if the user had commented in this thread
+        * @param array $item
+        * @param array $contacts Array of contacts
+        * @return bool The user had commented in the thread
+        */
+       private static function checkCommentedParticipation($item, $contacts)
+       {
+               $condition = ['parent' => $item['parent'], 'author-id' => $contacts, 'deleted' => false, 'gravity' => GRAVITY_COMMENT];
+               return Item::exists($condition);
+       }
+
+       /**
+        * Check if the user had interacted in this thread (Like, Dislike, ...)
+        * @param array $item
+        * @param array $contacts Array of contacts
+        * @return bool The user had interacted in the thread
+        */
+       private static function checkActivityParticipation($item, $contacts)
+       {
+               $condition = ['parent' => $item['parent'], 'author-id' => $contacts, 'deleted' => false, 'gravity' => GRAVITY_ACTIVITY];
+               return Item::exists($condition);
        }
 }