]> git.mxchange.org Git - friendica.git/blob - src/Model/UserItem.php
Restructured profile generation
[friendica.git] / src / Model / UserItem.php
1 <?php
2
3 /**
4  * @file src/Model/UserItem.php
5  */
6
7 namespace Friendica\Model;
8
9 use Friendica\Core\Logger;
10 use Friendica\Core\Hook;
11 use Friendica\Database\DBA;
12 use Friendica\DI;
13 use Friendica\Util\Strings;
14
15 class UserItem
16 {
17         // Notification types
18         const NOTIF_NONE = 0;
19         const NOTIF_EXPLICIT_TAGGED = 1;
20         const NOTIF_IMPLICIT_TAGGED = 2;
21         const NOTIF_THREAD_COMMENT = 4;
22         const NOTIF_DIRECT_COMMENT = 8;
23         const NOTIF_COMMENT_PARTICIPATION = 16;
24         const NOTIF_ACTIVITY_PARTICIPATION = 32;
25         const NOTIF_SHARED = 128;
26
27         /**
28          * Checks an item for notifications and sets the "notification-type" field
29          *
30          * @param int $iid Item ID
31          */
32         public static function setNotification(int $iid)
33         {
34                 $fields = ['id', 'uid', 'body', 'parent', 'gravity', 'tag', 'contact-id', 'thr-parent', 'parent-uri', 'author-id'];
35                 $item = Item::selectFirst($fields, ['id' => $iid, 'origin' => false]);
36                 if (!DBA::isResult($item)) {
37                         return;
38                 }
39
40                 // fetch all users in the thread
41                 $users = DBA::p("SELECT DISTINCT(`contact`.`uid`) FROM `item`
42                         INNER JOIN `contact` ON `contact`.`id` = `item`.`contact-id` AND `contact`.`uid` != 0
43                         WHERE `parent` IN (SELECT `parent` FROM `item` WHERE `id`=?)", $iid);
44                 while ($user = DBA::fetch($users)) {
45                         self::setNotificationForUser($item, $user['uid']);
46                 }
47                 DBA::close($users);
48         }
49
50         /**
51          * Checks an item for notifications for the given user and sets the "notification-type" field
52          *
53          * @param array $item Item array
54          * @param int   $uid  User ID
55          */
56         private static function setNotificationForUser(array $item, int $uid)
57         {
58                 $thread = Item::selectFirstThreadForUser($uid, ['ignored'], ['iid' => $item['parent'], 'deleted' => false]);
59                 if ($thread['ignored']) {
60                         return;
61                 }
62
63                 $notification_type = self::NOTIF_NONE;
64
65                 if (self::checkShared($item, $uid)) {
66                         $notification_type = $notification_type | self::NOTIF_SHARED;
67                 }
68
69                 $profiles = self::getProfileForUser($uid);
70
71                 // Fetch all contacts for the given profiles
72                 $contacts = [];
73                 $ret = DBA::select('contact', ['id'], ['uid' => 0, 'nurl' => $profiles]);
74                 while ($contact = DBA::fetch($ret)) {
75                         $contacts[] = $contact['id'];
76                 }
77                 DBA::close($ret);
78
79                 // Don't create notifications for user's posts
80                 if (in_array($item['author-id'], $contacts)) {
81                         return;
82                 }
83
84                 if (self::checkImplicitMention($item, $profiles)) {
85                         $notification_type = $notification_type | self::NOTIF_IMPLICIT_TAGGED;
86                 }
87
88                 if (self::checkExplicitMention($item, $profiles)) {
89                         $notification_type = $notification_type | self::NOTIF_EXPLICIT_TAGGED;
90                 }
91
92                 if (self::checkCommentedThread($item, $contacts)) {
93                         $notification_type = $notification_type | self::NOTIF_THREAD_COMMENT;
94                 }
95
96                 if (self::checkDirectComment($item, $uid, $contacts)) {
97                         $notification_type = $notification_type | self::NOTIF_DIRECT_COMMENT;
98                 }
99
100                 if (self::checkCommentedParticipation($item, $contacts)) {
101                         $notification_type = $notification_type | self::NOTIF_COMMENT_PARTICIPATION;
102                 }
103
104                 if (self::checkActivityParticipation($item, $contacts)) {
105                         $notification_type = $notification_type | self::NOTIF_ACTIVITY_PARTICIPATION;
106                 }
107
108                 if (empty($notification_type)) {
109                         return;
110                 }
111
112                 Logger::info('Set notification', ['iid' => $item['id'], 'uid' => $uid, 'notification-type' => $notification_type]);
113
114                 DBA::update('user-item', ['notification-type' => $notification_type], ['iid' => $item['id'], 'uid' => $uid], true);
115         }
116
117         /**
118          * Fetch all profiles (contact URL) of a given user
119          * @param int $uid User ID
120          *
121          * @return array Profile links
122          */
123         private static function getProfileForUser(int $uid)
124         {
125                 $notification_data = ['uid' => $uid, 'profiles' => []];
126                 Hook::callAll('check_item_notification', $notification_data);
127
128                 $raw_profiles = $notification_data['profiles'];
129
130                 $user = DBA::selectFirst('user', ['nickname'], ['uid' => $uid]);
131                 if (!DBA::isResult($user)) {
132                         return [];
133                 }
134
135                 $owner = DBA::selectFirst('contact', ['url'], ['self' => true, 'uid' => $uid]);
136                 if (!DBA::isResult($owner)) {
137                         return [];
138                 }
139
140                 // This is our regular URL format
141                 $raw_profiles[] = $owner['url'];
142
143                 // Notifications from Diaspora are often with an URL in the Diaspora format
144                 $raw_profiles[] = DI::baseUrl() . '/u/' . $user['nickname'];
145
146                 $profiles = [];
147
148                 // Validate and add profile links
149                 foreach ($raw_profiles AS $profile) {
150                         // Check for invalid profile urls. 13 should be the shortest possible profile length:
151                         // http://a.bc/d
152                         // Additionally check for invalid urls that would return the normalised value "http:"
153                         if ((strlen($profile) < 13) || (Strings::normaliseLink($profile) == 'http:')) {
154                                 continue;
155                         }
156
157                         // Add the profile if it wasn't already added
158                         if (!in_array($profile, $profiles)) {
159                                 $profiles[] = $profile;
160                         }
161
162                         // Add the normalized form
163                         $profile = Strings::normaliseLink($profile);
164                         if (!in_array($profile, $profiles)) {
165                                 $profiles[] = $profile;
166                         }
167
168                         // Add the SSL form
169                         $profile = str_replace('http://', 'https://', $profile);
170                         if (!in_array($profile, $profiles)) {
171                                 $profiles[] = $profile;
172                         }
173                 }
174
175                 return $profiles;
176         }
177
178         /**
179          * Check for a "shared" notification for every new post of contacts from the given user
180          * @param array $item
181          * @param int   $uid  User ID
182          * @return bool A contact had shared something
183          */
184         private static function checkShared(array $item, int $uid)
185         {
186                 if ($item['gravity'] != GRAVITY_PARENT) {
187                         return false;
188                 }
189
190                 // Either the contact had posted something directly
191                 if (DBA::exists('contact', ['id' => $item['contact-id'], 'notify_new_posts' => true])) {
192                         return true;
193                 }
194
195                 // Or the contact is a mentioned forum
196                 $tags = DBA::select('term', ['url'], ['otype' => TERM_OBJ_POST, 'oid' => $item['id'], 'type' => TERM_MENTION, 'uid' => $uid]);
197                 while ($tag = DBA::fetch($tags)) {
198                         $condition = ['nurl' => Strings::normaliseLink($tag['url']), 'uid' => $uid, 'notify_new_posts' => true, 'contact-type' => Contact::TYPE_COMMUNITY];
199                         if (DBA::exists('contact', $condition)) {
200                                 return true;
201                         }
202                 }
203
204                 return false;
205         }
206
207         /**
208          * Check for an implicit mention (only tag, no body) of the given user
209          * @param array $item
210          * @param array $profiles Profile links
211          * @return bool The user is mentioned
212          */
213         private static function checkImplicitMention(array $item, array $profiles)
214         {
215                 foreach ($profiles AS $profile) {
216                         if (strpos($item['tag'], '=' . $profile.']') || strpos($item['body'], '=' . $profile . ']')) {
217                                 if (strpos($item['body'], $profile) === false) {
218                                         return true;
219                                 }
220                         }
221                 }
222
223                 return false;
224         }
225
226         /**
227          * Check for an explicit mention (tag and body) of the given user
228          * @param array $item
229          * @param array $profiles Profile links
230          * @return bool The user is mentioned
231          */
232         private static function checkExplicitMention(array $item, array $profiles)
233         {
234                 foreach ($profiles AS $profile) {
235                         if (strpos($item['tag'], '=' . $profile.']') || strpos($item['body'], '=' . $profile . ']')) {
236                                 if (!(strpos($item['body'], $profile) === false)) {
237                                         return true;
238                                 }
239                         }
240                 }
241
242                 return false;
243         }
244
245         /**
246          * Check if the given user had created this thread
247          * @param array $item
248          * @param array $contacts Array of contact IDs
249          * @return bool The user had created this thread
250          */
251         private static function checkCommentedThread(array $item, array $contacts)
252         {
253                 $condition = ['parent' => $item['parent'], 'author-id' => $contacts, 'deleted' => false, 'gravity' => GRAVITY_PARENT];
254                 return Item::exists($condition);
255         }
256
257         /**
258          * Check for a direct comment to a post of the given user
259          * @param array $item
260          * @param int   $uid  User ID
261          * @param array $contacts Array of contact IDs
262          * @return bool The item is a direct comment to a user comment
263          */
264         private static function checkDirectComment(array $item, int $uid, array $contacts)
265         {
266                 $condition = ['uri' => $item['thr-parent'], 'uid' => [0, $uid], 'author-id' => $contacts, 'deleted' => false, 'gravity' => GRAVITY_COMMENT];
267                 return Item::exists($condition);
268         }
269
270         /**
271          *  Check if the user had commented in this thread
272          * @param array $item
273          * @param array $contacts Array of contact IDs
274          * @return bool The user had commented in the thread
275          */
276         private static function checkCommentedParticipation(array $item, array $contacts)
277         {
278                 $condition = ['parent' => $item['parent'], 'author-id' => $contacts, 'deleted' => false, 'gravity' => GRAVITY_COMMENT];
279                 return Item::exists($condition);
280         }
281
282         /**
283          * Check if the user had interacted in this thread (Like, Dislike, ...)
284          * @param array $item
285          * @param array $contacts Array of contact IDs
286          * @return bool The user had interacted in the thread
287          */
288         private static function checkActivityParticipation(array $item, array $contacts)
289         {
290                 $condition = ['parent' => $item['parent'], 'author-id' => $contacts, 'deleted' => false, 'gravity' => GRAVITY_ACTIVITY];
291                 return Item::exists($condition);
292         }
293 }